A DtCigiWakeEntity is a CIGI entity that loads an wake model.

Inheritance diagram for makVrv::DtCigiWakeEntity:

Public Member Functions
	DtCigiWakeEntity (DtCigiConnection &connection, DtAgentManagerInterface &sceneInterface, int entityId, int entityType)

virtual	~DtCigiWakeEntity ()

virtual void	uninit ()

virtual void	setPosition (const DtGeodeticCoord &pos, bool force=false)

virtual void	setRelativePosition (const DtVector &pos)

virtual void	setOrientation (const DtTaitBryan &orient, bool force=false)

virtual void	setRelativeOrientation (const DtTaitBryan &orient)

virtual void	setRelativeTo (DtCigiBaseEntity *parent)

virtual void	setLinearRate (const DtVector &rate, bool useWorldCoordinates, bool force=false)

virtual void	setSprayEnabled (bool enabled)

virtual void	setWakeOffset (double offset)

virtual void	setBowSprayOffset (double offset)

virtual void	setBowWaveOffset (double offset)

virtual void	setSternWaveOffset (double offset)

virtual void	setShipLength (double length)

virtual void	setBeamWidth (double width)

virtual void	setPropWashEnabled (bool b)

virtual void	setPropWashOffset (double offset)

virtual void	setPropWashFadeTime (double fadeTime)

virtual void	setDraft (double draft)

virtual void	setLODDistance (double distance)

virtual void	setSprayVelocityScale (double scale)

virtual void	setBowWaveScale (double scale)

virtual void	setMaxBowWaveAmplitude (double amplitude)

virtual void	setBowSize (double size)

virtual void	setSpraySizeScale (double scale)

virtual void	setNumHullSprays (int numSprays)

virtual void	setHullSpraySizeScale (double scale)

virtual void	setHullSprayStart (double offset)

virtual void	setHullSprayEnd (double offset)

virtual void	setHullSprayVelocityScale (double scale)

virtual void	setHullSprayVerticalOffset (double offset)

virtual void	setVisible (bool isVisible)

virtual void	setIsSinking (bool sinking)

Public Member Functions inherited from makVrv::DtCigiBaseEntity
	DtCigiBaseEntity (DtCigiConnection &connection, DtAgentManagerInterface &sceneInterface, int entityId, int entityType)

virtual	~DtCigiBaseEntity ()

virtual DtUniqueID	uniqueId () const

virtual DtUniqueID	elementId () const

virtual int	cigiId () const

virtual void	init ()

virtual void	restart ()

virtual void	restartRequest ()

virtual int	entityType () const

virtual bool	extendedEntityTypeOn () const

virtual void	setExtendedEntityTypeOn (bool onOff)

virtual void	setExtendedEntityType (DtEntityType &entityType)

virtual bool	isVisible () const

virtual void	setDeadReckoningOn (bool onOff)

virtual bool	isDeadReckoning () const

virtual const DtGeodeticCoord &	position () const

virtual const DtGeodeticCoord &	previousPosition () const

virtual const DtVector &	localPosition () const

virtual const DtTaitBryan &	orientation () const

virtual const DtTaitBryan &	localOrientation () const

virtual const DtTaitBryan &	geocentricOrientation () const

virtual const DtVector &	linearRate () const

virtual void	setAngularRate (const DtVector &rate, bool useWorldCoordinates, bool force=false)

virtual const DtVector &	angularRate () const

virtual void	slot_deadReckoningAllowed (bool allowed)

virtual void	slot_smoothingChanged (bool enabled)

virtual void	slot_smoothingPeriodChanged (float period)

virtual void	setAlpha (int alpha)

virtual int	alpha () const

virtual void	setInheritAlpha (bool inherit)

virtual bool	isInheritingAlpha () const

virtual void	slot_alphaChanged (int alpha, DtUniqueID id)

virtual void	slot_entityToBeDeleted (int cigiEntityId)

virtual void	setGroundClampingOn (DtGroundClampingUpdater::GroundClampingMode clampType)

virtual DtGroundClampingUpdater::GroundClampingMode	groundClampingType () const

virtual void	setArtPartTranslation (int partId, float xOffset, float yOffset, float zOffset, bool xEnable, bool yEnable, bool zEnable)

