Updater for the Kelvin wake model. More...

Inheritance diagram for makVrv::DtTritonWakeUpdater:

Public Member Functions
	DtTritonWakeUpdater (DtDe &de, DtUniqueID id)
	CTOR. More...

virtual	~DtTritonWakeUpdater ()
	Virtual DTOR. More...

virtual void	update (DtTime tNow)
	The update function called by DtTickableManager during update-ticks. More...

virtual bool	needsUpdate (DtTime tNow)
	Check if an update is required. More...

virtual void	setPosition (const DtVector &pos)
	Manually set the current position. More...

virtual void	setOrientation (const DtTaitBryan &ori)
	Manually set the current orientation. More...

virtual void	setIsAmphibious (bool isAmphibious)
	Set whether the wake needs to check to see if its over land. More...

Public Member Functions inherited from makVrv::DtWakeUpdater
	DtWakeUpdater (DtDe &de, DtUniqueID id)
	CTOR. More...

virtual	~DtWakeUpdater ()
	Virtual DTOR. More...

virtual DtTime	lastUpdateTime () const
	Get the time-stamp of the last update. More...

virtual void	setWakeModel (DtModel *wakeModel)
	Set the wake model to be updated. More...

DtUniqueID	uniqueId () const
	Returns the distributed object id of this updater. More...

virtual void	setLODDistance (double distance)

virtual void	setFrozen (bool froze)
	If an entity is in the frozen state, use 0 for velocity regardless of what it might send. 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 DtTritonWakeModel *	wakeModel () const
	Helper method to return a properly cast version of the wake model supplied. More...

virtual DtVector	calcWakeOriginAndSeaLevel (DtVector &currentPos, const DtTaitBryan &orientation, double wakeOffset)
	Calculate the origin of the wake and put currentPos at sea level. More...

virtual bool	getCurrentShipKinematics (double t, DtVector &position, DtVector &velocity, DtTaitBryan &orientation) const
	Get the ship's current position, velocity, and orientation that this wake is attached to More...

virtual bool	isLodedOut (const DtVector &currentPos) const
	internal function to determine if wake is lod'ed out More...

Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	CTOR. More...

	DtTickable ()
	Unimplemented default CTOR. More...

virtual void	slot_managerAboutToBeDeleted ()

Protected Attributes
bool	myFirstTick

DtDoubleSmoother	mySpeedSmoother

DtDoubleSmoother	myVelocityXSmoother

DtDoubleSmoother	myVelocityYSmoother

DtDoubleSmoother	myVelocityZSmoother

DtSceneObject *	myWakeModelSceneObject
	A pointer to the current scene object for the wake model. More...

bool	mySetManually

bool	myPositionUpdated

DtVector	myPosition

DtVector	myLastPosition

DtTaitBryan	myOrientation

bool	myIsAmphibious

Protected Attributes inherited from makVrv::DtWakeUpdater
DtDe &	myDe
	The display engine. More...

DtUniqueID	myUniqueId
	This distributed object's unique identifier. More...

DtModel *	myWakeModel
	A pointer to the current wake model being updated. More...

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

double	myLODDistance

bool	myFrozenFlag

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

Updater for the Kelvin wake model.

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

Constructor & Destructor Documentation

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

CTOR.

Parameters

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

virtual makVrv::DtTritonWakeUpdater::~DtTritonWakeUpdater ( )

virtual

Virtual DTOR.

Member Function Documentation

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

virtual

The update function called by DtTickableManager during update-ticks.

Parameters

[in] tNow is the current time-stamp.

Implements makVrv::DtWakeUpdater.

virtual bool makVrv::DtTritonWakeUpdater::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::DtTritonWakeUpdater::setPosition ( const DtVector & pos )

virtual

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 from makVrv::DtWakeUpdater.

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

virtual

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 from makVrv::DtWakeUpdater.

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

virtual

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

Reimplemented from makVrv::DtWakeUpdater.

virtual DtTritonWakeModel* makVrv::DtTritonWakeUpdater::wakeModel ( ) const

protectedvirtual

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

virtual DtVector makVrv::DtTritonWakeUpdater::calcWakeOriginAndSeaLevel	(	DtVector &	currentPos,
		const DtTaitBryan &	orientation,
		double	wakeOffset
	)

protectedvirtual

Calculate the origin of the wake and put currentPos at sea level.

These two operations are combined to avoid an extra geocentic-> geodetic conversion.

Parameters

[in]	currentPos	is the entity's position.
[in]	currentOrientation	is the entity's orientation.
[in]	wakeOffset	is offset of the wake start from the entity. center
[out]	currentPos	is modified to be at sea level

Returns: The position of the center of the circle used to generate a Kelvin wake effect.

virtual bool makVrv::DtTritonWakeUpdater::getCurrentShipKinematics	(	double	t,
		DtVector &	position,
		DtVector &	velocity,
		DtTaitBryan &	orientation
	)		const

protectedvirtual

Get the ship's current position, velocity, and orientation that this

wake is attached to

virtual bool makVrv::DtTritonWakeUpdater::isLodedOut ( const DtVector & currentPos ) const

protectedvirtual

internal function to determine if wake is lod'ed out

Member Data Documentation

bool makVrv::DtTritonWakeUpdater::myFirstTick

protected

DtDoubleSmoother makVrv::DtTritonWakeUpdater::mySpeedSmoother

protected

DtDoubleSmoother makVrv::DtTritonWakeUpdater::myVelocityXSmoother

protected

DtDoubleSmoother makVrv::DtTritonWakeUpdater::myVelocityYSmoother

protected

DtDoubleSmoother makVrv::DtTritonWakeUpdater::myVelocityZSmoother

protected

DtSceneObject* makVrv::DtTritonWakeUpdater::myWakeModelSceneObject

protected

A pointer to the current scene object for the wake model.

bool makVrv::DtTritonWakeUpdater::mySetManually

protected

bool makVrv::DtTritonWakeUpdater::myPositionUpdated

protected

DtVector makVrv::DtTritonWakeUpdater::myPosition

protected

DtVector makVrv::DtTritonWakeUpdater::myLastPosition

protected

DtTaitBryan makVrv::DtTritonWakeUpdater::myOrientation

protected

bool makVrv::DtTritonWakeUpdater::myIsAmphibious

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvTriton/DtTritonWakeUpdater.h

Public Member Functions

Protected Member Functions

wake is attached to

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

wake is attached to

Member Data Documentation