mgui/toolrect.h

Go to the documentation of this file.

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

#ifndef  INC_MGUI_TOOLRECT_H
#define  INC_MGUI_TOOLRECT_H

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

namespace MGUI {


//! Rectangle tool class.
class TOOL_RECTANGLE : public TOOL_LIMITED {
   public:

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

      //! Destructor.
      virtual ~TOOL_RECTANGLE ();

      //! Assigment from DRECT2D.
      TOOL_RECTANGLE& operator= (
         const DRECT2D& rhs                  //!< Rectangle in tool coordinates to assign from
         );

      //! Get rotation angle.
      //! @return Rotation angle in RADIANS.
      double GetAngle (
         ) const { return (m_angle); }

      //! Get center of rectangle in tool coordinates.
      DPOINT2D GetCenter (
         ) const { return (m_extents.GetCenter()); }

      //! Get coordinates of specified corner.
      const DPOINT2D& GetCorner (
         int corner                          //!< Corner number (0-3)
         ) const { return (m_corners[corner]); }

      //! Get coordinates of all rectangle corners.
      //! @return Array of 4 corner coordinates.
      const DPOINT2D* GetCorners (
         ) const { return (m_corners); }

      //! Copy corner coordinates into specified array.
      void GetCorners (
         DPOINT2D rcorners[4]                //!< Array to contain corner coordinates
         ) const { for (int i = 0; (i < 4); ++i) rcorners[i] = m_corners[i]; return; }

      //! Get extents of tool.
      const DRECT2D& GetExtents (
         ) const { return (m_extents); }

      //! Get current rectangle size.
      //! @return Size in tool coordinates before rotation.
      const DPOINT2D& GetSize (
         ) const { return (m_size); }

      //! Set aspect ratio for rectangle.
      //! Setting the aspect ratio to a value <= 0 removes the aspect constraint.
      void SetAspect (
         double aspect                          //!< Aspect ratio X/Y
         );

   protected:

   #ifdef DOCONLY // For documentation purposes only.
      //! Called when change made to tool position, shape, size, etc.
      virtual void v_OnNotifyChange (
         CHANGESEQ changeseq,                //!< Sequence
         CHANGETYPE changetype               //!< Type
         );
   #endif

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      //! Enumeration constants
      enum ZONE {
         ZONE_Outside = 0,
         ZONE_Inside,
         ZONE_Corner0,
         ZONE_Corner1,
         ZONE_Corner2,
         ZONE_Corner3,
         ZONE_Side01,
         ZONE_Side12,
         ZONE_Side23,
         ZONE_Side30,
         ZONE_NoFunction
         };
      //! Tool settings
      double m_aspect;                    //!< Aspect ratio, proportional if > 0
      //! Tool position values
      DRECT2D m_extents;                  //!< Position (extents if rotated)
      DPOINT2D m_corners[4];              //!< Corner coordinates
      DPOINT2D m_size;                    //!< Current size
      double m_angle;                     //!< Rotation angle
      //! Values used during interaction
      ZONE m_CursorZone;                  //!< Current cursor zone
      DPOINT2D m_prevpt;                  //!< Previous point during button-down
      UINT8 m_AdjustMode;                 //!< Adjustment mode, 2=rotate, 1=everything else

      //! Methods
      void AdjustTool (const DPOINT2D&, bool firsttime=false);
      void ComputeCursorZone (const DPOINT2D&);
      void Recompute ();
      void ResizeTool (const DPOINT2D&);
      void RotateTool (const DPOINT2D&);
      void StartTool (const DPOINT2D&);
      void UpdateCursor () 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);
      //! TOOL_LIMITED overrides.
      virtual void v_OnChangeLimits ();
      #endif // GENERATING_DOXYGEN_OUTPUT

   };


}  // End namespace MGUI


#endif   // INC_MGUI_TOOLRECT_H

---