virtual bool	getArtPartTranslation (int partId, DtVector &translation)

virtual void	setArtPartOrientation (int partId, float yaw, float pitch, float roll, bool yawEnable, bool pitchEnable, bool rollEnable)

virtual bool	getArtPartOrientation (int partId, DtTaitBryan &orientation)

virtual void	setArtPartLinearRate (int partId, float xRate, float yRate, float zRate)

virtual bool	getArtPartLinearRate (int partId, DtVector &rate)

virtual bool	getArtPartTranslationAndRate (int partId, DtVector &translation, DtVector &rate)

virtual void	setArtPartAngularRate (int partId, float yawRate, float pitchRate, float rollRate)

virtual bool	getArtPartAngularRate (int partId, DtVector &rate)

virtual bool	getArtPartOrientationAndRate (int partId, DtTaitBryan &orientation, DtVector &rate)

virtual void	setArtPartEnable (int partId, bool trueFalse)

virtual DtSceneObjectAgent *	findSceneObjectAgent ()

virtual bool	isEmbarked () const

virtual int	embarkedParentId () const

virtual const DtVector &	relativePosition () const

virtual const DtTaitBryan &	relativeOrientation () const

virtual void	addCollisionSegmentID (unsigned int segmentId)

virtual void	removeCollisionSegmentID (unsigned int segmentId)

virtual void	delayedStartEmbarked ()

Protected Member Functions
virtual void	addToParent (DtSceneObjectAgent *parent)

virtual void	removeFromParent (DtSceneObjectAgent *parent)

virtual void	createModelAgents ()

virtual void	destroyModelAgents ()

virtual void	slot_wakeDefaultLODDistanceChanged (double distance)

virtual void	slot_wakesEnabledChanged (bool enabled)

Protected Member Functions inherited from makVrv::DtCigiBaseEntity
virtual void	startDeadReckoning ()

virtual void	endDeadReckoning ()

virtual void	startEmbarked ()

virtual void	endEmbarked ()

virtual void	startGroundClamping ()

virtual void	buildGroundClampingUpdater ()

virtual void	endGroundClamping ()

virtual bool	isGroundClamping () const

virtual void	getExtrapolatedValuesAndRestart ()

virtual void	queryExtrapolatedPositionAndOrientation (DtUniqueID drAgentId, bool relative)

virtual void	returnExtrapolatedPositionAndOrientation (const DtVector &resultPos, const DtTaitBryan &resultOri, bool relative, bool invokeRestart)

virtual DtDeadReckonUpdater *	findDRUpdaterInRenderThread (DtUniqueID drAgentId) const

Protected Attributes
DtWakeModelAgent *	myWakeModelAgent

DtWakeUpdaterAgent *	myWakeUpdaterAgent

DtSignalConnectionManager	myConnections

boost::signalslib::connection	myWakeLODDistanceChangedConnection

bool	myIsSinking

double	myWakeLODRange

Protected Attributes inherited from makVrv::DtCigiBaseEntity
DtSceneObjectAgent *	mySceneObject

DtModelAgent *	myModel

std::string	myEntityModelDefName

DtDeadReckonUpdaterAgent *	myDeadReckonUpdaterAgent

DtGroundClampingUpdaterAgent *	myGroundClampingUpdaterAgent

DtEmbarkationUpdaterAgent *	myEmbarkationUpdaterAgent

bool	myDeadReckoningOn

bool	myEmbarked

DtGroundClampingUpdater::GroundClampingMode	myGroundClampingType

DtGeodeticCoord	myLastPosition

DtVector	myLastLocalPosition

DtTaitBryan	myLastOrientation

DtTaitBryan	myLastLocalOrientation

DtTaitBryan	myLastGeocentricOrientation

DtVector	myLastRelativePosition

DtTaitBryan	myLastRelativeOrientation

DtVector	myLastVelocity

bool	myLastVelocityWorldCoordinates

DtVector	myLastAngularVelocity

bool	myLastAngularVelocityWorldCoordinates

DtCigiConnection &	myConnection

DtAgentManagerInterface &	mySceneInterface

int	myEntityId

int	myEntityType

bool	myExtendedEntityTypeOn

