makVrv::DtArcUpdater Class Reference

DtArcUpdater is an updater that updates the orientation of arc. More...

Inheritance diagram for makVrv::DtArcUpdater:

Public Member Functions
	DtArcUpdater (makVrv::DtDe &de, makVrv::DtUniqueID id)
	CTOR. More...
virtual	~DtArcUpdater ()
	DTOR. More...
virtual void	update (double simTime)
	If origin or to point have changed, recalc orientation. More...
virtual void	setOrientationDelta (double)
virtual void	setPosition (int, const DtVector &)
	Sets positions of ellipse. More...
virtual void	setSceneObject (DtSceneObject *sceneObject)
	Set the scene object to be updated. More...
virtual bool	needsUpdate (DtTime tNow)
	The check function called by DtTickableManager to verify if an update is required. More...
virtual void	setUpdaterPosition (int vtx, const DtVector &pos)
	Set the position of a vertex. More...
virtual void	setUpdaterOrientation (int vtx, const DtTaitBryan &ori)
	Set the orientation of a vertex. More...
virtual void	setDynamicOrigin (bool)
	Sets whether or origin is set in the updater or retrieved from the scene object. More...
Public Member Functions inherited from makVrv::DtTickable
virtual bool	updateIfNeeded (DtTime tNow)
	Calls needsUpdate(), and then calls update() if needsUpdate() is true. More...
virtual void	update (DtTime tNow)=0
	The update function called by DtTickableManager during update-ticks. More...
virtual	~DtTickable ()
	Virtual DTOR. More...
virtual void	setIsThreadSafe (bool safe)
	Get/set whether this tickable can be updated in parallel with other tickables. More...
virtual bool	isThreadSafe () const
virtual void	setTickableListState (TickableListState safeList)
	Track which tickable list (if any) this tickable is on Since the tickable constructor puts ALL tickables on the main (unThreadSafe) to start we need a way to check which list a tickable is on (and this way we can request removals from the correct list instead of having to call DtTickableManager::removeTickableObject(), which tries both lists). More...
