makVrv::DtWidget Class Reference

The abstract base class for widgets. More...

Inheritance diagram for makVrv::DtWidget:

List of all members.

Public Member Functions
	DtWidget (DtDe &de, DtUniqueID id)
virtual	~DtWidget ()
virtual void	setOverlay (unsigned int overlay)=0
	Sets the overlay of the widget.
virtual unsigned int	overlay () const =0
	Gets the overlay of the widget.
virtual void	setOrderGroup (unsigned int group)=0
	Sets the overlay of the widget.
virtual unsigned int	orderGroup () const =0
	Gets the overlay of the widget.
virtual void	setParentId (DtUniqueID id)
	Set the parent id.
virtual void	setPosition (float x, float y, float z, float w=0)=0
	Set the position of the widget in screen space.
virtual void	setBackgroundImage (const std::string &filename)=0
	Set the background image.
virtual void	setColor (float r, float g, float b, float a)=0
	Set the color of the widget.
virtual void	setOrigin (float originX, float originY)=0
	Sets the origin location, by default it is 0,0.
virtual void	setSize (float w, float h)=0
	Sets the size of the widget in overlay coordinate space.
virtual void	setPadding (float paddingX, float paddingY)=0
	Sets the size of the widget in overlay coordinate space.
virtual void	setModelDefinition (const std::string &str)=0
	Sets the model definition of the widget (optional, since widgets are not models)
virtual void	setEventsEnabled (bool enabled)=0
	Enable or disable events for this widget.
virtual void	setVisible (bool visible)=0
	Set whether the widget is visible or not.
Protected Attributes
DtDe &	myDe
DtUniqueID	myId
DtUniqueID	myParentId

---

Detailed Description

The abstract base class for widgets.

---

Constructor & Destructor Documentation

makVrv::DtWidget::DtWidget	(	DtDe &	de,
		DtUniqueID	id
	)

virtual makVrv::DtWidget::~DtWidget

(

)

[virtual]

---

Member Function Documentation

virtual void makVrv::DtWidget::setOverlay

(

unsigned int

overlay

)

[pure virtual]

Sets the overlay of the widget.

Implemented in makVrv::DtOsgAttributeGroupWidget, makVrv::DtOsgWidgetLabel, and makVrv::DtOsgWidget.

virtual unsigned int makVrv::DtWidget::overlay

(

)

const [pure virtual]

Gets the overlay of the widget.

Implemented in makVrv::DtOsgAttributeGroupWidget, makVrv::DtOsgWidgetLabel, and makVrv::DtOsgWidget.

virtual void makVrv::DtWidget::setOrderGroup

(

unsigned int

group

)

[pure virtual]

Sets the overlay of the widget.

Implemented in makVrv::DtOsgAttributeGroupWidget, makVrv::DtOsgWidgetLabel, and makVrv::DtOsgWidget.

virtual unsigned int makVrv::DtWidget::orderGroup

(

)

const [pure virtual]

Gets the overlay of the widget.

Implemented in makVrv::DtOsgAttributeGroupWidget, makVrv::DtOsgWidgetLabel, and makVrv::DtOsgWidget.

virtual void makVrv::DtWidget::setParentId

(

DtUniqueID

id

)

[virtual]

Set the parent id.

Reimplemented in makVrv::DtOsgWidget.

virtual void makVrv::DtWidget::setPosition	(	float	x,
		float	y,
		float	z,
		float	w = 0
	)		[pure virtual]

Set the position of the widget in screen space.

Implemented in makVrv::DtOsgAttributeGroupWidget, makVrv::DtOsgWidgetLabel, and makVrv::DtOsgWidget.

virtual void makVrv::DtWidget::setBackgroundImage

(

const std::string &

filename

)

[pure virtual]

Set the background image.

Implemented in makVrv::DtOsgAttributeGroupWidget, makVrv::DtOsgWidgetLabel, and makVrv::DtOsgWidget.

virtual void makVrv::DtWidget::setColor	(	float	r,
		float	g,
		float	b,
		float	a
	)		[pure virtual]

Set the color of the widget.

Implemented in makVrv::DtOsgAttributeGroupWidget, makVrv::DtOsgWidgetLabel, and makVrv::DtOsgWidget.

virtual void makVrv::DtWidget::setOrigin	(	float	originX,
		float	originY
	)		[pure virtual]

Sets the origin location, by default it is 0,0.

The origin can be used to specify a offset from the position.

Implemented in makVrv::DtOsgAttributeGroupWidget, makVrv::DtOsgWidgetLabel, and makVrv::DtOsgWidget.

virtual void makVrv::DtWidget::setSize	(	float	w,
		float	h
	)		[pure virtual]

Sets the size of the widget in overlay coordinate space.

Implemented in makVrv::DtOsgAttributeGroupWidget, makVrv::DtOsgWidgetLabel, and makVrv::DtOsgWidget.

virtual void makVrv::DtWidget::setPadding	(	float	paddingX,
		float	paddingY
	)		[pure virtual]

Sets the size of the widget in overlay coordinate space.

Implemented in makVrv::DtOsgAttributeGroupWidget, makVrv::DtOsgWidgetLabel, and makVrv::DtOsgWidget.

virtual void makVrv::DtWidget::setModelDefinition

(

const std::string &

str

)

[pure virtual]

Sets the model definition of the widget (optional, since widgets are not models)

Implemented in makVrv::DtOsgAttributeGroupWidget, makVrv::DtOsgWidgetLabel, and makVrv::DtOsgWidget.

virtual void makVrv::DtWidget::setEventsEnabled

(

bool

enabled

)

[pure virtual]

Enable or disable events for this widget.

Implemented in makVrv::DtOsgAttributeGroupWidget, makVrv::DtOsgWidgetLabel, and makVrv::DtOsgWidget.

virtual void makVrv::DtWidget::setVisible

(

bool

visible

)

[pure virtual]

Set whether the widget is visible or not.

Implemented in makVrv::DtOsgAttributeGroupWidget, makVrv::DtOsgWidgetLabel, and makVrv::DtOsgWidget.

---

Member Data Documentation

DtDe& makVrv::DtWidget::myDe [protected]

DtUniqueID makVrv::DtWidget::myId [protected]

DtUniqueID makVrv::DtWidget::myParentId [protected]

---

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

• include/vrvCore/DtWidget.h