VR-Forces 5.0.1 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::DtOsgAttributeGroupWidget Class Reference
vrvOsg

The osg implementation of an attribute group.

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

Public Member Functions

 DtOsgAttributeGroupWidget (DtDe &de, DtUniqueID id)
 
virtual ~DtOsgAttributeGroupWidget ()
 
 DtOsgAttributeGroupWidget ()=delete
 
 DtOsgAttributeGroupWidget (const DtOsgAttributeGroupWidget &other)=delete
 
DtOsgAttributeGroupWidget & operator= (const DtOsgAttributeGroupWidget &other)=delete
 
virtual void setBackgroundEnabled (bool enabled)
 
virtual void setOutlineColor (float r, float g, float b, float a=1.0f)
 
virtual void setOutlineWidth (float width)
 
virtual void setOutlineEnabled (bool enabled)
 
virtual void setTypeText (unsigned int index, const DtUnicode &attributeName)
 
virtual void setTypeValueText (unsigned int index, const DtUnicode &attributeName)
 
virtual void setTypeNumeric (unsigned int index, const DtUnicode &attributeName)
 
virtual void setTypeValueBar (unsigned int index, const DtUnicode &attributeName)
 
virtual void setTypeGraph (unsigned int index, const DtUnicode &attributeName, int maxValues)
 
virtual void setTypeImage (unsigned int index, const DtUnicode &attributeName)
 
virtual void setTypeNull (unsigned int index)
 
virtual void setValueImage (unsigned int index, const std::string &imageFilepath)
 
virtual void setValueGraphPoint (unsigned int index, unsigned int n, float x, float y)
 
virtual void setValueBarValue (unsigned int index, float val)
 
virtual void setValueNumeric (unsigned int index, float val)
 
virtual void setValueTextValue (unsigned int index, const DtUnicode &val)
 
virtual void setAttributeVisible (unsigned int index, bool visible)
 
virtual void setOverlay (unsigned int overlay)
 
virtual unsigned int overlay () const
 
virtual void setOrderGroup (unsigned int group)
 
virtual unsigned int orderGroup () const
 
virtual void setBackgroundOrderGroup (unsigned int groupId)
 
virtual void setPosition (float x, float y, float z, float w=0)
 
virtual void setBackgroundImage (const std::string &filename)
 
virtual void setBackgroundColor (float r, float g, float b, float a=1.0f)
 
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 setPadding (float paddingX, float paddingY)
 
virtual void setModelDefinition (const std::string &str)
 
virtual void setEventsEnabled (bool enabled)
 
virtual void expandLayoutBy (unsigned int rows, unsigned int cols)
 
virtual void setVisible (bool visible)
 
virtual void setLodOutAltitude (double lodOutAltitude)
 
virtual void setIsLodOutAltitudeEnabled (bool isLodOutAltitudeEnabled)
 
virtual void setHorizontalCenter (bool center)
 
virtual void setVerticalCenter (bool center)
 
virtual void setFontSize (float fontSize)
 
virtual void setFontFile (const std::string &fontFile)
 
virtual void setShadowText (bool enabled)
 
virtual void setRotation (float)
 
- Public Member Functions inherited from makVrv::DtAttributeGroupWidget
 DtAttributeGroupWidget (DtDe &de, DtUniqueID id)
 
virtual ~DtAttributeGroupWidget ()
 
- Public Member Functions inherited from makVrv::DtWidget
 DtWidget (DtDe &de, DtUniqueID id)
 
virtual ~DtWidget ()
 
virtual void setParentId (DtUniqueID id)
 
virtual void setAltitudeSpecificSizes (const DtWidget::DtDynamicSizeConfigurationCollection &configs)
 
virtual void clearAltitudeSpecificSizes ()
 
virtual void setIsForcedSizeByAltitudeEnabled (bool enabled)
 
virtual void setAltitudeForForcedSize (double minimumAltitudeForUse)
 
virtual DtUniqueID id () const
 
virtual DtUniqueID parentId () const
 

Protected Member Functions

virtual void createOrUpdateTextAttribute (unsigned int rowIndex, unsigned int columnIndex, const DtUnicode &textString)
 
virtual DtTextAttribute * buildTextAttribute (const DtUnicode &text)
 

Protected Attributes

DtAttributeLayout myLayout
 
osg::Vec4 myBackgroundColor
 
unsigned int myOrderGroup
 
unsigned int myBackgroundOrderGroup
 
float myR
 
float myG
 
float myB
 
float myA
 
std::string myFontFile
 
float myFontSize
 
unsigned int myOverlay
 
bool myIsLodOutAltitudeEnabled
 
double myLodOutAltitude
 
- 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::DtOsgAttributeGroupWidget::DtOsgAttributeGroupWidget ( DtDe &  de,
DtUniqueID  id 
)

CTOR.

virtual makVrv::DtOsgAttributeGroupWidget::~DtOsgAttributeGroupWidget ( )
virtual

DTOR.

makVrv::DtOsgAttributeGroupWidget::DtOsgAttributeGroupWidget ( )
delete

Default Constructor not implemented.

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

Copy Constructor not implemented - Copy not allowed.

Member Function Documentation

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

Assignment Operator not implemented - Assignment not allowed.

virtual void makVrv::DtOsgAttributeGroupWidget::setBackgroundEnabled ( bool  enabled)
virtual

Enable or disable the background.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setOutlineColor ( float  r,
float  g,
float  b,
float  a = 1.0f 
)
virtual

Set the color of the outline.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setOutlineWidth ( float  width)
virtual

Set the line width of the outline.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setOutlineEnabled ( bool  enabled)
virtual

Enable or disable the outline.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setTypeText ( unsigned int  index,
const DtUnicode &  attributeName 
)
virtual

