VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions
makVrv::DtAttributeGroupWidget Class Referenceabstract

Class for a widget that displays remote graphics attribute groups. More...

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

Public Member Functions

 DtAttributeGroupWidget (DtDe &de, DtUniqueID id)
 A widget label ctor. More...
 
virtual ~DtAttributeGroupWidget ()
 DTOR. More...
 
virtual void setBackgroundEnabled (bool enabled)=0
 Enable or disable the background. More...
 
virtual void setBackgroundColor (float r, float g, float b, float a=1.0f)=0
 Set the background color. More...
 
virtual void setOutlineEnabled (bool enabled)=0
 Enable or disable the outline. More...
 
virtual void setTypeText (unsigned int index, const DtUnicode &attributeName)=0
 Set the index'th attribute to be a text-only attribute. More...
 
virtual void setTypeNumeric (unsigned int index, const DtUnicode &attributeName)=0
 Set the index'th attribute to be a numeric attribute. More...
 
virtual void setTypeValueBar (unsigned int index, const DtUnicode &attributeName)=0
 Set the index'th attribute to be a value bar attribute. More...
 
virtual void setTypeGraph (unsigned int index, const DtUnicode &attributeName, int maxValues)=0
 Set the index'th attribute to be a line graph attribute maxValues is the maximum number of values to store in the graph; when this maximum is reached, the graph will throw out the oldest values as new values are added. More...
 
virtual void setTypeImage (unsigned int index, const DtUnicode &attributeName)=0
 Set the index'th attribute to be an image attribute. More...
 
virtual void setTypeValueText (unsigned int index, const DtUnicode &attributeName)=0
 Set the index'th attribute to be a value text attribute. More...
 
virtual void setTypeNull (unsigned int index)=0
 Set the index'th attribute to be a null attribute (not displayed) More...
 
virtual void setValueImage (unsigned int index, const std::string &imageFilepath)=0
 Set the value of the index'th attribute to the image filename. More...
 
virtual void setValueGraphPoint (unsigned int index, unsigned int n, float x, float y)=0
 Set the line graph's nth x,y values for the index'th attribute. More...
 
virtual void setValueBarValue (unsigned int index, float val)=0
 Set the value bar value for the index'th attribute. More...
 
virtual void setValueNumeric (unsigned int index, float val)=0
 Set the numeric value for the index'th attribute. More...
 
virtual void setValueTextValue (unsigned int index, const DtUnicode &val)=0
 Set the text value for the index'th attribute. More...
 
virtual void setAttributeVisible (unsigned int index, bool visible)=0
 Set an attribute visible or hidden. More...
 
virtual void setHorizontalCenter (bool center)=0
 Set whether or not to center the attribute group horizontally around its origin. More...
 
virtual void setVerticalCenter (bool center)=0
 Set whether or not to center the attribute group vertically around its origin. More...
 
virtual void setFontSize (float points)=0
 Set the font size for text based attributes. More...
 
virtual void setFontFile (const std::string &)=0
 Set the font size file. More...
 
virtual void setShadowText (bool enabled)=0
 Set whether text shadows should be displayed. More...
 
virtual void setBackgroundOrderGroup (unsigned int groupId)=0
 Set the overlay group used for shadows and the background. More...
 
- Public Member Functions inherited from makVrv::DtWidget
 DtWidget (DtDe &de, DtUniqueID id)
 
virtual ~DtWidget ()
 
virtual void setOverlay (unsigned int overlay)=0
 Sets the overlay of the widget. More...
 
virtual unsigned int overlay () const =0
 Gets the overlay of the widget. More...
 
virtual void setOrderGroup (unsigned int group)=0
 Sets the overlay of the widget. More...
 
virtual void setRotation (float)=0
 Sets the rotation of the widget. Rotation is in radians. Default is no-op. More...
 
virtual unsigned int orderGroup () const =0
 Gets the overlay of the widget. More...
 
virtual void setParentId (DtUniqueID id)
 Set the parent id. More...
 
virtual void setPosition (float x, float y, float z, float w=0)=0
 Set the position of the widget in screen space. More...
 
virtual void setBackgroundImage (const std::string &filename)=0
 Set the background image. More...
 
virtual void setColor (float r, float g, float b, float a)=0
 Set the color of the widget. More...
 
virtual void setOrigin (float originX, float originY)=0
 Sets the origin location, by default it is 0,0. More...
 
virtual void setSize (float w, float h)=0
 Sets the size of the widget in overlay coordinate space. More...
 
virtual void setPadding (float paddingX, float paddingY)=0
 Sets the size of the widget in overlay coordinate space. More...
 
virtual void setModelDefinition (const std::string &str)=0
 Sets the model definition of the widget (optional, since widgets are not models) More...
 
virtual void setEventsEnabled (bool enabled)=0
 Enable or disable events for this widget. More...
 
virtual void setVisible (bool visible)=0
 Set whether the widget is visible or not. More...
 
