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

The osg widget class is a distributed osg based widget.

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

Public Member Functions

 DtOsgWidget (DtDe &de, DtUniqueID id)
 
virtual ~DtOsgWidget ()
 
virtual void setParentId (DtUniqueID id) override
 
virtual void setOverlay (unsigned int layer) override
 
virtual void setRotation (float) override
 
virtual float getRotation () const
 
unsigned int overlay () const override
 
virtual void setOrderGroup (unsigned int group) override
 
virtual unsigned int orderGroup () const override
 
virtual void setPosition (float x, float y, float z, float w=0) override
 
virtual void setBackgroundImage (const std::string &filename) override
 
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) override
 
virtual void setOriginOffset (int offsetX, int offsetY) override
 
virtual void setSize (float w, float h) override
 
virtual void setAltitudeSpecificSizes (const DtWidget::DtDynamicSizeConfigurationCollection &configs) override
 
virtual void clearAltitudeSpecificSizes () override
 
virtual void setIsForcedSizeByAltitudeEnabled (bool enabled) override
 
virtual void setAltitudeForForcedSize (double minimumAltitudeForUse) override
 
virtual void setLodOutAltitude (double lodOutAltitude) override
 
virtual void setIsLodOutAltitudeEnabled (bool isLodOutAltitudeEnabled) override
 
virtual void setPadding (float paddingX, float paddingY) override
 
virtual void setModelDefinition (const std::string &str) override
 
virtual void setEventsEnabled (bool enabled) override
 
virtual void setVisible (bool visible) override
 
- Public Member Functions inherited from makVrv::DtWidget
 DtWidget (DtDe &de, DtUniqueID id)
 
virtual ~DtWidget ()
 
 DtWidget (const DtWidget &other)=delete
 
DtWidgetoperator= (const DtWidget &other)=delete
 
 DtWidget (const DtWidget &&other)=delete
 
DtWidgetoperator= (const DtWidget &&other)=delete
 
virtual DtUniqueID id () const
 
virtual DtUniqueID parentId () const
 

Protected Member Functions

virtual void updateEventSignals () override
 

Protected Attributes

DtOsgTextureWrappermyTexture
 
DtSpritemySprite
 
unsigned int myLayer
 
unsigned int myGroup
 
int myOriginOffsetX
 
int myOriginOffsetY
 
float myRotation
 
DtWidget::DtDynamicSizeConfigurationCollection myAltitudeSpecificSizes
 
- Protected Attributes inherited from makVrv::DtWidget
DtDemyDe
 
DtUniqueID myId
 
DtUniqueID myParentId
 
DtSignalConnectionManager mySignalConnectionManager
 

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)
overridevirtual

Set the parent id.

Reimplemented from makVrv::DtWidget.

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

Set the layer within the widget's window.

Implements makVrv::DtWidget.

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

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
overridevirtual

Get the overlay.

Implements makVrv::DtWidget.

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

Sets the overlay of the widget.

Implements makVrv::DtWidget.

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

Gets the overlay of the widget.

Implements makVrv::DtWidget.

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

Set the position of the widget in screen space.

Implements makVrv::DtWidget.

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

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 
)
overridevirtual

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::setOriginOffset ( int  offsetX,
int  offsetY 
)
overridevirtual

Set the offset in pixels from the position.

Implements makVrv::DtWidget.

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

Sets the size of the widget in overlay coordinate space.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::setAltitudeSpecificSizes ( const DtWidget::DtDynamicSizeConfigurationCollection configs)
overridevirtual

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 ( )
overridevirtual

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)
overridevirtual

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)
overridevirtual

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::setLodOutAltitude ( double  lodOutAltitude)
overridevirtual

Set the minimum altitude, in meters, at which this quad will no longer render. Only used if setIsLodOutAltitudeEnabled(true). Default is the maximum value a double can hold.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::setIsLodOutAltitudeEnabled ( bool  isLodOutAltitudeEnabled)
overridevirtual

Set whether or not to use the LOD Out Altitude property. Default is true.

Implements makVrv::DtWidget.

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

Sets the size of the widget in overlay coordinate space.

Implements makVrv::DtWidget.

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

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

Implements makVrv::DtWidget.

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

Enable or disable event handling for this widget.

Implements makVrv::DtWidget.

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

Set the widget visible or hidden.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgWidget::updateEventSignals ( )
overrideprotectedvirtual

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

Implements makVrv::DtWidget.

Member Data Documentation

DtOsgTextureWrapper* makVrv::DtOsgWidget::myTexture
protected
DtSprite* makVrv::DtOsgWidget::mySprite
protected
unsigned int makVrv::DtOsgWidget::myLayer
protected
unsigned int makVrv::DtOsgWidget::myGroup
protected
int makVrv::DtOsgWidget::myOriginOffsetX
protected
int makVrv::DtOsgWidget::myOriginOffsetY
protected
float makVrv::DtOsgWidget::myRotation
protected
DtWidget::DtDynamicSizeConfigurationCollection makVrv::DtOsgWidget::myAltitudeSpecificSizes
protected

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

Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)