VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Protected Member Functions
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:
Inheritance graph
[legend]

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, bool suppressTick=false)
 CTOR.
virtual ~DtAttachableUpdater ()
 DTOR.
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 AttachedPointattachedPoint (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() followed by updateSceneObject()
virtual void doAttachment (DtTime tNow)
 Find the actual position and orientation based on the attach points and offsets.
- Public Member Functions inherited from makVrv::DtSceneObjectUpdater
 DtSceneObjectUpdater (DtDe &de, DtUniqueID id, bool suppressTick=false)
 CTOR.
virtual ~DtSceneObjectUpdater ()
 Virtual DTOR.
virtual bool needsUpdate (DtTime tNow)
 The check function called by DtTickableManager to verify if an update is required.
virtual DtTime lastUpdateTime () const
 Get the time-stamp of the last update.
virtual void setSceneObject (DtSceneObject *sceneObject)
 Set the scene object to be updated.
DtSceneObjectfindSceneObject ()
 Get the current scene object for this updater.
DtUniqueID uniqueId () const
 Returns the distributed object id of this updater.
virtual void setUpdaterPosition (int vtx, const DtVector &pos)
 Set the position of a scene object vertex.
virtual const DtVectorupdaterPosition (int vtx) const
 Get the position of a scene object vertex.
virtual void setUpdaterOrientation (int vtx, const DtTaitBryan &ori)
 Set the orientation of a scene object vertex.
virtual const DtTaitBryan & updaterOrientation (int vtx) const
 Get the orientation of a scene object vertex.
void updateSceneObject (DtTime tNow)
 Update the scene object position and orientation at each vertex and set the last updated time-stamp.
virtual void terrainScaleTransformsIfNeeded ()
 Scales the transforms if the terrain scaling flag is set.

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 void slot_attachedSceneObjectToBeDeleted (const DtUniqueID &)
virtual void slot_attachedUpdaterToBeDeleted (const DtUniqueID &id)
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.
- Protected Member Functions inherited from makVrv::DtSceneObjectUpdater
virtual void slot_sceneObjectToBeDeleted (const DtUniqueID &id)
 Signal that this updater is being destroyed.

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 }
- Public Attributes inherited from makVrv::DtSceneObjectUpdater
boost::signal< void(const
DtUniqueID &) > 
signal_updaterToBeDeleted
 Signal that this updater is being destroyed.
- Protected Types inherited from makVrv::DtAttachableUpdater
typedef std::vector
< AttachedPoint * > 
AttachedPointsVector
- Protected Attributes inherited from makVrv::DtAttachableUpdater
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:

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)