Set the index'th attribute to be a text-only attribute.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setTypeValueText ( unsigned int  index,
const DtUnicode &  attributeName 
)
virtual

Set the index'th attribute to be a text value attribute.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setTypeNumeric ( unsigned int  index,
const DtUnicode &  attributeName 
)
virtual

Set the index'th attribute to be a numeric attribute.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setTypeValueBar ( unsigned int  index,
const DtUnicode &  attributeName 
)
virtual

Set the index'th attribute to be a value bar attribute.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setTypeGraph ( unsigned int  index,
const DtUnicode &  attributeName,
int  maxValues 
)
virtual

Set the index'th attribute to be a line graph attribute.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setTypeImage ( unsigned int  index,
const DtUnicode &  attributeName 
)
virtual

Set the index'th attribute to be an image attribute.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setTypeNull ( unsigned int  index)
virtual

Set the index'th attribute to be a null attribute (not displayed)

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setValueImage ( unsigned int  index,
const std::string &  imageFilepath 
)
virtual

Set the value of the index'th attribute to the image filename.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setValueGraphPoint ( unsigned int  index,
unsigned int  n,
float  x,
float  y 
)
virtual

Set the line graph's nth x,y values for the index'th attribute.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setValueBarValue ( unsigned int  index,
float  val 
)
virtual

Set the value bar value for the index'th attribute.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setValueNumeric ( unsigned int  index,
float  val 
)
virtual

Set the numeric value for the index'th attribute.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setValueTextValue ( unsigned int  index,
const DtUnicode &  val 
)
virtual

Set the text value for the index'th attribute.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setAttributeVisible ( unsigned int  index,
bool  visible 
)
virtual

Set an attribute visible or hidden.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setOverlay ( unsigned int  overlay)
virtual

Sets the overlay of the widget.

Implements makVrv::DtWidget.

virtual unsigned int makVrv::DtOsgAttributeGroupWidget::overlay ( ) const
virtual

Gets the overlay of the widget.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setOrderGroup ( unsigned int  group)
virtual

Sets the overlay group of the widget.

Implements makVrv::DtWidget.

virtual unsigned int makVrv::DtOsgAttributeGroupWidget::orderGroup ( ) const
virtual

Gets the overlay of the widget.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setBackgroundOrderGroup ( unsigned int  groupId)
virtual

Set the overlay group used for shadows and the background.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::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::DtOsgAttributeGroupWidget::setBackgroundImage ( const std::string &  filename)
virtual

Set the background image.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setBackgroundColor ( float  r,
float  g,
float  b,
float  a = 1.0f 
)
virtual

Set the background color.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

Set the color of the widget.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::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::DtOsgAttributeGroupWidget::setSize ( float  w,
float  h 
)
virtual

Sets the size of the widget in overlay coordinate space.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setPadding ( float  paddingX,
float  paddingY 
)
virtual

Sets the size of the widget in overlay coordinate space.

Implements makVrv::DtWidget.

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

Sets the model definition of the widget (optional, since widgets are not models)

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setEventsEnabled ( bool  enabled)
virtual

Enable or disable events for this widget.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::expandLayoutBy ( unsigned int  rows,
unsigned int  cols 
)
virtual

Expand the layout to have at least rows, cols dimensions.

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

Set the attribute group visible or hidden.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setLodOutAltitude ( double  lodOutAltitude)
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).

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setIsLodOutAltitudeEnabled ( bool  isLodOutAltitudeEnabled)
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(...). Default is True.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setHorizontalCenter ( bool  center)
virtual

Set whether or not to center the attribute group horizontally around its origin.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setVerticalCenter ( bool  center)
virtual

Set whether or not to center the attribute group vertically around its origin.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setFontSize ( float  fontSize)
virtual

Set the size of the font in points.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setFontFile ( const std::string &  fontFile)
virtual

Set the font file to use.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setShadowText ( bool  enabled)
virtual

Set whether text shadows should be displayed.

Implements makVrv::DtAttributeGroupWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::setRotation ( float  )
virtual

No-op for attribute groups as they cannot be rotated.

Implements makVrv::DtWidget.

virtual void makVrv::DtOsgAttributeGroupWidget::createOrUpdateTextAttribute ( unsigned int  rowIndex,
unsigned int  columnIndex,
const DtUnicode &  textString 
)
protectedvirtual

Update the string of a text attribute at the given row/column If a text attribute is not present at the given row/column, create one and update its text.

virtual DtTextAttribute* makVrv::DtOsgAttributeGroupWidget::buildTextAttribute ( const DtUnicode &  text)
protectedvirtual

Create a text attribute with the provided DtUnicode string.

Member Data Documentation

DtAttributeLayout makVrv::DtOsgAttributeGroupWidget::myLayout
protected
osg::Vec4 makVrv::DtOsgAttributeGroupWidget::myBackgroundColor
protected
unsigned int makVrv::DtOsgAttributeGroupWidget::myOrderGroup
protected
unsigned int makVrv::DtOsgAttributeGroupWidget::myBackgroundOrderGroup
protected
float makVrv::DtOsgAttributeGroupWidget::myR
protected
float makVrv::DtOsgAttributeGroupWidget::myG
protected
float makVrv::DtOsgAttributeGroupWidget::myB
protected
float makVrv::DtOsgAttributeGroupWidget::myA
protected
std::string makVrv::DtOsgAttributeGroupWidget::myFontFile
protected
float makVrv::DtOsgAttributeGroupWidget::myFontSize
protected
unsigned int makVrv::DtOsgAttributeGroupWidget::myOverlay
protected
bool makVrv::DtOsgAttributeGroupWidget::myIsLodOutAltitudeEnabled
protected
double makVrv::DtOsgAttributeGroupWidget::myLodOutAltitude
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)