mgui/toolcirc.h

Go to the documentation of this file.

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

#ifndef  INC_MGUI_TOOLCIRC_H
#define  INC_MGUI_TOOLCIRC_H

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

namespace MGUI {

//!
//! TOOL_CIRCLE - Circle tool
//!
class TOOL_CIRCLE : public TOOL_BASE {
   public:

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

      //! Destructor.
      virtual ~TOOL_CIRCLE ();

      //! Get current rotation angle.
      double GetAngle (
         ) const { return (m_angle); }

      //! Get center position.
      const DPOINT2D& GetCenter (
         ) const { return (m_center); }

      //! Get radius.
      double GetRadius (
         ) const { return (m_radius); }

      //! Set rotation angle.
      //! The rotation will only be visible to the user if SetAngleVisible() has been used.
      void SetAngle (
         double angle                        //!< New rotation angle in RADIANS
         );

      //! Set whether rotation angle indicator is visible.
      //! The rotation angle is indicated by a line from the center to the boundary.
      void SetAngleVisible (
         bool anglevisible = true
         );

      //! Set circle center coordinates.
      void SetCenter (
         const DPOINT2D& center
         );

      //! 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
         );

      //! Set radius.
      void SetRadius (
         double radius
         );

      //! Set allowed radius range.
      void SetRadiusRange (
         double minradius,                   //!< Minimum radius in tool units
         double maxradius                    //!< Maximum radius, <= 0 for no maximum
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      //! Enumeration constants
      enum ZONE {
         ZONE_NoFunction = 0,
         ZONE_Outside,
         ZONE_Inside,
         ZONE_Perimeter,
         ZONE_SetCenter,
         ZONE_Rotate,
         };
      //! Tool settings
      MARKER m_marker;
      UINT16 m_markersize;
      double m_minradius;                 //!< Minimum radius
      double m_maxradius;                 //!< Maximum radius, 0 if no maximum
      bool m_anglevisible;             //!< Visibility of rotation angle indicator
      //! Tool position values
      DPOINT2D m_center;                  //!< Center
      double m_radius;
      double m_angle;
      //! Values used during interaction
      ZONE m_CursorZone;                  //!< Current cursor zone
      DPOINT2D m_prevpt;                  //!< Previous point during button-down

      //! Methods
      void AdjustTool (const DPOINT2D&, bool firsttime=false);
      void ComputeCursorZone (const DPOINT2D&);
      void StartTool (const DPOINT2D&);
      void UpdateCursor (const DPOINT2D&) const;

      //! TOOL_BASE overrides.
      virtual void v_DoDraw (MGD::CONTEXT*);
      virtual void v_DoMove (double dx, double dy, ADJUSTFLAGS flags);
      virtual int v_GenerateRegion (REGION2D& region) const;
      virtual void v_OnLButtonDown (MGUI::POINT point, KEYSTATE keystate);
      virtual void v_OnMouseMove (MGUI::POINT point, KEYSTATE keystate);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


}  // End namespace MGUI


#endif   // INC_MGUI_TOOLCIRC_H

---