A DtCigiWakeEntity is a CIGI entity that loads an animation model. More...

Inheritance diagram for makVrv::DtCigiWakeEntity:

Public Member Functions
	DtCigiWakeEntity (DtCigiConnection &connection, DtAgentManagerInterface &sceneInterface, int entityId, int entityType)
	Constructor.
virtual	~DtCigiWakeEntity ()
	Destructor.
virtual void	setPosition (const DtGeodeticCoord &pos, bool force=false)
	Set the entity's geodetic position.
virtual void	setRelativePosition (const DtVector &pos)
	Sets the entity's relative position (if attached).
virtual void	setOrientation (const DtTaitBryan &orient, bool force=false)
	Set the entity's orientation.
virtual void	setRelativeOrientation (const DtTaitBryan &orient)
	Sets the entity's relative orientation (relative to the parent's body coordinates) if attached.
virtual void	setRelativeTo (DtCigiBaseEntity *parent)
	Attachment control - override base class so we can tell parent about us.
virtual void	setLinearRate (const DtVector &rate, bool useWorldCoordinates)
	Sets the entity's linear rate.
virtual void	setSprayEnabled (bool enabled)
	Enable or disable spray at the bow and hull of the ship.
virtual void	setWakeOffset (double offset)
	Set the distance from the center of the ship to the origin point of the circles use to generate the wake.
virtual void	setBowSprayOffset (double offset)
	Set the distance from the wake origin to where the spray appears, if enabled.
virtual void	setBowWaveOffset (double offset)
	Set the offset to the bow wake.
virtual void	setSternWaveOffset (double offset)
	Set the offset to the stern wakes.
virtual void	setShipLength (double length)
	Set the length of the ship.
virtual void	setBeamWidth (double width)
	Set the beam width (widest point) of the ship.
virtual void	setPropWashEnabled (bool b)
	Set whether prop wash effects are enabled.
virtual void	setPropWashOffset (double offset)
	Set the distance from the wake origin to where the prop wash appears, if enabled.
virtual void	setDraft (double draft)
	Set the draft, or the distance the hull extends underwater.
virtual void	setLODDistance (double distance)
	Set the distance at which the prop wash segments and waves are halved.
virtual void	setSprayVelocityScale (double scale)
	Set the velocity scaling for bow spray effects.
virtual void	setBowWaveScale (double scale)
	Set the scaling for bow wave effects.
virtual void	setMaxBowWaveAmplitude (double amplitude)
	Set the max amplitude for bow waves.
virtual void	setBowSize (double size)
	Set the size of the bow (0 for a pointy one.)
virtual void	setSpraySizeScale (double scale)
	Set the particle size scaling for bow spray effects.
virtual void	setNumHullSprays (int numSprays)
	Set the number of spray particle systems emitted along the hull of the ship.
virtual void	setHullSpraySizeScale (double scale)
	Set the initial size of hull spray particles.
virtual void	setHullSprayStart (double offset)
	Set the start offset of hull spray effects.
virtual void	setHullSprayEnd (double offset)
	Set the end offset of hull spray effects.
virtual void	setHullSprayVelocityScale (double scale)
	Set the initial velocity of hull spray particles as a percent of the ship velocity.
virtual void	setHullSprayVerticalOffset (double offset)
	Set the initial vertical position of hull spray particles.
virtual void	setVisible (bool isVisible)
	Set whether the entity is visible.
virtual void	setIsMoving (bool isMoving)
Public Member Functions inherited from makVrv::DtCigiBaseEntity
	DtCigiBaseEntity (DtCigiConnection &connection, DtAgentManagerInterface &sceneInterface, int entityId, int entityType)
	Constructor takes a DtCigiConnection, scene interface, and the CIGI entity ID/type.
virtual	~DtCigiBaseEntity ()
	Destructor.
virtual DtUniqueID	uniqueId () const
	Returns the unique ID of the entity's scene object.
virtual int	cigiId () const
	Returns the ID of the CIGI entity.
virtual void	init ()
virtual void	setDeadReckoningOn (bool onOff)
	Turns dead-reckoning on/off.
virtual const DtGeodeticCoord &	position () const
	Returns the last position set by a CIGI entity control message.
virtual const DtVector &	localPosition () const
	Returns the last computed local position set.
virtual const DtTaitBryan &	orientation () const
	Returns the last orientation set by a CIGI entity control message.
