makVrv::DtAttachableHatTextUpdater Class Reference

A DtAttachableHatTextUpdater is used to update a HAT text object that can be positioned in the scene by (possibly) attaching it to another object This updater extends the usual updater paradigm in that it not only positions the object, but also calculates and sets the actual HAT text. More...

Inheritance diagram for makVrv::DtAttachableHatTextUpdater:

Public Member Functions
	DtAttachableHatTextUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtAttachableHatTextUpdater ()
	DTOR.
virtual void	update (double simTime)
	Update the scene object.
Public Member Functions inherited from makVrv::DtAttachableUpdater
	DtAttachableUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtAttachableUpdater ()
	DTOR.
virtual bool	needsUpdate (DtTime tNow)
	Does this updater need to update?
virtual void	addAttachedPoint (const DtVector &position, int targetVertexIndex)
	Add a (vertex) attach point.
virtual void	addAttachedPoint (DtUniqueID uniqueID, int targetVertexIndex)
	Add a (object) attach point.
virtual void	addAttachedPoint (DtUniqueID uniqueID, int vtx1, int vtx2, double proportion, int targetVertexIndex)
	Add a (linear) attach point.
virtual const AttachedPoint &	attachedPoint (int targetVertexIndex) const
	Returns the attached point at the given vertex.
virtual void	setPositionOffset (const DtVector &offset)
	positionally offset the attach points by this amount.
virtual void	setPositionOffset (const DtVector &offset, int vtx)
	positionally offset the specific attach point by this amount.
virtual void	setOrientationOffset (const DtTaitBryan &offset)
	rotationally offset the attach points by this amount.
virtual void	setAttachedPointMode (unsigned int mode, int vtx)
	Set whether an attached point updates position, orientation, or both.
virtual void	update (DtTime tNow)
	Calls doAttachment()
virtual void	setSceneObject (DtSceneObject *sceneObject)
	Set the scene object to be updated.
virtual void	doAttachment (DtTime tNow)
	Find the actual position and orientation based on the attach points and offsets.
DtTime	lastUpdateTime () const
Public Member Functions inherited from makVrv::DtTickable
virtual	~DtTickable ()
	Virtual DTOR.

Protected Member Functions
virtual void	updateWidgetLabel (DtWidgetLabel *widgetLabel, double distanceInMeters)
	Update the text in the widget label.
Protected Member Functions inherited from makVrv::DtAttachableUpdater
virtual bool	pointLocationAndOrientation (AttachedPoint *point, double simTime, DtVector &location, DtTaitBryan &orientation)
virtual void	removeAttachedPoint (int vtx, DtVector *positionOffset=0)
	Returns current position offset in supplied pointer.
virtual void	slot_sceneObjectToBeDeleted (const DtUniqueID &id)
virtual void	slot_attachedSceneObjectToBeDeleted (const DtUniqueID &)
virtual void	slot_attachedUpdaterToBeDeleted (const DtUniqueID &id)
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	CTOR.
	DtTickable ()
	Unimplemented default CTOR.

Additional Inherited Members
Public Types inherited from makVrv::DtAttachableUpdater
enum	AttachedPointType {   AttachedPointTypeVertex, AttachedPointTypeObject, AttachedPointTypeProportional, AttachedPointTypeDeprecatedObject,   AttachedPointTypeInvalidObject }
	Types of attachments. More...
enum	AttachedPointMode { AttachedPointModePositionAndOrientation, AttachedPointModePositionOnly, AttachedPointModeOrientationOnly }
Protected Types inherited from makVrv::DtAttachableUpdater
typedef std::vector < AttachedPoint * >	AttachedPointsVector
Protected Attributes inherited from makVrv::DtAttachableUpdater
DtDe &	myDe
	The display engine.
DtUniqueID	myUniqueId
	This distributed object's unique identifier.
DtSceneObject *	mySceneObject
	A pointer to the current scene object being updated.
DtTime	myLastUpdateTime
	The last time stamp when the update()
AttachedPointsVector	myAttachedPoints
DtVector	myPositionOffset
DtTaitBryan	myOrientationOffset

Detailed Description

A DtAttachableHatTextUpdater is used to update a HAT text object that can be positioned in the scene by (possibly) attaching it to another object This updater extends the usual updater paradigm in that it not only positions the object, but also calculates and sets the actual HAT text.

To do so, the scene object must have a model of type DtProjectedTextModel in its model list.

Constructor & Destructor Documentation

makVrv::DtAttachableHatTextUpdater::DtAttachableHatTextUpdater	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtAttachableHatTextUpdater::~DtAttachableHatTextUpdater ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtAttachableHatTextUpdater::update ( double  simTime )

virtual

Update the scene object.

virtual void makVrv::DtAttachableHatTextUpdater::updateWidgetLabel ( DtWidgetLabel *  widgetLabel, double  distanceInMeters  )

protectedvirtual

Update the text in the widget label.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtAttachableHatTextUpdater.h