VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtWidget Class Referenceabstract
vrvCore

The abstract base class for widgets.

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

Classes

class  DtDynamicSizeConfiguration
 

Public Types

typedef std::vector
< DtDynamicSizeConfiguration > 		DtDynamicSizeConfigurationCollection
 

Public Member Functions

 DtWidget (DtDe &de, DtUniqueID id)
 
virtual ~DtWidget ()
 
 DtWidget (const DtWidget &other)=delete
 
DtWidget & operator= (const DtWidget &other)=delete
 
 DtWidget (const DtWidget &&other)=delete
 
DtWidget & operator= (const DtWidget &&other)=delete
 
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 setOriginOffset (int xOffset, int yOffset)=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 setLodOutAltitude (double lodOutAltitude)=0
 
virtual void setIsLodOutAltitudeEnabled (bool isLodOutAltitudeEnabled)=0
 
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
 
virtual void registerUpdater (DtWidgetUpdater *updater)
 
virtual void unregisterUpdater (DtWidgetUpdater *updater)
 
virtual DtWidgetUpdater * updater ()
 

Protected Member Functions

virtual void updateEventSignals ()=0
 

Protected Attributes

DtDe & myDe
 
DtUniqueID myId
 
DtUniqueID myParentId
 
DtSignalConnectionManager mySignalConnectionManager
 
DtWidgetUpdater * myUpdater
 

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
makVrv::DtWidget::DtWidget ( const DtWidget &  other)
delete

Copy Constructor not implemented - Copy not allowed.

makVrv::DtWidget::DtWidget ( const DtWidget &&  other)
delete

Move Constructor not implemented - Move not allowed.

Member Function Documentation

DtWidget& makVrv::DtWidget::operator= ( const DtWidget &  other)
delete

Assignment Operator not implemented - Assignment not allowed.

DtWidget& makVrv::DtWidget::operator= ( const DtWidget &&  other)
delete

Move Assignment Operator not implemented - Move Assignment not allowed.

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::DtOsgWidgetLabel, and 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::setOriginOffset ( int  xOffset,
int  yOffset 
)
pure virtual

Set the offset in pixels 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::setLodOutAltitude ( double  lodOutAltitude)
pure virtual

Set the altitude, in meters, at which all attributes belonging to the calling attribute group widget will no longer appear. This is only used if setIsLodOutAltitudeEnabled(true).

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

virtual void makVrv::DtWidget::setIsLodOutAltitudeEnabled ( bool  isLodOutAltitudeEnabled)
pure virtual

Set whether or not the attributes in this attribute group widget will use the LOD Out Altitude property. The LOD Out Altitude property is set using setLodOutAltitude(...).

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

virtual void makVrv::DtWidget::registerUpdater ( DtWidgetUpdater *  updater)
virtual

Registers the given updater with this widget indicating that the given updater will be updating the widget. The widget only has 1 updater. The widget will automatically remove itself from any current updater. The updater will unregister itself from this widget if the updater is destroyed. The widget will remove itself from the updater if the widget is destroyed. Generally, this method is only called/needed by DtWidgetUpdater.

virtual void makVrv::DtWidget::unregisterUpdater ( DtWidgetUpdater *  updater)
virtual

Unregisters the given updater with this widget. This should be called when an updater has been previouly registered with registerUpdater. Generally, this method is only called/needed by DtWidgetUpdater.

virtual DtWidgetUpdater* makVrv::DtWidget::updater ( )
virtual

Returns the current updater that this widget is registered with.

virtual void makVrv::DtWidget::updateEventSignals ( )
protectedpure virtual

Disconnect all signals on the signal manager, and reconnects if the pickable widget has events enabled.

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

Member Data Documentation

DtDe& makVrv::DtWidget::myDe
protected
DtUniqueID makVrv::DtWidget::myId
protected
DtUniqueID makVrv::DtWidget::myParentId
protected
DtSignalConnectionManager makVrv::DtWidget::mySignalConnectionManager
protected
DtWidgetUpdater* makVrv::DtWidget::myUpdater
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)