makVrv::DtAttachableHatUpdater Class Reference

A DtAttachableHatUpdater updates a height above terrain (HAT) object that can be positioned in the scene by (possibly) attaching it to another object. More...

Inheritance diagram for makVrv::DtAttachableHatUpdater:

Public Member Functions
	DtAttachableHatUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtAttachableHatUpdater ()
	DTOR.
virtual void	update (double simTime)
	Update the scene object.
virtual void	setUseHighestTerrainLod (bool useHighest)
	Set whether the line is to currently visible terrain LOD or to highest available terrain LOD.
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 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() 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.
DtSceneObject *	findSceneObject ()
	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 DtVector &	updaterPosition (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 bool	useHighestTerrainLod () const
	Get whether line is to currently visible terrain LOD or to highest available terrain LOD.
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
DtVector	myLastTopPos
DtTaitBryan	myLastTopOri
bool	myUseHighestTerrainLod
Protected Attributes inherited from makVrv::DtAttachableUpdater
AttachedPointsVector	myAttachedPoints
DtVector	myPositionOffset
DtTaitBryan	myOrientationOffset
Protected Attributes inherited from makVrv::DtSceneObjectUpdater
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 updateSceneObject() was called.
DtSceneObject::TransformList	myTransforms
	Local copy of the vertex positions and orientations.
const DtDeSharedState &	myDeSharedState
	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 DtAttachableHatUpdater updates a height above terrain (HAT) object that can be positioned in the scene by (possibly) attaching it to another object.

The scene object's first transform is updated with the position indicated by the attachment, and its second transform is set to the position of the underlying terrain directly below the first transform.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtAttachableHatUpdater::~DtAttachableHatUpdater ( )

virtual

DTOR.

Member Function Documentation

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

virtual

Update the scene object.

virtual void makVrv::DtAttachableHatUpdater::setUseHighestTerrainLod ( bool  useHighest )

virtual

Set whether the line is to currently visible terrain LOD or to highest available terrain LOD.

virtual bool makVrv::DtAttachableHatUpdater::useHighestTerrainLod ( ) const

protectedvirtual

Get whether line is to currently visible terrain LOD or to highest available terrain LOD.

Member Data Documentation

DtVector makVrv::DtAttachableHatUpdater::myLastTopPos

protected

DtTaitBryan makVrv::DtAttachableHatUpdater::myLastTopOri

protected

bool makVrv::DtAttachableHatUpdater::myUseHighestTerrainLod

protected

---

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

• include/vrvCore/DtAttachableHatUpdater.h