virtual void	setAngularRate (const DtVector &rate, bool useWorldCoordinates=true)
	Set's the entity's angular rate.
virtual void	slot_deadReckoningAllowed (bool allowed)
	Called when IG-wide extrapolation is turned on or off.
virtual void	setAlpha (int alpha)
	Sets the entity's alpha value.
virtual int	alpha () const
	Returns the entity's alpha value.
virtual void	setInheritAlpha (bool inherit)
	Set whether the entity should inherit alpha from its parent.
virtual void	slot_alphaChanged (int alpha, DtUniqueID id)
	Slot so we can check if the parent's alpha has changed.
virtual void	setGroundClampingOn (DtGroundClampingUpdater::GroundClampingMode clampType)
	Turns ground clamping on/off.

Protected Member Functions
virtual void	addToParent (DtSceneObjectAgent *parent)
virtual void	removeFromParent (DtSceneObjectAgent *parent)
void	createModelAgents ()
void	destroyModelAgents ()
Protected Member Functions inherited from makVrv::DtCigiBaseEntity
virtual void	startDeadReckoning ()
	Create and set up Dead Reckoning updater.
virtual void	endDeadReckoning ()
	Remove the Dead Reckoning updater.
virtual void	startEmbarked ()
	Create and set up Embarkation updater.
virtual void	endEmbarked ()
	Remove the Embarkation updater.
virtual void	startGroundClamping ()
	Create and set up Ground Clamping updater.
virtual void	endGroundClamping ()
	Remove the Ground Clamping updater.
virtual void	buildGroundClampingUpdater ()

Protected Attributes
DtWakeModelAgent *	myWakeModelAgent
DtWakeUpdaterAgent *	myWakeUpdaterAgent
DtSceneObjectAgent *	myParentSceneObjectAgent
std::string	myEntityModel
bool	myIsMoving
Protected Attributes inherited from makVrv::DtCigiBaseEntity
DtSceneObjectAgent *	mySceneObject
DtModelAgent *	myModel
DtDeadReckonUpdaterAgent *	myDeadReckonUpdaterAgent
DtGroundClampingUpdaterAgent *	myGroundClampingUpdaterAgent
DtEmbarkationUpdaterAgent *	myEmbarkationUpdaterAgent
bool	myDeadReckoningOn
bool	myEmbarked
DtGroundClampingUpdater::GroundClampingMode	myGroundClampingType
DtGeodeticCoord	myLastPosition
DtVector	myLastLocalPosition
DtTaitBryan	myLastOrientation
DtTaitBryan	myLastLocalOrientation
DtTaitBryan	myLastGeocentricOrientation
DtVector	myLastVelocity
DtVector	myLastAngularVelocity
DtCigiConnection &	myConnection
DtAgentManagerInterface &	mySceneInterface
int	myEntityId
int	myEntityType
DtCigiBaseEntity *	myParent
DtUniqueID	myEmbarkedParentID
bool	myInheritAlpha
int	myAlpha
bool	myVisiblity
DtSignalConnectionManager	mySignalConnections

Friends
class	DtCigiWatercraftEntity

Additional Inherited Members
Public Attributes inherited from makVrv::DtCigiBaseEntity
boost::signal< void(int, DtUniqueID)>	signal_alphaChanged
	Emitted when this entity's alpha has changed.

Detailed Description

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

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::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
	)

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::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 at which the prop wash segments and waves are halved.

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::setIsMoving ( bool isMoving )

virtual

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

protectedvirtual

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

protectedvirtual

void makVrv::DtCigiWakeEntity::createModelAgents ( )

protected

void makVrv::DtCigiWakeEntity::destroyModelAgents ( )

protected

Friends And Related Function Documentation

friend class DtCigiWatercraftEntity

friend

Member Data Documentation

DtWakeModelAgent* makVrv::DtCigiWakeEntity::myWakeModelAgent

protected

DtWakeUpdaterAgent* makVrv::DtCigiWakeEntity::myWakeUpdaterAgent

protected

DtSceneObjectAgent* makVrv::DtCigiWakeEntity::myParentSceneObjectAgent

protected

std::string makVrv::DtCigiWakeEntity::myEntityModel

protected

bool makVrv::DtCigiWakeEntity::myIsMoving

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrvCigi/DtCigiWakeEntity.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation