makVrv::DtTritonTidalStreamWakeUpdater Class Reference

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

Inheritance diagram for makVrv::DtTritonTidalStreamWakeUpdater:

Public Member Functions
	DtTritonTidalStreamWakeUpdater (DtDe &de, DtUniqueID id)
virtual	~DtTritonTidalStreamWakeUpdater ()
virtual bool	needsUpdate (DtTime tNow)
virtual void	update (DtTime tNow)
Public Member Functions inherited from makVrv::DtTidalStreamWakeUpdater
	DtTidalStreamWakeUpdater (DtDe &de, DtUniqueID id)
virtual	~DtTidalStreamWakeUpdater ()
virtual DtTime	lastUpdateTime () const
virtual void	setTidalStreamWakeModel (DtModel *tidalStreamWakeModel)
virtual void	setCurrentSpeed (double speed)
virtual void	setCurrentDirection (double dir)
DtUniqueID	uniqueId () const
Public Member Functions inherited from makVrv::DtTickable
virtual bool	updateIfNeeded (DtTime tNow)
virtual	~DtTickable ()
virtual void	setIsThreadSafe (bool safe)
virtual bool	isThreadSafe () const
virtual void	setTickableListState (TickableListState safeList)
virtual TickableListState	tickableListState () const
virtual void	setUpdatePeriod (unsigned int period)
virtual unsigned int	updatePeriod () const
virtual bool	lodSystemEnabled () const

Protected Member Functions
virtual DtTritonTidalStreamWakeModel *	tidalStreamWakeModel ()
virtual DtVector	calcWakeDirection (const DtVector &currentPos, float radiansFromNorth)
virtual void	setTidalStreamWakesEnabled (bool enabled)
virtual void	slot_coordinateSystemChanged ()
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	DtTickable ()
virtual void	slot_managerAboutToBeDeleted ()

Protected Attributes
DtSignalConnectionManager	myConnections
bool	myTidalStreamWakesEnabled
DtCoordinateConverter *	myCoordinateConverter = nullptr
Protected Attributes inherited from makVrv::DtTidalStreamWakeUpdater
DtDe &	myDe
DtUniqueID	myUniqueId
DtModel *	myTidalStreamWakeModel
DtTime	myLastUpdateTime
double	myCurrentSpeed
double	myCurrentDirection
Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
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 }

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.

virtual void makVrv::DtTritonTidalStreamWakeUpdater::slot_coordinateSystemChanged ( )

protectedvirtual

slot for when the coordinate system changes

Member Data Documentation

DtSignalConnectionManager makVrv::DtTritonTidalStreamWakeUpdater::myConnections

protected

bool makVrv::DtTritonTidalStreamWakeUpdater::myTidalStreamWakesEnabled

protected

DtCoordinateConverter* makVrv::DtTritonTidalStreamWakeUpdater::myCoordinateConverter = nullptr

protected

local clone of the current system wide coordinate system converter. for thread safety.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvTriton/DtTritonTidalStreamWakeUpdater.h