DtEntityType	myExtendedEntityType

DtCigiBaseEntity *	myParent

int	myEmbarkedParentID

bool	myInheritAlpha

int	myAlpha

bool	myVisiblity

bool	myPositionSet

bool	myOrientationSet

std::map< int, DtTaitBryan >	myLastArtPartOrientation

std::map< int, DtVector >	myLastArtPartTranslation

std::map< int, DtVector >	myArtPartAngularRate

std::map< int, DtVector >	myArtPartLinearRate

std::list< unsigned int >	myCollisionSegmentIdList

DtSignalConnectionManager	mySignalConnections

vrvSignalsLib::connection	myAlphaChangedConnection

vrvSignalsLib::connection	myPreTickConnection

Friends
class	DtCigiWatercraftEntity

Additional Inherited Members
Public Types inherited from makVrv::DtCigiBaseEntity
enum	AnimationStateGroup { Stop = 0, Pause = 1, Play = 2, Continue = 3 }

Public Attributes inherited from makVrv::DtCigiBaseEntity
vrvSignalsLib::signal< void(int, DtUniqueID)>	signal_alphaChanged

Constructor & Destructor Documentation

makVrv::DtCigiWakeEntity::DtCigiWakeEntity	(	DtCigiConnection &	connection,
		DtAgentManagerInterface &	sceneInterface,
		int	entityId,
		int	entityType
	)

Constructor.

virtual makVrv::DtCigiWakeEntity::~DtCigiWakeEntity ( )

virtual

Destructor.

Member Function Documentation

virtual void makVrv::DtCigiWakeEntity::uninit ( )

virtual

Calls down DtCigiBaseEntity::uninit() and then calls destroyModelAgents()

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiWakeEntity::setPosition	(	const DtGeodeticCoord &	pos,
		bool	force = `false`
	)

virtual

Set the entity's geodetic position.

Parameters

[in]	pos	is the position set from the CIGI entity control message.
[in]	force	is a flag to force handling even if position has not changed.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiWakeEntity::setRelativePosition ( const DtVector & pos )

virtual

Sets the entity's relative position (if attached).

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiWakeEntity::setOrientation	(	const DtTaitBryan &	orient,
		bool	force = `false`
	)

virtual

Set the entity's orientation.

Parameters

[in]	orientation	is the orientation set from the CIGI entity control message.
[in]	force	is a flag to force handling even if orientation has not changed.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiWakeEntity::setRelativeOrientation ( const DtTaitBryan & orient )

virtual

Sets the entity's relative orientation (relative to the parent's body coordinates) if attached.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiWakeEntity::setRelativeTo ( DtCigiBaseEntity * parent )

virtual

Attachment control - override base class so we can tell parent about us.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiWakeEntity::setLinearRate	(	const DtVector &	rate,
		bool	useWorldCoordinates,
		bool	force = `false`
	)

virtual

Sets the entity's linear rate. If useWorldCoordinates is set to true, sets the velocity according to the entity's rate with respect to the tangential reference plane of the entity. Otherwise, sets the velocity with respect to the entity's coordinate system.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiWakeEntity::setSprayEnabled ( bool enabled )

virtual

Enable or disable spray at the bow and hull of the ship.

virtual void makVrv::DtCigiWakeEntity::setWakeOffset ( double offset )

virtual

Set the distance from the center of the ship to the origin point of the circles use to generate the wake.

virtual void makVrv::DtCigiWakeEntity::setBowSprayOffset ( double offset )

virtual

Set the distance from the wake origin to where the spray appears, if enabled.

virtual void makVrv::DtCigiWakeEntity::setBowWaveOffset ( double offset )

virtual

Set the offset to the bow wake.

virtual void makVrv::DtCigiWakeEntity::setSternWaveOffset ( double offset )

virtual

Set the offset to the stern wakes.

virtual void makVrv::DtCigiWakeEntity::setShipLength ( double length )

virtual

Set the length of the ship.

virtual void makVrv::DtCigiWakeEntity::setBeamWidth ( double width )

virtual

Set the beam width (widest point) of the ship.

virtual void makVrv::DtCigiWakeEntity::setPropWashEnabled ( bool b )

virtual

