makVrv::DtOsgWidget Class Reference

The osg widget class is a distributed osg based widget. More...

Inheritance diagram for makVrv::DtOsgWidget:

Public Member Functions
	DtOsgWidget (DtDe &de, DtUniqueID id)
	CTOR. More...
virtual	~DtOsgWidget ()
	DTOR. More...
virtual void	setParentId (DtUniqueID id)
	Set the parent id. More...
virtual void	setOverlay (unsigned int layer)
	Set the layer within the widget's window. More...
virtual void	setRotation (float)
	Sets the rotation of the widget. Rotation is in radians. More...
virtual float	getRotation () const
	Returns the rotation. More...
unsigned int	overlay () const
	Get the overlay. More...
virtual void	setOrderGroup (unsigned int group)
	Sets the overlay of the widget. More...
virtual unsigned int	orderGroup () const
	Gets the overlay of the widget. More...
virtual void	setPosition (float x, float y, float z, float w=0)
	Set the position of the widget in screen space. More...
virtual void	setBackgroundImage (const std::string &filename)
	Set the background image. More...
virtual void	setBackgroundImage (const std::string &filename, float left, float right, float bottom, float top)
	Set the background image with uv. More...
virtual void	setColor (float r, float g, float b, float a)
	Set the color of the widget. More...
virtual void	setOrigin (float originX, float originY)
	Sets the origin location, by default it is 0,0. More...
virtual void	setSize (float w, float h)
	Sets the size of the widget in overlay coordinate space. More...
virtual void	setPadding (float paddingX, float paddingY)
	Sets the size of the widget in overlay coordinate space. More...
virtual void	setModelDefinition (const std::string &str)
	Set the widget's model definition ("theme") More...
virtual void	setEventsEnabled (bool enabled)
	Enable or disable event handling for this widget. More...
virtual void	setVisible (bool visible)
	Set the widget visible or hidden. More...
Public Member Functions inherited from makVrv::DtWidget
	DtWidget (DtDe &de, DtUniqueID id)
virtual	~DtWidget ()
virtual DtUniqueID	id () const
	Return this widget's id. More...
virtual DtUniqueID	parentId () const
	Return the unique id specified as the parent of this widget. More...

Protected Attributes
osg::ref_ptr< osg::Texture >	myTexture
DtSprite *	mySprite
unsigned int	myLayer
unsigned int	myGroup
float	myRotation
Protected Attributes inherited from makVrv::DtWidget
DtDe &	myDe
DtUniqueID	myId
DtUniqueID	myParentId

Detailed Description

The osg widget class is a distributed osg based widget.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtOsgWidget::~DtOsgWidget ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtOsgWidget::setParentId ( DtUniqueID  id )

virtual

Set the parent id.

Reimplemented from makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::setOverlay ( unsigned int  layer )

virtual

Set the layer within the widget's window.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::setRotation ( float  )

virtual

Sets the rotation of the widget. Rotation is in radians.

Implements makVrv::DtWidget.

virtual float makVrv::DtOsgWidget::getRotation ( ) const

virtual

Returns the rotation.

unsigned int makVrv::DtOsgWidget::overlay ( ) const

virtual

Get the overlay.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::setOrderGroup ( unsigned int  group )

virtual

Sets the overlay of the widget.

Implements makVrv::DtWidget.

virtual unsigned int makVrv::DtOsgWidget::orderGroup ( ) const

virtual

Gets the overlay of the widget.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::setPosition ( float  x, float  y, float  z, float  w = 0  )

virtual

Set the position of the widget in screen space.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::setBackgroundImage ( const std::string &  filename )

virtual

Set the background image.

If filename is the empty string, reset myTexture to NULL

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::setBackgroundImage ( const std::string &  filename, float  left, float  right, float  bottom, float  top  )

virtual

Set the background image with uv.

If filename is the empty string, reset myTexture to NULL

virtual void makVrv::DtOsgWidget::setColor ( float  r, float  g, float  b, float  a  )

virtual

Set the color of the widget.

This function sets the fill type to solid if myTexture is NULL. Use setBackgroundImage("") to reset myTexture to NULL.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::setOrigin ( float  originX, float  originY  )

virtual

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

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

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::setSize ( float  w, float  h  )

virtual

Sets the size of the widget in overlay coordinate space.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::setPadding ( float  paddingX, float  paddingY  )

virtual

Sets the size of the widget in overlay coordinate space.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::setModelDefinition ( const std::string &  str )

virtual

Set the widget's model definition ("theme")

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::setEventsEnabled ( bool  enabled )

virtual

Enable or disable event handling for this widget.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::setVisible ( bool  visible )

virtual

Set the widget visible or hidden.

Implements makVrv::DtWidget.

Member Data Documentation

osg::ref_ptr<osg::Texture> makVrv::DtOsgWidget::myTexture

protected

DtSprite* makVrv::DtOsgWidget::mySprite

protected

unsigned int makVrv::DtOsgWidget::myLayer

protected

unsigned int makVrv::DtOsgWidget::myGroup

protected

float makVrv::DtOsgWidget::myRotation

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvOsg/DtOsgWidget.h