VR-Forces 4.0.4 Class Documentation
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtAttributeGroupIndicator Class Reference

The indicator widget. More...

List of all members.

Public Types

enum  { MaxGraphPoints = 10 }
enum  AttributeType {
  AttributeTypeNull, AttributeTypeImage, AttributeTypeNumeric, AttributeTypeText,
  AttributeTypeGraph, AttributeTypeValueBar
}

Public Member Functions

 DtAttributeGroupIndicator (DtAgentManagerInterface &sceneInterface, unsigned int modelSet, const std::string &normalTheme="AttributeGroupIndicatorTheme", const std::string &pinnedTheme="AttributeGroupPinnedTheme", int height=16, int width=16)
virtual ~DtAttributeGroupIndicator ()
virtual void setIndicatorActive (bool active)
 Sets the indicator state to active/inactive (i.e. pinned)
virtual void setColor (float r, float g, float b, float a=1.)
 Sets the color filter for the indicator.
virtual
DtProjectedWidgetModelAgent * 
model ()
 Get the model which can be added to the scene objects.
virtual void setEventsEnabled (bool enabled)
 Enable/disable event handling for the widget.
virtual DtWidgetEventSignalseventSignals (DtWidgetSignaler &signaler)
 Get the widget agent for the indicator. If the signals.
virtual void setAttributeGroupVisible (bool visible)
 Set the attribute group's visibility.
virtual void setAttributeVisible (unsigned int index, bool visible)
 Set the visibility of an attribute within the attribute group.
virtual void setVisible (bool visible)
 Set the attribute group's visiblity; This is combined with setAttributeGroupVisible, so for example calling setAttributeGroupVisible(false) and setVisible(true) will leave the attribute group hidden.
virtual bool isVisible ()
 Returns true IFF all criteria for the attribute group to be visible are satisfied.
virtual void setAttributeType (unsigned int index, const DtUnicode &name, AttributeType t)
 Set the type of the attribute at index.
virtual void setValueImage (unsigned int index, const std::string &imageFilepath)
 Set the value of the index'th attribute to the image filename.
virtual void setValueGraphPoint (unsigned int index, unsigned int n, float x, float y)
 Set the line graph's nth x,y values for the index'th attribute.
virtual void setValueBarValue (unsigned int index, float val)
 Set the value bar value for the index'th attribute.
virtual void setValueNumeric (unsigned int index, float val)
 Set the numeric value for the index'th attribute.
virtual void setMouseIn (bool mouseIn)
 Set whether or not the mouse is in the indicator.
virtual void toggleLockState ()
 Toggle whether or not the attribute group is locked to visible.

Protected Member Functions

virtual void updateVisibility ()
 Update the visibility of the component widgets according to current visibility state.

Protected Attributes

DtAgentManagerInterfacemySceneInterface
DtWidgetInstanceSignalermyWidgetSignaler
DtProjectedWidgetModelAgent * myProjectedWidgetModel
DtWidgetAgent * myWidgetAgent
DtAttributeGroupWidgetAgent * myAttributeGroupWidgetAgent
std::string myNormalTheme
std::string myPinnedTheme
bool mySelected
bool myEventsEnabled
bool myMouseIn
bool myAttributeGroupLocked
bool myVisible
bool myGroupVisible
std::vector< boolmyAttributeVisibility

Detailed Description

The indicator widget.


Member Enumeration Documentation

anonymous enum
Enumerator:
MaxGraphPoints 
Enumerator:
AttributeTypeNull 
AttributeTypeImage 
AttributeTypeNumeric 
AttributeTypeText 
AttributeTypeGraph 
AttributeTypeValueBar 

Constructor & Destructor Documentation

makVrv::DtAttributeGroupIndicator::DtAttributeGroupIndicator ( DtAgentManagerInterface sceneInterface,
unsigned int  modelSet,
const std::string &  normalTheme = "AttributeGroupIndicatorTheme",
const std::string &  pinnedTheme = "AttributeGroupPinnedTheme",
int  height = 16,
int  width = 16 
)

Member Function Documentation

virtual void makVrv::DtAttributeGroupIndicator::setIndicatorActive ( bool  active) [virtual]

Sets the indicator state to active/inactive (i.e. pinned)

virtual void makVrv::DtAttributeGroupIndicator::setColor ( float  r,
float  g,
float  b,
float  a = 1. 
) [virtual]

Sets the color filter for the indicator.

virtual DtProjectedWidgetModelAgent* makVrv::DtAttributeGroupIndicator::model ( ) [virtual]

Get the model which can be added to the scene objects.

virtual void makVrv::DtAttributeGroupIndicator::setEventsEnabled ( bool  enabled) [virtual]

Enable/disable event handling for the widget.

Get the widget agent for the indicator. If the signals.

Set the attribute group's visibility.

virtual void makVrv::DtAttributeGroupIndicator::setAttributeVisible ( unsigned int  index,
bool  visible 
) [virtual]

Set the visibility of an attribute within the attribute group.

virtual void makVrv::DtAttributeGroupIndicator::setVisible ( bool  visible) [virtual]

Set the attribute group's visiblity; This is combined with setAttributeGroupVisible, so for example calling setAttributeGroupVisible(false) and setVisible(true) will leave the attribute group hidden.

Returns true IFF all criteria for the attribute group to be visible are satisfied.

virtual void makVrv::DtAttributeGroupIndicator::setAttributeType ( unsigned int  index,
const DtUnicode name,
AttributeType  t 
) [virtual]

Set the type of the attribute at index.

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

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

virtual void makVrv::DtAttributeGroupIndicator::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.

virtual void makVrv::DtAttributeGroupIndicator::setValueBarValue ( unsigned int  index,
float  val 
) [virtual]

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

virtual void makVrv::DtAttributeGroupIndicator::setValueNumeric ( unsigned int  index,
float  val 
) [virtual]

Set the numeric value for the index'th attribute.

virtual void makVrv::DtAttributeGroupIndicator::setMouseIn ( bool  mouseIn) [virtual]

Set whether or not the mouse is in the indicator.

Toggle whether or not the attribute group is locked to visible.

virtual void makVrv::DtAttributeGroupIndicator::updateVisibility ( ) [protected, virtual]

Update the visibility of the component widgets according to current visibility state.


Member Data Documentation

DtProjectedWidgetModelAgent* makVrv::DtAttributeGroupIndicator::myProjectedWidgetModel [protected]
DtAttributeGroupWidgetAgent* makVrv::DtAttributeGroupIndicator::myAttributeGroupWidgetAgent [protected]

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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)