MGUI::TOOL_CIRCLE Class Reference

Circle tool. More...

#include <mgui/toolcircle.h>

Inheritance diagram for MGUI::TOOL_CIRCLE:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 TOOL_CIRCLE (TOOLCANVAS *canvas)
virtual ~TOOL_CIRCLE ()
double GetAngle () const
const DPOINT2DGetCenter () const
double GetRadius () const
void SetAngle (double angle)
void SetAngleVisible (bool anglevisible=true)
void SetCenter (const DPOINT2D &center)
void SetMarker (MARKER marker, UINT16 size=0)
void SetRadius (double radius)
void SetRadiusRange (double minradius, double maxradius)

Detailed Description

Circle tool.


Constructor & Destructor Documentation

MGUI::TOOL_CIRCLE::TOOL_CIRCLE ( TOOLCANVAS canvas  )  [explicit]

Constructor.

virtual MGUI::TOOL_CIRCLE::~TOOL_CIRCLE (  )  [virtual]

Destructor.


Member Function Documentation

double MGUI::TOOL_CIRCLE::GetAngle (  )  const [inline]

Get current rotation angle.

const DPOINT2D& MGUI::TOOL_CIRCLE::GetCenter (  )  const [inline]

Get center position.

double MGUI::TOOL_CIRCLE::GetRadius (  )  const [inline]

Get radius.

void MGUI::TOOL_CIRCLE::SetAngle ( double  angle  ) 

Set rotation angle.

The rotation will only be visible to the user if SetAngleVisible() has been used.

Parameters:
angle New rotation angle in RADIANS
void MGUI::TOOL_CIRCLE::SetAngleVisible ( bool  anglevisible = true  ) 

Set whether rotation angle indicator is visible.

The rotation angle is indicated by a line from the center to the boundary.

void MGUI::TOOL_CIRCLE::SetCenter ( const DPOINT2D center  ) 

Set circle center coordinates.

void MGUI::TOOL_CIRCLE::SetMarker ( MARKER  marker,
UINT16  size = 0 
)

Set marker type and size.

The default marker is MARKER_Plus with a size of 9 pixels.

Parameters:
marker New marker type
size New marker size, 0 to retain current size
void MGUI::TOOL_CIRCLE::SetRadius ( double  radius  ) 

Set radius.

void MGUI::TOOL_CIRCLE::SetRadiusRange ( double  minradius,
double  maxradius 
)

Set allowed radius range.

Parameters:
minradius Minimum radius in tool units
maxradius Maximum radius, <= 0 for no maximum

The documentation for this class was generated from the following file:

Generated on Sun Oct 7 21:36:17 2012 for TNTsdk 2012 by  doxygen 1.6.1