VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Attributes
makVrv::DtOsgWidget Class Reference

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

Inheritance diagram for makVrv::DtOsgWidget:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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

Protected Attributes

osg::ref_ptr< osg::Texture > myTexture
DtSpritemySprite
unsigned int myLayer
unsigned int myGroup

Detailed Description

The osg widget class is a distributed osg based widget.


Constructor & Destructor Documentation

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.

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.

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.

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

Set the color of the widget.

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]
unsigned int makVrv::DtOsgWidget::myLayer [protected]
unsigned int makVrv::DtOsgWidget::myGroup [protected]

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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)