makVrv::DtWidget Class Reference

The abstract base class for widgets.

Inheritance diagram for makVrv::DtWidget:

Classes
class	DtDynamicSizeConfiguration

Public Types
typedef std::vector < DtDynamicSizeConfiguration >	DtDynamicSizeConfigurationCollection

Public Member Functions
	DtWidget (DtDe &de, DtUniqueID id)
virtual	~DtWidget ()
virtual void	setOverlay (unsigned int overlay)=0
virtual unsigned int	overlay () const =0
virtual void	setOrderGroup (unsigned int group)=0
virtual void	setRotation (float)=0
virtual unsigned int	orderGroup () const =0
virtual void	setParentId (DtUniqueID id)
virtual void	setPosition (float x, float y, float z, float w=0)=0
virtual void	setBackgroundImage (const std::string &filename)=0
virtual void	setColor (float r, float g, float b, float a)=0
virtual void	setOrigin (float originX, float originY)=0
virtual void	setSize (float w, float h)=0
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)=0
virtual void	setModelDefinition (const std::string &str)=0
virtual void	setEventsEnabled (bool enabled)=0
virtual void	setVisible (bool visible)=0
virtual DtUniqueID	id () const
virtual DtUniqueID	parentId () const

Protected Attributes
DtDe &	myDe
DtUniqueID	myId
DtUniqueID	myParentId

Member Typedef Documentation

typedef std::vector<DtDynamicSizeConfiguration> makVrv::DtWidget::DtDynamicSizeConfigurationCollection

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 void makVrv::DtWidget::setRotation ( float  )

pure virtual

Sets the rotation of the widget. Rotation is in radians. Default is no-op.

Implemented in makVrv::DtOsgAttributeGroupWidget, makVrv::DtOsgWidgetLabel, makVrv::DtWidgetLabel, 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::DtWidgetLabel, makVrv::DtOsgAttributeGroupWidget, makVrv::DtOsgWidgetLabel, and makVrv::DtOsgWidget.

virtual void makVrv::DtWidget::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. Unimplemented by default. Subclasses can define behavior.

Reimplemented in makVrv::DtOsgWidget.

virtual void makVrv::DtWidget::clearAltitudeSpecificSizes ( )

virtual

Clear altitude-specific sizes, if any were defined. Altitude-specific sizes are defined using: setAltitudeSpecificSizes(...). Unimplemented by default. Subclasses can define behavior.

Reimplemented in makVrv::DtOsgWidget.

virtual void makVrv::DtWidget::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(...) Unimplemented by default. Subclasses can define behavior.

Reimplemented in makVrv::DtOsgWidget.

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

virtual

Set the altitude, in meters, to use when determining the forced size. This is only used if setIsForcedSizeByAltitudeEnabled(true). Unimplemented by default. Subclasses can define behavior.

Reimplemented in 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::DtOsgWidgetLabel, makVrv::DtOsgAttributeGroupWidget, 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::DtOsgWidgetLabel, makVrv::DtOsgAttributeGroupWidget, and makVrv::DtOsgWidget.

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

pure virtual

Set whether the widget is visible or not.

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

virtual DtUniqueID makVrv::DtWidget::id ( ) const

virtual

Return this widget's id. If the widget is distributable, this will be it's id assigned by the agent manager.

virtual DtUniqueID makVrv::DtWidget::parentId ( ) const

virtual

Return the unique id specified as the parent of this widget. When a widget is added as a DtProjectedWidgetModel's widget, this will be the scene object id of the scene object that the widget model is attached to. Note that parentId may be 0, in which case it is not set.

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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvCore/DtWidget.h