makVrv::DtWakeUpdater Class Reference

Abstract wake object updater interface. More...

Inheritance diagram for makVrv::DtWakeUpdater:

Public Member Functions
	DtWakeUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtWakeUpdater ()
	Virtual DTOR.
virtual void	update (DtTime tNow)=0
	The update function called by DtTickableManager during update-ticks.
virtual DtTime	lastUpdateTime () const
	Get the time-stamp of the last update.
virtual void	setWakeModel (DtModel *wakeModel)
	Set the wake model to be updated.
DtUniqueID	uniqueId () const
	Returns the distributed object id of this updater.
virtual void	setPosition (const DtVector &pos)
	Manually set the current position.
virtual void	setOrientation (const DtTaitBryan &ori)
	Manually set the current orientation.
virtual void	setIsAmphibious (bool isAmphibious)
	Set whether the wake needs to check to see if its over land.
virtual void	setLODDistance (double distance)
Public Member Functions inherited from makVrv::DtTickable
virtual bool	needsUpdate (DtTime tNow)
	The check function called by DtTickableManager to verify if an update is required.
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

Protected Attributes
DtDe &	myDe
	The display engine.
DtUniqueID	myUniqueId
	This distributed object's unique identifier.
DtModel *	myWakeModel
	A pointer to the current wake model being updated.
DtTime	myLastUpdateTime
	The last time stamp when the update() was called.
double	myLODDistance
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
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	CTOR.
	DtTickable ()
	Unimplemented default CTOR.
virtual void	slot_managerAboutToBeDeleted ()

Detailed Description

Abstract wake object updater interface.

DtWakeUpdaters are distributed objects, managed by DtTickableManager. They update the wake of DtWakeModels

Constructor & Destructor Documentation

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

CTOR.

Parameters

[in]	de	is the display engine.
[in]	id	is a unique identifier for this distributed object.

virtual makVrv::DtWakeUpdater::~DtWakeUpdater ( )

virtual

Virtual DTOR.

Member Function Documentation

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

pure virtual

The update function called by DtTickableManager during update-ticks.

Parameters

[in]

tNow

is the current time-stamp.

Note

Derived classes should update the wake at the end of their implementation of this function.

Implements makVrv::DtTickable.

Implemented in makVrv::DtTritonWakeUpdater.

virtual DtTime makVrv::DtWakeUpdater::lastUpdateTime ( ) const

virtual

Get the time-stamp of the last update.

Returns

The last update time.

virtual void makVrv::DtWakeUpdater::setWakeModel ( DtModel *  wakeModel )

virtual

Set the wake model to be updated.

Parameters

[in]

wakeModel

is a pointer to the model to be updated

DtUniqueID makVrv::DtWakeUpdater::uniqueId ( ) const

inline

Returns the distributed object id of this updater.

virtual void makVrv::DtWakeUpdater::setPosition ( const DtVector &  pos )

inlinevirtual

Manually set the current position.

Parameters

[in]

pos

is the position to set.

Note

Only used when ships kinematics cannot be found, such as when creating a wake as a separate entity.

See Also

getCurrentShipKinematics()

Reimplemented in makVrv::DtTritonWakeUpdater.

virtual void makVrv::DtWakeUpdater::setOrientation ( const DtTaitBryan &  ori )

inlinevirtual

Manually set the current orientation.

Parameters

[in]

ori

is the orientation to set.

Note

Only used when ships kinematics cannot be found, such as when creating a wake as a separate entity.

See Also

getCurrentShipKinematics()

Reimplemented in makVrv::DtTritonWakeUpdater.

virtual void makVrv::DtWakeUpdater::setIsAmphibious ( bool  isAmphibious )

inlinevirtual

Set whether the wake needs to check to see if its over land.

Reimplemented in makVrv::DtTritonWakeUpdater.

virtual void makVrv::DtWakeUpdater::setLODDistance ( double  distance )

virtual

Member Data Documentation

DtDe& makVrv::DtWakeUpdater::myDe

protected

The display engine.

DtUniqueID makVrv::DtWakeUpdater::myUniqueId

protected

This distributed object's unique identifier.

DtModel* makVrv::DtWakeUpdater::myWakeModel

protected

A pointer to the current wake model being updated.

DtTime makVrv::DtWakeUpdater::myLastUpdateTime

protected

The last time stamp when the update() was called.

double makVrv::DtWakeUpdater::myLODDistance

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrvCore/DtWakeUpdater.h