MGUI::CTRL_ANGLE Class Reference

Control for displaying and setting "angle" value. More...

#include <mgui/ctrlangle.h>

Inheritance diagram for MGUI::CTRL_ANGLE:

[legend]

List of all members.

Public Types
enum	STYLE { STYLE_Default = 0x00, STYLE_NoUserChange = 0x01, STYLE_AngleIncreasesCCW = 0x00, STYLE_AngleIncreasesCW = 0x02 }
Public Member Functions
	CTRL_ANGLE ()
virtual	~CTRL_ANGLE ()
void	Create (LAYOUT_PANE_BASE &ParentPane, int DialRadius, double MinAngle, double MaxAngle, STYLE style, double origin=0)
void	Create (LAYOUT_PANE_BASE &ParentPane, int DialRadius, STYLE style, double origin=0)
void	CreateDual (LAYOUT_PANE_BASE &ParentPane, int DialRadius, double MinAngle, double CenterValue2, double EdgeValue2, STYLE style, double origin=0)
double	GetAngle () const
double	GetValue2 () const
void	SetAngle (double angle, bool notify=true)
void	SetDelegateOnChangeValue (DELEGATE_VOID_NOPARMS delegate)
void	SetDelegateOnUserChanging (DELEGATE_VOID_NOPARMS delegate)
void	SetValue2 (double value, bool notify=true)
void	SetValues (double angle, double value2, bool notify=true)

---

Detailed Description

Control for displaying and setting "angle" value.

---

Member Enumeration Documentation

enum MGUI::CTRL_ANGLE::STYLE

Enumerator:

STYLE_Default
STYLE_NoUserChange	User is not allowed to change value.
STYLE_AngleIncreasesCCW	Angle increases in counterclockwise direction, ie right-hand cartesian (default).
STYLE_AngleIncreasesCW	Angle increases in clockwise direction, ie left-hand cartesian.

Reimplemented from MGUI::CANVAS.

---

Constructor & Destructor Documentation

MGUI::CTRL_ANGLE::CTRL_ANGLE

(

)

Constructor.

virtual MGUI::CTRL_ANGLE::~CTRL_ANGLE

(

)

[virtual]

Destructor.

---

Member Function Documentation

void MGUI::CTRL_ANGLE::Create	(	LAYOUT_PANE_BASE &	ParentPane,
		int	DialRadius,
		double	MinAngle,
		double	MaxAngle,
		STYLE	style,
		double	origin = 0
	)

Create control with specific angle range.

Parameters:

	ParentPane	Parent pane
	DialRadius	Radius of "dial"
	MinAngle	Minimum angle in degrees (-360 to +360)
	MaxAngle	Maximum angle in degrees, must be > MinAngle and <= MinAngle+360
	style	Control style
	origin	Direction in degrees (-180 to +180) in right-hand cartesian for 0-angle on display

void MGUI::CTRL_ANGLE::Create	(	LAYOUT_PANE_BASE &	ParentPane,
		int	DialRadius,
		STYLE	style,
		double	origin = 0
	)			[inline]

Create control with full angle range -180 to +180.

Parameters:

	ParentPane	Parent pane
	DialRadius	Radius of "dial"
	style	Control style
	origin	Direction in degrees (-180 to +180) in right-hand cartesian for 0-angle on display

void MGUI::CTRL_ANGLE::CreateDual	(	LAYOUT_PANE_BASE &	ParentPane,
		int	DialRadius,
		double	MinAngle,
		double	CenterValue2,
		double	EdgeValue2,
		STYLE	style,
		double	origin = 0
	)

Create control with dual values and full angle range.

Parameters:

	ParentPane	Parent pane
	DialRadius	Radius of "dial"
	MinAngle	Minimum angle (-360 to 0)
	CenterValue2	Secondary value at center
	EdgeValue2	Secondary value at edge (end of "needle")
	style	Control style
	origin	Direction in degrees (-180 - +180) in right-hand cartesian for 0-angle on display

double MGUI::CTRL_ANGLE::GetAngle

(

)

const

Get current angle value in degrees.

double MGUI::CTRL_ANGLE::GetValue2

(

)

const

Get secondary value.

void MGUI::CTRL_ANGLE::SetAngle	(	double	angle,
		bool	notify = true
	)

Set angle value.

Parameters:

	angle	Angle value
	notify	Notify delegate of change

void MGUI::CTRL_ANGLE::SetDelegateOnChangeValue

(

DELEGATE_VOID_NOPARMS

delegate

)

Set delegate to call after value has changed.

void MGUI::CTRL_ANGLE::SetDelegateOnUserChanging

(

DELEGATE_VOID_NOPARMS

delegate

)

Set delegate to call when user is actively changing value (by dragging control).

void MGUI::CTRL_ANGLE::SetValue2	(	double	value,
		bool	notify = true
	)

Set secondary value.

Parameters:

	value	Value to set
	notify	Notify delegate of change

void MGUI::CTRL_ANGLE::SetValues	(	double	angle,
		double	value2,
		bool	notify = true
	)

Set both angle and secondary values.

Parameters:

	angle	Angle to set
	value2	Secondary value to set
	notify	Notify delegate of change

---

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

• mgui/ctrlangle.h