mgui/toolmlpt.h

Go to the documentation of this file.

/**
 * \file mgui/toolmlpt.h
 * \brief MGUI::TOOL_MULTIPOINT class definition
 *
 * \if NODOC
 * $Id: toolmlpt.h_v 1.3 2003/10/03 19:58:19 linux32build!build Exp $
 *
 * $Log: toolmlpt.h_v $
 * Revision 1.3  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.2  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.1  2003/01/10 23:08:25  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MGUI_TOOLMLPT_H
#define  INC_MGUI_TOOLMLPT_H

#ifndef  INC_MGUI_TOOLBASE_H
#include <mgui/toolbase.h>
#endif

#ifndef  INC_MI32_DOUBLEAR_H
#include <mi32/doublear.h>
#endif

namespace MGUI {

//! TOOL_MULTIPOINT - Multi-Point tool
//!
class TOOL_MULTIPOINT : public TOOL_BASE {
   public:

      //! Constructor.
      explicit TOOL_MULTIPOINT (
         TOOLCANVAS *canvas
         );

      //! Destructor.
      virtual ~TOOL_MULTIPOINT ();

      //! Get active point coordinates.
      const DPOINT3D& GetActivePoint (
         ) const { return (m_Points[m_ActiveIndex]); }

      //! Get number of points.
      int GetNumPoints (
         ) const { return (m_Points.GetNumItems()); }

      //! Get single point.
      //! If the index is out of range the results are unpredictable.
      const DPOINT3D& GetPoint (
         int index                           //!< Zero-based index of point to retrieve
         ) const { return (m_Points[index]); }

      //! Get points.
      const DOUBLE_ARRAY<DPOINT3D> GetPoints (
         ) const { return (m_Points); }

      //! Determine if "active" point is valid.
      bool IsActiveValid (
         ) const { return (m_ActiveIndex >= 0 && m_ActiveIndex < m_Points.GetNumItems()); }

      //! Set marker type and size.
      //! The default marker is MARKER_Plus with a size of 9 pixels.
      void SetMarker (
         MARKER marker,                      //!< New marker type
         UINT16 size = 0                     //!< New marker size, 0 to retain current size
         );

   protected:

      //! Called when "active element" changed.
      virtual void v_OnChangeActiveElem (
         );

   private:

      #ifndef GENERATING_DOXYGEN_OUTPUT

      enum EDITMODE {
         EDITMODE_Automatic,                 //!< Auto select when near point, move if selected, add if not near point
         EDITMODE_Add,                       //!< Always add new point
         EDITMODE_Move,                      //!< Move selected point to cursor
         EDITMODE_Select                     //!< Select point by clicking
         };

      enum ZONE {
         ZONE_NoFunction = 0,
         ZONE_Outside,
         };

      //! Tool settings
      MARKER m_marker;
      UINT16 m_markersize;
      EDITMODE m_EditMode;
      //! Tool position values
      DOUBLE_ARRAY<DPOINT3D> m_Points;    //!< Points
      int m_ActiveIndex;                  //!< Index of active point
      //! Values used during interaction
      ZONE m_CursorZone;                  //!< Current cursor zone
      DPOINT2D m_prevpt;
      bool m_NotifyChangeElem;

      void ActivateClosestPoint (const DPOINT2D&);
      void AddPoint (MGD::CONTEXT*, const DPOINT2D&);
      void AdjustTool (DPOINT2D&, CHANGESEQ);
      void ComputeCursorZone (const DPOINT2D&);
      void DeletePoint ();
      void DrawNeighborPoints (MGD::CONTEXT*, const LRECT2D&) const;
      void DrawPoint (MGD::CONTEXT*, int) const;
      void ErasePoint (MGD::CONTEXT*, bool circleonly = false) const;
      int FindClosestPoint (const DPOINT2D&) const;
      void SetActiveIndex (int);
      void UpdateCursor () const;

      //! TOOL_BASE overrides.
      virtual MGUI::FORM* v_CreateControlForm (LAYOUT_PANE_BASE& ParentPane, CTRLOPT ctrlopt);
      virtual void v_DoDraw (MGD::CONTEXT*);
      virtual void v_DoMove (double dx, double dy, ADJUSTFLAGS flags);
      virtual void v_OnClear ();
      virtual bool v_OnKey (MGUI::POINT point, KEYCODE keycode, KEYSTATE keystate);
      virtual void v_OnLButtonDown (MGUI::POINT point, KEYSTATE keystate);
      virtual void v_OnLButtonUp (MGUI::POINT point, KEYSTATE keystate);
      virtual void v_OnMouseMove (MGUI::POINT point, KEYSTATE keystate);

      #endif // GENERATING_DOXYGEN_OUTPUT
   };


}  // End namespace MGUI


#endif   // INC_MGUI_TOOLMLPT_H

---