A DtAttachableHatTextUpdater is used to update a HAT text object that can be positioned in the scene by (possibly) attaching it to another object. More...

Inheritance diagram for makVrv::DtAttachableHatTextUpdater:

[legend]

Public Member Functions
	DtAttachableHatTextUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtAttachableHatTextUpdater ()
	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.
virtual bool	useHighestTerrainLod () const
	Get whether line is to currently visible terrain LOD or to highest available terrain LOD.
virtual void	setTextProportion (double proportion)
	The location along the HAT line, from 0 (top) to 1 (bottom)
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	setWorldPositionOffset (const DtVector &offset)
	positionally offset the specific attach point by this amount in world (database) coordinates.
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	setWorldOrientationOffset (const DtTaitBryan &offset)
	rotationally offset the attach points by this amount in world (database) coordinates
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.
virtual void	setUpdatePeriod (unsigned int period)
	Specify how often (in # of frames) this tickable should call update.
virtual unsigned int	updatePeriod () const
	Specify how often (in # of frames) this tickable should call update.

Protected Member Functions
virtual void	updateWidgetLabel (DtWidgetLabel *widgetLabel, double distanceInMeters)
	Update the text in the widget label.
virtual DtVector	findIntersect (const DtVector &start, const DtVector &up)
	Attempt a terrain intersection.
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.
virtual void	slot_managerAboutToBeDeleted ()

Protected Attributes
DtVector	myLastTopPos
DtTaitBryan	myLastTopOri
bool	myUseHighestTerrainLod
double	myTextProportion
DtVector	myTextOffset
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
DtVector	myWorldPositionOffset
DtTaitBryan	myWorldOrientationOffset
Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
	Pointer to manager for removal during destruction.
DtSignalConnectionManager	myConnections
unsigned int	myFrameCounter
unsigned int	myFrameToUpdate
unsigned int	myUpdatePeriod

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

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 DtWidgetLabel 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::setUseHighestTerrainLod ( bool useHighest )

virtual

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

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

virtual

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

virtual void makVrv::DtAttachableHatTextUpdater::setTextProportion ( double proportion )

virtual

The location along the HAT line, from 0 (top) to 1 (bottom)

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

protectedvirtual

Update the text in the widget label.

virtual DtVector makVrv::DtAttachableHatTextUpdater::findIntersect	(	const DtVector &	start,
		const DtVector &	up
	)

protectedvirtual

Attempt a terrain intersection.

Note that isect will always be filled in. If start is below sea level, the point at sea level will be returned. If above sea level, an intersection will be attempted. If it fails, isect will be filled in with start. If it succeeds, doIntersect will check for a dynamic ocean layer. If one exists and the intersection is below it, the point at sea level is returned.

Member Data Documentation

DtVector makVrv::DtAttachableHatTextUpdater::myLastTopPos

protected

DtTaitBryan makVrv::DtAttachableHatTextUpdater::myLastTopOri

protected

bool makVrv::DtAttachableHatTextUpdater::myUseHighestTerrainLod

protected

double makVrv::DtAttachableHatTextUpdater::myTextProportion

protected

DtVector makVrv::DtAttachableHatTextUpdater::myTextOffset

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrvCore/DtAttachableHatTextUpdater.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation