VR-Forces 4.1 Class Documentation
List of all members | Classes | Public Member Functions | Protected Member Functions | Protected Attributes
exampleRangeLine::DtAttachableRangeTextUpdater Class Reference

A DtAttachableRangeTextUpdater is used to update a text widget with a range between two points (fixed or attached) More...

Inheritance diagram for exampleRangeLine::DtAttachableRangeTextUpdater:
Inheritance graph
[legend]

Classes

struct  RangePointInformation
 If id is non-zero, will try and use that, else will use the position. More...

Public Member Functions

 DtAttachableRangeTextUpdater (makVrv::DtDe &de, makVrv::DtUniqueID id)
 CTOR.
virtual ~DtAttachableRangeTextUpdater ()
 DTOR.
virtual void update (double simTime)
 Update the scene object.
virtual void setRangeFrom (makVrv::DtUniqueID fromID)
 If attached (from), sets the from point.
virtual void setRangeFrom (const DtVector &fromPoint)
 If not attached, sets the from position.
virtual void setRangeTo (makVrv::DtUniqueID toID)
 If attached, sets the to point.
virtual void setRangeTo (const DtVector &toPoint)
 If not attached, sets the to position.
virtual void updateWidgetLabel (makVrv::DtWidgetLabel *widgetLabel, double distanceInMeters)
virtual DtVector position (const RangePointInformation &, double simTime) const
 Returns position from information.
- 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 cleanup (RangePointInformation &, bool isFrom)
virtual void slot_attachedUpdaterToBeDeleted (const makVrv::DtUniqueID &id, bool isFrom)
virtual void slot_attachedSceneObjectToBeDeleted (const makVrv::DtUniqueID &id, bool isFrom)
- 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.

Protected Attributes

RangePointInformation myRangeFrom
RangePointInformation myRangeTo
- Protected Attributes inherited from makVrv::DtAttachableUpdater
AttachedPointsVector myAttachedPoints
DtVector myPositionOffset
DtTaitBryan myOrientationOffset
- Protected Attributes inherited from makVrv::DtSceneObjectUpdater
DtDemyDe
 The display engine.
DtUniqueID myUniqueId
 This distributed object's unique identifier.
DtSceneObjectmySceneObject
 A pointer to the current scene object being updated.
DtTime myLastUpdateTime
 The last time stamp when the updateSceneObject() was called.
DtSceneObject::TransformList myTransforms
 Local copy of the vertex positions and orientations.
const DtDeSharedStatemyDeSharedState
 This is kept to make terrain scale updating cheaper ( by one virtual function call ).
bool myInManager
 If tick was suppressed, then this updater is not on the tickableManager.

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

Detailed Description

A DtAttachableRangeTextUpdater is used to update a text widget with a range between two points (fixed or attached)

Constructor & Destructor Documentation

exampleRangeLine::DtAttachableRangeTextUpdater::DtAttachableRangeTextUpdater ( makVrv::DtDe de,
makVrv::DtUniqueID  id 
)

CTOR.

virtual exampleRangeLine::DtAttachableRangeTextUpdater::~DtAttachableRangeTextUpdater ( )
virtual

DTOR.

Member Function Documentation

virtual void exampleRangeLine::DtAttachableRangeTextUpdater::update ( double  simTime)
virtual

Update the scene object.

virtual void exampleRangeLine::DtAttachableRangeTextUpdater::setRangeFrom ( makVrv::DtUniqueID  fromID)
virtual

If attached (from), sets the from point.

virtual void exampleRangeLine::DtAttachableRangeTextUpdater::setRangeFrom ( const DtVector fromPoint)
virtual

If not attached, sets the from position.

virtual void exampleRangeLine::DtAttachableRangeTextUpdater::setRangeTo ( makVrv::DtUniqueID  toID)
virtual

If attached, sets the to point.

virtual void exampleRangeLine::DtAttachableRangeTextUpdater::setRangeTo ( const DtVector toPoint)
virtual

If not attached, sets the to position.

virtual void exampleRangeLine::DtAttachableRangeTextUpdater::updateWidgetLabel ( makVrv::DtWidgetLabel widgetLabel,
double  distanceInMeters 
)
virtual
virtual DtVector exampleRangeLine::DtAttachableRangeTextUpdater::position ( const RangePointInformation ,
double  simTime 
) const
virtual

Returns position from information.

virtual void exampleRangeLine::DtAttachableRangeTextUpdater::cleanup ( RangePointInformation ,
bool  isFrom 
)
protectedvirtual
virtual void exampleRangeLine::DtAttachableRangeTextUpdater::slot_attachedUpdaterToBeDeleted ( const makVrv::DtUniqueID id,
bool  isFrom 
)
protectedvirtual
virtual void exampleRangeLine::DtAttachableRangeTextUpdater::slot_attachedSceneObjectToBeDeleted ( const makVrv::DtUniqueID id,
bool  isFrom 
)
protectedvirtual

Member Data Documentation

RangePointInformation exampleRangeLine::DtAttachableRangeTextUpdater::myRangeFrom
protected
RangePointInformation exampleRangeLine::DtAttachableRangeTextUpdater::myRangeTo
protected

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)