makVrv::DtHeadingLineUpdater Class Reference

DtHeadingLineUpdater updates symbol decorations with distributed side data. More...

Inheritance diagram for makVrv::DtHeadingLineUpdater:

Public Member Functions
	DtHeadingLineUpdater (DtDe &de, DtUniqueID id)
	CTOR. More...
virtual	~DtHeadingLineUpdater ()
	DTOR. More...
virtual void	update (DtTime tNow)
	update the symbol decorations More...
virtual bool	needsUpdate (DtTime tNow)
	The check function called by DtTickableManager to verify if an update is required. More...
virtual void	setSceneObject (DtSceneObject *sceneObject)
	sets the scene object to update via the id. More...
virtual void	attachDirectionLineModel (DtUniqueID id)
	attach a heading line model (DtOverlayDirectionLineModel) to update (referenced by its unique ID) 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	~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 void	slot_sceneObjectDeleted (DtUniqueID id)
	Called when the referenced scene object is deleted. More...
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	CTOR. More...
	DtTickable ()
	Unimplemented default CTOR. More...
virtual void	slot_managerAboutToBeDeleted ()

Protected Attributes
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...
DtOverlayDirectionLineModel *	myLineModel
	The model to update. More...
double	myLastSymbolUpdateTime
	The last time the symbols were updated; used to slow down updating if once per frame is undesirable. More...
DtTime	myLastUpdateTime
	The last time update was called. More...
DtSignalConnectionManager	mySignals
	Signal manager to auto disconnect boost signals. More...
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

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

DtHeadingLineUpdater updates symbol decorations with distributed side data.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtHeadingLineUpdater::~DtHeadingLineUpdater ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtHeadingLineUpdater::update ( DtTime  tNow )

virtual

update the symbol decorations

Implements makVrv::DtTickable.

virtual bool makVrv::DtHeadingLineUpdater::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::DtHeadingLineUpdater::setSceneObject ( DtSceneObject *  sceneObject )

virtual

sets the scene object to update via the id.

virtual void makVrv::DtHeadingLineUpdater::attachDirectionLineModel ( DtUniqueID  id )

virtual

attach a heading line model (DtOverlayDirectionLineModel) to update (referenced by its unique ID)

virtual void makVrv::DtHeadingLineUpdater::slot_sceneObjectDeleted ( DtUniqueID  id )

protectedvirtual

Called when the referenced scene object is deleted.

Member Data Documentation

DtDe& makVrv::DtHeadingLineUpdater::myDe

protected

The display engine.

DtUniqueID makVrv::DtHeadingLineUpdater::myUniqueId

protected

This distributed object's unique identifier.

DtSceneObject* makVrv::DtHeadingLineUpdater::mySceneObject

protected

A pointer to the current scene object.

DtOverlayDirectionLineModel* makVrv::DtHeadingLineUpdater::myLineModel

protected

The model to update.

double makVrv::DtHeadingLineUpdater::myLastSymbolUpdateTime

protected

The last time the symbols were updated; used to slow down updating if once per frame is undesirable.

DtTime makVrv::DtHeadingLineUpdater::myLastUpdateTime

protected

The last time update was called.

DtSignalConnectionManager makVrv::DtHeadingLineUpdater::mySignals

protected

Signal manager to auto disconnect boost signals.

---

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

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