virtual DtUniqueID id () const
 Return this widget's id. More...
 
virtual DtUniqueID parentId () const
 Return the unique id specified as the parent of this widget. More...
 

Additional Inherited Members

- Protected Attributes inherited from makVrv::DtWidget
DtDemyDe
 
DtUniqueID myId
 
DtUniqueID myParentId
 

Detailed Description

Class for a widget that displays remote graphics attribute groups.

Constructor & Destructor Documentation

makVrv::DtAttributeGroupWidget::DtAttributeGroupWidget ( DtDe de,
DtUniqueID  id 
)

A widget label ctor.

virtual makVrv::DtAttributeGroupWidget::~DtAttributeGroupWidget ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtAttributeGroupWidget::setBackgroundEnabled ( bool  enabled)
pure virtual

Enable or disable the background.

Implemented in makVrv::DtOsgAttributeGroupWidget.

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

Set the background color.

Implemented in makVrv::DtOsgAttributeGroupWidget.

virtual void makVrv::DtAttributeGroupWidget::setOutlineEnabled ( bool  enabled)
pure virtual

Enable or disable the outline.

Implemented in makVrv::DtOsgAttributeGroupWidget.

virtual void makVrv::DtAttributeGroupWidget::setTypeText ( unsigned int  index,
const DtUnicode attributeName 
)
pure virtual

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

Implemented in makVrv::DtOsgAttributeGroupWidget.

virtual void makVrv::DtAttributeGroupWidget::setTypeNumeric ( unsigned int  index,
const DtUnicode attributeName 
)
pure virtual

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

Implemented in makVrv::DtOsgAttributeGroupWidget.

virtual void makVrv::DtAttributeGroupWidget::setTypeValueBar ( unsigned int  index,
const DtUnicode attributeName 
)
pure virtual

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

Implemented in makVrv::DtOsgAttributeGroupWidget.

virtual void makVrv::DtAttributeGroupWidget::setTypeGraph ( unsigned int  index,
const DtUnicode attributeName,
int  maxValues 
)
pure virtual

Set the index'th attribute to be a line graph attribute maxValues is the maximum number of values to store in the graph; when this maximum is reached, the graph will throw out the oldest values as new values are added.

Values of maxValue < 0 indicate no limit.

Implemented in makVrv::DtOsgAttributeGroupWidget.

virtual void makVrv::DtAttributeGroupWidget::setTypeImage ( unsigned int  index,
const DtUnicode attributeName 
)
pure virtual

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

Implemented in makVrv::DtOsgAttributeGroupWidget.

virtual void makVrv::DtAttributeGroupWidget::setTypeValueText ( unsigned int  index,
const DtUnicode attributeName 
)
pure virtual

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

Implemented in makVrv::DtOsgAttributeGroupWidget.

virtual void makVrv::DtAttributeGroupWidget::setTypeNull ( unsigned int  index)
pure virtual

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

Implemented in makVrv::DtOsgAttributeGroupWidget.

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

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

Implemented in makVrv::DtOsgAttributeGroupWidget.

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

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

Implemented in makVrv::DtOsgAttributeGroupWidget.

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

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

Implemented in makVrv::DtOsgAttributeGroupWidget.

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

Set the numeric value for the index'th attribute.

Implemented in makVrv::DtOsgAttributeGroupWidget.

virtual void makVrv::DtAttributeGroupWidget::setValueTextValue ( unsigned int  index,
const DtUnicode val 
)
pure virtual

Set the text value for the index'th attribute.

Implemented in makVrv::DtOsgAttributeGroupWidget.

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

Set an attribute visible or hidden.

Implemented in makVrv::DtOsgAttributeGroupWidget.

virtual void makVrv::DtAttributeGroupWidget::setHorizontalCenter ( bool  center)
pure virtual

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

Implemented in makVrv::DtOsgAttributeGroupWidget.

virtual void makVrv::DtAttributeGroupWidget::setVerticalCenter ( bool  center)
pure virtual

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

Implemented in makVrv::DtOsgAttributeGroupWidget.

virtual void makVrv::DtAttributeGroupWidget::setFontSize ( float  points)
pure virtual

Set the font size for text based attributes.

Implemented in makVrv::DtOsgAttributeGroupWidget.

virtual void makVrv::DtAttributeGroupWidget::setFontFile ( const std::string &  )
pure virtual

Set the font size file.

Implemented in makVrv::DtOsgAttributeGroupWidget.

virtual void makVrv::DtAttributeGroupWidget::setShadowText ( bool  enabled)
pure virtual

Set whether text shadows should be displayed.

Implemented in makVrv::DtOsgAttributeGroupWidget.

virtual void makVrv::DtAttributeGroupWidget::setBackgroundOrderGroup ( unsigned int  groupId)
pure virtual

Set the overlay group used for shadows and the background.

Note: This is the same as calling setOrderGroup(unsigned int).

Implemented in makVrv::DtOsgAttributeGroupWidget.


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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)