makVrv::DtTritonTidalStreamWakeUpdater Class Reference

Updater for the Kelvin tidalStreamWake model. More...

Inheritance diagram for makVrv::DtTritonTidalStreamWakeUpdater:

Public Member Functions
	DtTritonTidalStreamWakeUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtTritonTidalStreamWakeUpdater ()
	Virtual DTOR.
virtual bool	needsUpdate (DtTime tNow)
	Check if an update is required.
virtual void	update (DtTime tNow)
	The update function called by DtTickableManager during update-ticks.
Public Member Functions inherited from makVrv::DtTidalStreamWakeUpdater
	DtTidalStreamWakeUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtTidalStreamWakeUpdater ()
	Virtual DTOR.
virtual DtTime	lastUpdateTime () const
	Get the time-stamp of the last update.
virtual void	setTidalStreamWakeModel (DtModel *tidalStreamWakeModel)
	Set the tidalStreamWake model to be updated.
virtual void	setCurrentSpeed (double speed)
	In m/s.
virtual void	setCurrentDirection (double dir)
	In rad from North (clockwise).
DtUniqueID	uniqueId () const
	Returns the distributed object id of this updater.
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

Protected Member Functions
virtual DtTritonTidalStreamWakeModel *	tidalStreamWakeModel ()
	Helper method to return a properly cast version of the tidalStreamWake model supplied.
virtual DtVector	calcWakeDirection (const DtVector &currentPos, float radiansFromNorth)
	Calculate a normalized helo down vector.
virtual void	setTidalStreamWakesEnabled (bool enabled)
	Called when global tidal stream wakes enabled signal is received.

Protected Attributes
DtSignalConnectionManager	mySignals
bool	myTidalStreamWakesEnabled
Protected Attributes inherited from makVrv::DtTidalStreamWakeUpdater
DtDe &	myDe
	The display engine.
DtUniqueID	myUniqueId
	This distributed object's unique identifier.
DtModel *	myTidalStreamWakeModel
	A pointer to the current tidalStreamWake model being updated.
DtTime	myLastUpdateTime
	The last time stamp when the update() was called.
double	myCurrentSpeed
	In m/s. Only used to override global current speed.
double	myCurrentDirection
	In rad from North (clockwise). Only used for override.
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

Detailed Description

Updater for the Kelvin tidalStreamWake model.

DtTritonTidalStreamWakeUpdater is a distributed object, managed by DtTickableManager. It updates the position, direction and speed of an tidalStreamWake-generating entity

Constructor & Destructor Documentation

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

CTOR.

Parameters

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

virtual makVrv::DtTritonTidalStreamWakeUpdater::~DtTritonTidalStreamWakeUpdater ( )

virtual

Virtual DTOR.

Member Function Documentation

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

virtual

Check if an update is required.

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::DtTritonTidalStreamWakeUpdater::update ( DtTime  tNow )

virtual

The update function called by DtTickableManager during update-ticks.

Parameters

[in]

tNow

is the current time-stamp.

Implements makVrv::DtTidalStreamWakeUpdater.

virtual DtTritonTidalStreamWakeModel* makVrv::DtTritonTidalStreamWakeUpdater::tidalStreamWakeModel ( )

protectedvirtual

Helper method to return a properly cast version of the tidalStreamWake model supplied.

virtual DtVector makVrv::DtTritonTidalStreamWakeUpdater::calcWakeDirection ( const DtVector &  currentPos, float  radiansFromNorth  )

protectedvirtual

Calculate a normalized helo down vector.

virtual void makVrv::DtTritonTidalStreamWakeUpdater::setTidalStreamWakesEnabled ( bool  enabled )

protectedvirtual

Called when global tidal stream wakes enabled signal is received.

Member Data Documentation

DtSignalConnectionManager makVrv::DtTritonTidalStreamWakeUpdater::mySignals

protected

bool makVrv::DtTritonTidalStreamWakeUpdater::myTidalStreamWakesEnabled

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvTriton/DtTritonTidalStreamWakeUpdater.h