virtual TickableListState	tickableListState () const
virtual void	setUpdatePeriod (unsigned int period)
	Specify how often (in # of frames) this tickable should call update. More...
virtual unsigned int	updatePeriod () const
virtual bool	lodSystemEnabled () const
	is the update LOD system enabled, overridden by subclasses More...

Protected Member Functions
virtual DtTaitBryan	computeOrientation (const DtVector &pos, double topoHeading) const
	Computes orientation of the ellipse as level to terrain. More...
Signals
virtual void	slot_sceneObjectToBeDeleted (const DtUniqueID &id)
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	CTOR. More...
	DtTickable ()
	Unimplemented default CTOR. More...
virtual void	slot_managerAboutToBeDeleted ()

Protected Attributes
DtVector	myOrigin
double	myOrientationDelta
bool	mySceneObjectChanged
DtDe &	myDe
	The display engine. More...
DtUniqueID	myUniqueId
	This distributed object's unique identifier. More...
DtSceneObject *	mySceneObject
	A pointer to the current scene object. More...
boost::signalslib::connection	mySceneObjectConnection
DtSceneObject::TransformList	myTransforms
	Local copy of the vertex positions and orientations. More...
DtTime	myLastUpdateTime
DtTaitBryan	myInitialOrientation
bool	myDynamicOrigin
DtVector	myLastAnglePosition
DtVector	myDynamicOriginPosition
Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
	Pointer to manager for removal during destruction. More...
DtSignalConnectionManager	myConnections
unsigned int	myFrameCounter
unsigned int	myFrameToUpdate
unsigned int	myUpdatePeriod
DtTime	myLastUpdateTime
bool	myIsThreadSafe
TickableListState	myTickableListState

Private Member Functions
DtSceneObject::ObjectTransform &	getOrCreateTransform (int vtx)
	Helper function to get the transform at a given vertex. More...
	DtArcUpdater (const DtArcUpdater &)
	Copy Constructor not implemented – Copy not allowed. More...
DtArcUpdater &	operator= (const DtArcUpdater &)
	Assignment Operator not implemented – Copy not allowed. More...

Additional Inherited Members
Public Types inherited from makVrv::DtTickable
enum	TickableListState { TickableNotOnList, TickableOnMainList, TickableOnThreadSafeList }
	Enumeration used to indicate which DtTickableManager's tickable list the tickable is on, if any. More...

Detailed Description

DtArcUpdater is an updater that updates the orientation of arc.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtArcUpdater::~DtArcUpdater ( )

virtual

DTOR.

makVrv::DtArcUpdater::DtArcUpdater ( const DtArcUpdater &  )

private

Copy Constructor not implemented – Copy not allowed.

Member Function Documentation

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

virtual

If origin or to point have changed, recalc orientation.

virtual void makVrv::DtArcUpdater::setOrientationDelta ( double  )

virtual

virtual void makVrv::DtArcUpdater::setPosition ( int  , const DtVector &    )

virtual

Sets positions of ellipse.

Will update orientation and radii appropriately. Vector is considered in local coordinates

virtual void makVrv::DtArcUpdater::setSceneObject ( DtSceneObject *  sceneObject )

virtual

Set the scene object to be updated.

Parameters

[in]

sceneObject

is the scene object to receive updates.

virtual bool makVrv::DtArcUpdater::needsUpdate ( DtTime  tNow )

virtual

The check function called by DtTickableManager to verify if an update is required.

If this function returns true, the DtTickableManager will then call update().

Parameters

[in]

tNow

is the current time-stamp.

Return values

true	if this object needs to be ticked.
false	otherwise.

Reimplemented from makVrv::DtTickable.

virtual void makVrv::DtArcUpdater::setUpdaterPosition ( int  vtx, const DtVector &  pos  )

virtual

Set the position of a vertex.

Parameters

[in]	vtx	is the vertex.
[in]	pos	is the position to set.

virtual void makVrv::DtArcUpdater::setUpdaterOrientation ( int  vtx, const DtTaitBryan &  ori  )

virtual

Set the orientation of a vertex.

Parameters

[in]	vtx	is the vertex.
[in]	ori	is the orientation to set.

virtual void makVrv::DtArcUpdater::setDynamicOrigin ( bool  )

virtual

Sets whether or origin is set in the updater or retrieved from the scene object.

Default is false (retrieved from origin)

virtual DtTaitBryan makVrv::DtArcUpdater::computeOrientation ( const DtVector &  pos, double  topoHeading  ) const

protectedvirtual

Computes orientation of the ellipse as level to terrain.

virtual void makVrv::DtArcUpdater::slot_sceneObjectToBeDeleted ( const DtUniqueID &  id )

protectedvirtual

DtSceneObject::ObjectTransform& makVrv::DtArcUpdater::getOrCreateTransform ( int  vtx )

private

Helper function to get the transform at a given vertex.

If the vertex is above range, new transforms are created.

Parameters

[in]

vtx

is the vertex of the transform to get.

Returns

The transform at the given vertex.

Exceptions

DtCorruptedState

if vtx is less than zero.

DtArcUpdater& makVrv::DtArcUpdater::operator= ( const DtArcUpdater &  )

private

Assignment Operator not implemented – Copy not allowed.

Member Data Documentation

DtVector makVrv::DtArcUpdater::myOrigin

protected

double makVrv::DtArcUpdater::myOrientationDelta

protected

bool makVrv::DtArcUpdater::mySceneObjectChanged

protected

DtDe& makVrv::DtArcUpdater::myDe

protected

The display engine.

DtUniqueID makVrv::DtArcUpdater::myUniqueId

protected

This distributed object's unique identifier.

DtSceneObject* makVrv::DtArcUpdater::mySceneObject

protected

A pointer to the current scene object.

boost::signalslib::connection makVrv::DtArcUpdater::mySceneObjectConnection

protected

DtSceneObject::TransformList makVrv::DtArcUpdater::myTransforms

protected

Local copy of the vertex positions and orientations.

These are typically pre-calculated, and then pushed to the scene object at a later time, making the concatenation of updaters simpler.

DtTime makVrv::DtArcUpdater::myLastUpdateTime

protected

DtTaitBryan makVrv::DtArcUpdater::myInitialOrientation

protected

bool makVrv::DtArcUpdater::myDynamicOrigin

protected

DtVector makVrv::DtArcUpdater::myLastAnglePosition

protected

DtVector makVrv::DtArcUpdater::myDynamicOriginPosition

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/DtArcUpdater.h