MGUI::TOOL_REGPOLYGON Class Reference

"Regular Polygon" tool More...

#include <mgui/toolregpolygon.h>

Inheritance diagram for MGUI::TOOL_REGPOLYGON:

[legend]

List of all members.

Public Member Functions
	TOOL_REGPOLYGON (TOOLCANVAS *canvas)
virtual	~TOOL_REGPOLYGON ()
double	GetAngle () const
const DPOINT2D &	GetCenter () const
int	GetNumSegments () const
double	GetRadius () const
void	SetAngle (double newangle)
void	SetAngleVisible (bool anglevisible=true)
void	SetCenter (const DPOINT2D &center)
void	SetMarker (MARKER marker, UINT16 size=0)
void	SetNumSegments (int NumSegments)
void	SetRadius (double radius)
void	SetRadiusRange (double minradius, double maxradius)

---

Detailed Description

"Regular Polygon" tool

---

Constructor & Destructor Documentation

MGUI::TOOL_REGPOLYGON::TOOL_REGPOLYGON

(

TOOLCANVAS *

canvas

)

[explicit]

Constructor.

virtual MGUI::TOOL_REGPOLYGON::~TOOL_REGPOLYGON

(

)

[virtual]

Destructor.

---

Member Function Documentation

double MGUI::TOOL_REGPOLYGON::GetAngle

(

)

const [inline]

Get current rotation angle.

const DPOINT2D& MGUI::TOOL_REGPOLYGON::GetCenter

(

)

const [inline]

Get center position.

int MGUI::TOOL_REGPOLYGON::GetNumSegments

(

)

const [inline]

Get number of segments.

double MGUI::TOOL_REGPOLYGON::GetRadius

(

)

const [inline]

Get radius.

void MGUI::TOOL_REGPOLYGON::SetAngle

(

double

newangle

)

Set rotation angle.

void MGUI::TOOL_REGPOLYGON::SetAngleVisible

(

bool

anglevisible = true

)

Set whether angle indicator is visible.

void MGUI::TOOL_REGPOLYGON::SetCenter

(

const DPOINT2D &

center

)

Set center of polygon.

Parameters:

center

New center in tool coordinates

void MGUI::TOOL_REGPOLYGON::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_REGPOLYGON::SetNumSegments

(

int

NumSegments

)

Set number of polygon segments.

Parameters:

NumSegments

Number of segments >= 3

void MGUI::TOOL_REGPOLYGON::SetRadius

(

double

radius

)

Set polygon radius (distance from center to vertex).

Parameters:

radius

Radius is tool units

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

Set allowed radius range.

Parameters:

	minradius	Minimum radius
	maxradius	Maximum radius, <= 0 for no maximum

---

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

• mgui/toolregpolygon.h