MGUI::TOOL_POINT Class Reference

Single "point" tool. More...

#include <mgui/toolpoint.h>

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

List of all members.

Public Types

typedef
fastdelegate::FastDelegate
< bool(CHANGESEQ, DPOINT3D &)> 
DELEGATE_ONSETPOINT

Public Member Functions

 TOOL_POINT (TOOLCANVAS *canvas)
virtual ~TOOL_POINT ()
const DPOINT3DGetPoint () const
TOOL_POINToperator= (const DPOINT3D &rhs)
TOOL_POINToperator= (const DPOINT2D &rhs)
void SetDelegateOnSetPoint (DELEGATE_ONSETPOINT delegate)
void SetMarker (MARKER marker, UINT16 size=0)
void SetPointStyle (const POINTSTYLE &style, const RVC::STYLEPATTERN_SYMBOL *pSymbol=0)

Detailed Description

Single "point" tool.


Member Typedef Documentation

typedef fastdelegate::FastDelegate<bool(CHANGESEQ, DPOINT3D&)> MGUI::TOOL_POINT::DELEGATE_ONSETPOINT

Constructor & Destructor Documentation

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

Constructor.

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

Destructor.


Member Function Documentation

const DPOINT3D& MGUI::TOOL_POINT::GetPoint (  )  const [inline]

Get current tool point coordinates.

TOOL_POINT& MGUI::TOOL_POINT::operator= ( const DPOINT3D rhs  ) 

Assigment from DPOINT3D.

TOOL_POINT& MGUI::TOOL_POINT::operator= ( const DPOINT2D rhs  ) 

Assignment from DPOINT2D.

void MGUI::TOOL_POINT::SetDelegateOnSetPoint ( DELEGATE_ONSETPOINT  delegate  )  [inline]

Set delegate to call when a point's position is set or moved This allows the user of the tool to determine if the point is to be moved and where.

Return 'true' for the delegate to modify the point.

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

Set marker type and size.

The default marker is MARKER_Plus with a size of 9 pixels. Will reset any previously set style.

Parameters:
marker New marker type
size New marker size, 0 to retain current size
void MGUI::TOOL_POINT::SetPointStyle ( const POINTSTYLE style,
const RVC::STYLEPATTERN_SYMBOL pSymbol = 0 
)

Set style for using symbol.

Will use marker unless either STYLEFLAG_UseSymbol or STYLEFLAG_PointSymbolBuiltIn is specified.

Parameters:
style Style
pSymbol Optional symbol when STYLEFLAG_UseSymbol specified

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

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