mgui/toolpoly.h

Go to the documentation of this file.

/**
 * \file mgui/toolpoly.h
 * \brief MGUI::TOOL_POLYLINE class definition
 *
 * \if NODOC
 * $Id: toolpoly.h_v 1.3 2003/10/03 19:58:19 linux32build!build Exp $
 *
 * $Log: toolpoly.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:34  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MGUI_TOOLPOLY_H
#define  INC_MGUI_TOOLPOLY_H

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

#ifndef  INC_MI32_POLYLINE_H
#include <mi32/polyline.h>
#endif

namespace MGUI {


//! TOOL_POLYLINE - Polyline / polygon tool
//!
class TOOL_POLYLINE : public TOOL_BASE {
   public:

      //! Editing modes.
      enum EDITMODE {
         EDITMODE_AddEnd,                    //!< Add vertices to end of active line (default)
         EDITMODE_AddStart,                  //!< Add vertices to start of active line
         EDITMODE_InsertVertex,              //!< Insert vertex
         EDITMODE_DragVertex,                //!< Drag nearest vertex
         EDITMODE_DeleteVertex,              //!< Delete nearest vertex
         EDITMODE_Move                       //!< Move active line
         };

      //! Constructor.
      explicit TOOL_POLYLINE (
         TOOLCANVAS *canvas,                    //!< View to contain tool
         bool AllowMulti = false             //!< Allow multiple lines
         );

      //! Destructor.
      virtual ~TOOL_POLYLINE ();

      //! Get reference to active line.
      //! IsActiveValid() should be used first to determine if the active line is
      //! valid.  Failure to do so will likely result in an exception.
      const POLYLINE& GetActiveLine (
         ) const { return (*m_ActiveLine); }

      //! Get list of lines.
      const MILIST<POLYLINE>& GetLineList (
         ) const { return (m_LineList); }

      //! Get number of valid lines.
      int GetNumLines (
         ) const { return (m_LineList.GetNumItems()); }

      //! Determine if tool points are 3D.
      bool Is3D (
         ) const { return (m_Is3D); };

      //! Determine if active line is valid.
      //! In single-line mode the active line is always valid.
      bool IsActiveValid (
         ) const { return (m_ActiveLine != 0); }

      //! Lock or unlock end point of active line.
      void LockEndPoint (
         bool locked = true                  //!< 'true' to lock, 'false' to unlock
         );

      //! Lock or unlock start point of active line.
      void LockStartPoint (
         bool locked = true                  //!< 'true' to lock, 'false' to unlock
         );

      //! Set whether points are 3D.
      void Set3D (
         bool set3d = true
         );

      //! Set line to draw as "closed".
      //! This only affects how the tool is drawn, it does not add a closing point to the POLYLINE.
      void SetClosed (
         bool closed = true
         );

      //! Set line editing mode.
      void SetEditMode (
         EDITMODE EditMode                   //!< New editing mode
         );

      //! Set markers for start and end points.
      void SetMarkers (
         MARKER startmarker,                 //!< Starting point marker type
         MARKER endmarker,                   //!< Ending point marker type
         UINT16 startmarkersize = 0,         //!< Starting point marker size, 0 to retain current size
         UINT16 endmarkersize = 0            //!< Ending point marker size, 0 to retain current size
         );

   protected:

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

   private:

      #ifndef GENERATING_DOXYGEN_OUTPUT

      //! Enumeration constants
      enum ZONE {
         ZONE_NoFunction = 0,
         ZONE_Outside
         };

      //! Tool settings
      bool m_AllowMulti;
      bool m_IsClosed;
      bool m_Is3D;
      bool m_LockStart;
      bool m_LockEnd;
      MARKER m_startmarker;
      MARKER m_endmarker;
      UINT16 m_startmarkersize;
      UINT16 m_endmarkersize;
      EDITMODE m_EditMode;
      //! Tool position values
      MILIST<POLYLINE> m_LineList;
      POLYLINE *m_ActiveLine;             //!< Pointer to active line
      //! Values used during interaction
      ZONE m_CursorZone;                  //!< Current cursor zone
      DPOINT2D m_prevpt;                  //!< Previous point during button-down
      int m_ActivePoint;
      bool m_RubberBand;
      
      //! Methods
      void AddPoint (MGD::CONTEXT*, const DPOINT2D&, EDITMODE);
      void AdjustTool (DPOINT2D&, CHANGESEQ);
      void ComputeCursorZone (const DPOINT2D&);
      void DeletePoint (MGD::CONTEXT*, int);
      void DrawMarkerEnd (MGD::CONTEXT*);
      void DrawMarkerStart (MGD::CONTEXT*);
      void DrawNeighborSegments (MGD::CONTEXT*, const LRECT2D&, bool SkipActive=true, int SkipSegment1=-2, int SkipSegment2=-2);
      void DrawSegment (MGD::CONTEXT*, const POLYLINE&, int);
      void DrawSegment (MGD::CONTEXT*, int, bool);
      void DrawSingleLine (MGD::CONTEXT*, const POLYLINE&);
      void EraseLine (MGD::CONTEXT*);
      void EraseMarkerEnd (MGD::CONTEXT*, bool);
      void EraseMarkerStart (MGD::CONTEXT*, bool);
      void ErasePoint (MGD::CONTEXT*, int);
      void EraseSegment (MGD::CONTEXT*, int);
      void InsertPoint (MGD::CONTEXT*, int, const DPOINT2D&, UINT32);
      void MovePoint (MGD::CONTEXT*, const DPOINT2D&, UINT32);
      void UpdateCursor () const;

      //! TOOL_BASE overrides.
      virtual MGUI::FORM* v_CreateControlForm (LAYOUT_PANE_BASE& ParentPane, CTRLOPT ctrlopt);
      virtual void v_DoDraw (MGD::CONTEXT*);
      virtual int v_GenerateRegion (REGION2D& region) const;
      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_TOOLPOLY_H

---