Set whether prop wash effects are enabled.

virtual void makVrv::DtCigiWakeEntity::setPropWashOffset ( double offset )

virtual

Set the distance from the wake origin to where the prop wash appears, if enabled.

virtual void makVrv::DtCigiWakeEntity::setPropWashFadeTime ( double fadeTime )

virtual

Set the amount of time, in seconds, over which the prop wash will dissipate.

virtual void makVrv::DtCigiWakeEntity::setDraft ( double draft )

virtual

Set the draft, or the distance the hull extends underwater. Used to influence the bow wake.

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

virtual

Set the distance beyond which wakes are disabled. Normally the value in the wake model definition is used. If that is not set, then the default wake LOD distance entity setting is used. If this method is called and the default wake LOD distance was being used the entity will disconnect from the defaultWakeLODDistance signal and use the value passed here instead.

virtual void makVrv::DtCigiWakeEntity::setSprayVelocityScale ( double scale )

virtual

Set the velocity scaling for bow spray effects.

virtual void makVrv::DtCigiWakeEntity::setBowWaveScale ( double scale )

virtual

Set the scaling for bow wave effects.

virtual void makVrv::DtCigiWakeEntity::setMaxBowWaveAmplitude ( double amplitude )

virtual

Set the max amplitude for bow waves.

virtual void makVrv::DtCigiWakeEntity::setBowSize ( double size )

virtual

Set the size of the bow (0 for a pointy one.)

virtual void makVrv::DtCigiWakeEntity::setSpraySizeScale ( double scale )

virtual

Set the particle size scaling for bow spray effects.

virtual void makVrv::DtCigiWakeEntity::setNumHullSprays ( int numSprays )

virtual

Set the number of spray particle systems emitted along the hull of the ship.

virtual void makVrv::DtCigiWakeEntity::setHullSpraySizeScale ( double scale )

virtual

Set the initial size of hull spray particles.

virtual void makVrv::DtCigiWakeEntity::setHullSprayStart ( double offset )

virtual

Set the start offset of hull spray effects.

virtual void makVrv::DtCigiWakeEntity::setHullSprayEnd ( double offset )

virtual

Set the end offset of hull spray effects.

virtual void makVrv::DtCigiWakeEntity::setHullSprayVelocityScale ( double scale )

virtual

Set the initial velocity of hull spray particles as a percent of the ship velocity.

virtual void makVrv::DtCigiWakeEntity::setHullSprayVerticalOffset ( double offset )

virtual

Set the initial vertical position of hull spray particles.

virtual void makVrv::DtCigiWakeEntity::setVisible ( bool yesNo )

virtual

Set whether the entity is visible.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiWakeEntity::setIsSinking ( bool sinking )

virtual

Stop the wake if the ship is sinking.

virtual void makVrv::DtCigiWakeEntity::addToParent ( DtSceneObjectAgent * parent )

protectedvirtual

virtual void makVrv::DtCigiWakeEntity::removeFromParent ( DtSceneObjectAgent * parent )

protectedvirtual

virtual void makVrv::DtCigiWakeEntity::createModelAgents ( )

protectedvirtual

virtual void makVrv::DtCigiWakeEntity::destroyModelAgents ( )

protectedvirtual

virtual void makVrv::DtCigiWakeEntity::slot_wakeDefaultLODDistanceChanged ( double distance )

protectedvirtual

virtual void makVrv::DtCigiWakeEntity::slot_wakesEnabledChanged ( bool enabled )

protectedvirtual

Friends And Related Function Documentation

friend class DtCigiWatercraftEntity

friend

Member Data Documentation

DtWakeModelAgent* makVrv::DtCigiWakeEntity::myWakeModelAgent

protected

DtWakeUpdaterAgent* makVrv::DtCigiWakeEntity::myWakeUpdaterAgent

protected

DtSignalConnectionManager makVrv::DtCigiWakeEntity::myConnections

protected

boost::signalslib::connection makVrv::DtCigiWakeEntity::myWakeLODDistanceChangedConnection

protected

bool makVrv::DtCigiWakeEntity::myIsSinking

protected

double makVrv::DtCigiWakeEntity::myWakeLODRange

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCigi/DtCigiWakeEntity.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation