makVrv::DtSymbolDecorationUpdater Class Reference

DtSymbolDecorationUpdater updates symbol decorations with distributed side data. More...

Inheritance diagram for makVrv::DtSymbolDecorationUpdater:

Public Member Functions
	DtSymbolDecorationUpdater (DtDe &de, DtUniqueID id, bool suppressTick=false)
	CTOR.
virtual	~DtSymbolDecorationUpdater ()
	DTOR.
virtual bool	needsUpdate (DtTime tNow)
	Required function implementation of DtTickable pure virtual Return true if this updater should be run.
virtual void	update (DtTime tNow)
	update the symbol decorations
virtual void	setSceneObject (DtSceneObject *sceneObjectId)
	sets the scene object to update.
virtual void	attachAttributeGroupWidget (DtUniqueID id)
	attach an attribute group widget to update (referenced by its unique ID)
virtual void	associateIdWithIndex (DtUnicode idString, unsigned int index)
	associate an attribute index with an identifying string attributes are found and updated by this id string
virtual void	unAssociateId (DtUnicode idString)
	break an association created with associateIdWithIndex
virtual int	lookupDecorationIndex (const DtUnicode &idString)
	Get the label index for a decoration by id string Returns -1 if not found.
virtual DtAttributeGroupWidget *	attributeGroupWidget ()
	Get the attribute group widget associated with the updater (this is the set of labels)

Protected Types
typedef std::map< DtUnicode, unsigned int >	DecorationIdMap
	Map of decoration id string -> label index.

Protected Member Functions
virtual void	slot_sceneObjectToBeDeleted (const DtUniqueID &id)
	Called when a scene object is about to be deleted.
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager=NULL)
	CTOR.
virtual	~DtTickable ()
	Virtual DTOR.

Protected Attributes
DtDe &	myDe
	Pointer to the display engine.
DtUniqueID	myUniqueId
	The updater's unique id.
DtSceneObject *	mySceneObject
	Pointer to the scene object being updated.
DtAttributeGroupWidget *	myAttributeGroupWidget
	The attribute group widget to update.
double	myLastSymbolUpdateTime
	The last time the symbols were updated; used to slow down updating if once per frame is undesirable.
DecorationIdMap	myDecorationIdMap
	Map of decoration id string -> label index.

Detailed Description

DtSymbolDecorationUpdater updates symbol decorations with distributed side data.

Member Typedef Documentation

typedef std::map<DtUnicode, unsigned int> makVrv::DtSymbolDecorationUpdater::DecorationIdMap

protected

Map of decoration id string -> label index.

Constructor & Destructor Documentation

makVrv::DtSymbolDecorationUpdater::DtSymbolDecorationUpdater	(	DtDe &	de,
		DtUniqueID	id,
		bool	suppressTick = false
	)

CTOR.

virtual makVrv::DtSymbolDecorationUpdater::~DtSymbolDecorationUpdater ( )

virtual

DTOR.

Member Function Documentation

virtual bool makVrv::DtSymbolDecorationUpdater::needsUpdate ( DtTime  tNow )

virtual

Required function implementation of DtTickable pure virtual Return true if this updater should be run.

Implements makVrv::DtTickable.

virtual void makVrv::DtSymbolDecorationUpdater::update ( DtTime  tNow )

virtual

update the symbol decorations

Implements makVrv::DtTickable.

virtual void makVrv::DtSymbolDecorationUpdater::setSceneObject ( DtSceneObject *  sceneObjectId )

virtual

sets the scene object to update.

virtual void makVrv::DtSymbolDecorationUpdater::attachAttributeGroupWidget ( DtUniqueID  id )

virtual

attach an attribute group widget to update (referenced by its unique ID)

virtual void makVrv::DtSymbolDecorationUpdater::associateIdWithIndex ( DtUnicode  idString, unsigned int  index  )

virtual

associate an attribute index with an identifying string attributes are found and updated by this id string

virtual void makVrv::DtSymbolDecorationUpdater::unAssociateId ( DtUnicode  idString )

virtual

break an association created with associateIdWithIndex

virtual int makVrv::DtSymbolDecorationUpdater::lookupDecorationIndex ( const DtUnicode &  idString )

virtual

Get the label index for a decoration by id string Returns -1 if not found.

virtual DtAttributeGroupWidget* makVrv::DtSymbolDecorationUpdater::attributeGroupWidget ( )

virtual

Get the attribute group widget associated with the updater (this is the set of labels)

virtual void makVrv::DtSymbolDecorationUpdater::slot_sceneObjectToBeDeleted ( const DtUniqueID &  id )

protectedvirtual

Called when a scene object is about to be deleted.

Since we hold onto a pointer to a scene object, we need this to insure our pointer does not become stale.

Member Data Documentation

DtDe& makVrv::DtSymbolDecorationUpdater::myDe

protected

Pointer to the display engine.

DtUniqueID makVrv::DtSymbolDecorationUpdater::myUniqueId

protected

The updater's unique id.

DtSceneObject* makVrv::DtSymbolDecorationUpdater::mySceneObject

protected

Pointer to the scene object being updated.

DtAttributeGroupWidget* makVrv::DtSymbolDecorationUpdater::myAttributeGroupWidget

protected

The attribute group widget to update.

double makVrv::DtSymbolDecorationUpdater::myLastSymbolUpdateTime

protected

The last time the symbols were updated; used to slow down updating if once per frame is undesirable.

DecorationIdMap makVrv::DtSymbolDecorationUpdater::myDecorationIdMap

protected

Map of decoration id string -> label index.

---

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

• include/vrvCore/DtSymbolDecorationUpdater.h