The osg widget class is a distributed osg based widget.

Inheritance diagram for makVrv::DtOsgWidget:

Public Member Functions
	DtOsgWidget (DtDe &de, DtUniqueID id)

virtual	~DtOsgWidget ()

virtual void	setParentId (DtUniqueID id)

virtual void	setOverlay (unsigned int layer)

virtual void	setRotation (float)

virtual float	getRotation () const

unsigned int	overlay () const

virtual void	setOrderGroup (unsigned int group)

virtual unsigned int	orderGroup () const

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

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

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

virtual void	setColor (float r, float g, float b, float a)

virtual void	setOrigin (float originX, float originY)

virtual void	setSize (float w, float h)

virtual void	setAltitudeSpecificSizes (const DtWidget::DtDynamicSizeConfigurationCollection &configs)

virtual void	clearAltitudeSpecificSizes ()

virtual void	setIsForcedSizeByAltitudeEnabled (bool enabled)

virtual void	setAltitudeForForcedSize (double minimumAltitudeForUse)

virtual void	setPadding (float paddingX, float paddingY)

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

virtual void	setEventsEnabled (bool enabled)

virtual void	setVisible (bool visible)

Public Member Functions inherited from makVrv::DtWidget
	DtWidget (DtDe &de, DtUniqueID id)

virtual	~DtWidget ()

virtual DtUniqueID	id () const

virtual DtUniqueID	parentId () const

Protected Attributes
osg::ref_ptr< osg::Texture >	myTexture

DtSprite *	mySprite

unsigned int	myLayer

unsigned int	myGroup

float	myRotation

DtWidget::DtDynamicSizeConfigurationCollection	myAltitudeSpecificSizes

Protected Attributes inherited from makVrv::DtWidget
DtDe &	myDe

DtUniqueID	myId

DtUniqueID	myParentId

Additional Inherited Members
Public Types inherited from makVrv::DtWidget
typedef std::vector < DtDynamicSizeConfiguration >	DtDynamicSizeConfigurationCollection

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::setAltitudeSpecificSizes ( const DtWidget::DtDynamicSizeConfigurationCollection & configs )

virtual

Set an altitude-specific (meters) sizes for the widget. Allows for the use of different sizes depending on the altitude of the camera rendering the widget.

Reimplemented from makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::clearAltitudeSpecificSizes ( )

virtual

Clear altitude-specific sizes, if any were defined. Altitude-specific sizes are defined using: setAltitudeSpecificSizes(...).

Reimplemented from makVrv::DtWidget.

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

virtual

Set whether or not a particular size is used, regardless of altitude. This only matters if altitude-specific sizes are used. The size used is provided by the altitude-specific configuration corresponding to the altitude provided using: setAltitudeForForcedSize(...)

Reimplemented from makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::setAltitudeForForcedSize ( double minimumAltitudeForUse )

virtual

Set the altitude, in meters, to use when determining the forced size. This is only used if setIsForcedSizeByAltitudeEnabled(true).

Reimplemented from 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

DtWidget::DtDynamicSizeConfigurationCollection makVrv::DtOsgWidget::myAltitudeSpecificSizes

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvOsg/DtOsgWidget.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation