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

Inheritance diagram for makVrv::DtCigiWatercraftEntity:

Public Member Functions
	DtCigiWatercraftEntity (DtCigiConnection &connection, DtAgentManagerInterface &sceneInterface, int entityId, int entityType)
	Constructor.
virtual	~DtCigiWatercraftEntity ()
	Destructor.
virtual void	setPosition (const DtGeodeticCoord &pos, bool force=false)
	Set the entity's geodetic position.
virtual void	setOrientation (const DtTaitBryan &orientation, bool force=false)
	Set the entity's orientation.
virtual void	setLinearRate (const DtVector &rate, bool useWorldCoordinates)
	Sets the entity's linear rate.
virtual void	setWakeEntity (DtCigiWakeEntity *wakeEntity)
	Tell the entity if it is the parent of a wake entity.
virtual void	startSinking ()
	Start sinking the ship (by telling the world that the ship is destroyed)
virtual void	stopSinking ()
	Stop sinking the ship (and restore to normal buoyancy.
virtual bool	isSinking () const
	Are we currently sinking (destroyed)?
virtual void	setWaterlineOriginOffset (float offset)
	Set the amount that a bouyant entity's origin is offset from the waterline.
virtual void	setIsAmphibious (bool isAmphibious)
	This is used by wake and buoyancy model to indicate if checks need to be made for being over land.
virtual bool	isAmphibious () const
Public Member Functions inherited from makVrv::DtCigiEntity
	DtCigiEntity (DtCigiConnection &connection, DtAgentManagerInterface &mySceneInterface, int entityId, int entityType)
	Constructor.
virtual	~DtCigiEntity ()
	Destructor.
virtual void	setState (int stateId, int stateValue)
	Set the state of a model to a value.
virtual void	setArtPartTranslation (int partId, float xOffset, float yOffset, float zOffset, bool xEnable, bool yEnable, bool zEnable)
	Set the relative position of an articulated part.
virtual void	setArtPartOrientation (int partId, float yaw, float pitch, float roll, bool yawEnable, bool pitchEnable, bool rollEnable)
	Set the orientation of an articulated part.
virtual void	setArtPartLinearRate (int partId, float xRate, float yRate, float zRate)
	Set the linear rate of an articulated part.
virtual void	setArtPartAngularRate (int partId, float yawRate, float pitchRate, float rollRate)
	Set the angular rate of an articulated part.
virtual void	setArtPartEnable (int partId, bool trueFalse)
	Enable/disable an articulated part.
virtual void	setAnimationSpeed (const std::string &animationName, double speed)
	Set the speed of an animation within the model.
virtual void	setAnimationFrame (const std::string &animationName, int frame)
	Set the frame of an animation within the model.
virtual void	setActiveRegionState (const std::string &regionName, bool state)
	Set the state of an active sensor region.
virtual void	setAnimationRange (const std::string &animationName, int firstFrameIndex, int lastFrameIndex)
	Set the range of an animation within the model.
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	setVisible (bool yesNo)
	Set whether the entity is visible.
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	setRelativeTo (DtCigiBaseEntity *parent)
	Attachment control.
virtual void	setRelativePosition (const DtVector &pos)
	Sets the entity's relative position (if attached).
virtual void	setRelativeOrientation (const DtTaitBryan &orient)
	Sets the entity's relative orientation (relative to the parent's body coordinates) if attached.
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	startDeadReckoning ()
	Create and set up Dead Reckoning updater.
virtual void	endDeadReckoning ()
	Remove the Dead Reckoning updater.
virtual void	slot_buoyancyDefaultLODDistanceChanged (float distance)
virtual void	slot_buoyancyMinimumCullDistanceChanged (float distance)
virtual void	slot_buoyancyCullTypeChanged (makArchives::DtEntitySettingsRecord::BuoyancyCullType type)

Protected Attributes
DtSurfaceClampingUpdaterAgent *	mySurfaceClampingUpdaterAgent
DtWaterClampingUpdaterAgent *	myWaterClampingUpdaterAgent
DtCigiWakeEntity *	myWakeEntity
bool	myIsSinking
bool	myIsMoving
DtSignalConnectionManager	myConnections
bool	myIsAmphibious
Protected Attributes inherited from makVrv::DtCigiEntity
DtArticulatedModelAgent *	myArticulatedModel
std::map< int, DtTaitBryan >	myLastArtPartOrientation
std::map< int, DtVector >	myLastArtPartTranslation
std::map< int, DtVector >	myArtPartAngularRate
std::map< int, DtVector >	myArtPartLinearRate
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

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 DtCigiWatercraftEntity is a CIGI entity that loads an animation model.

Constructor & Destructor Documentation

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

Constructor.

virtual makVrv::DtCigiWatercraftEntity::~DtCigiWatercraftEntity ( )

virtual

Destructor.

Member Function Documentation

virtual void makVrv::DtCigiWatercraftEntity::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::DtCigiWatercraftEntity::setOrientation	(	const DtTaitBryan &	orientation,
		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::DtCigiWatercraftEntity::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::DtCigiWatercraftEntity::setWakeEntity ( DtCigiWakeEntity * wakeEntity )

virtual

Tell the entity if it is the parent of a wake entity.

virtual void makVrv::DtCigiWatercraftEntity::startSinking ( )

virtual

Start sinking the ship (by telling the world that the ship is destroyed)

virtual void makVrv::DtCigiWatercraftEntity::stopSinking ( )

virtual

Stop sinking the ship (and restore to normal buoyancy.

virtual bool makVrv::DtCigiWatercraftEntity::isSinking ( ) const

virtual

Are we currently sinking (destroyed)?

virtual void makVrv::DtCigiWatercraftEntity::setWaterlineOriginOffset ( float offset )

virtual

Set the amount that a bouyant entity's origin is offset from the waterline.

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

virtual

This is used by wake and buoyancy model to indicate if checks need to be made for being over land.

When false (default) use assumes responsibility for keeping entity over water (note that the test for land is expensive, so keep this false unless you need it for an amphibious entity)

virtual bool makVrv::DtCigiWatercraftEntity::isAmphibious ( ) const

virtual

virtual void makVrv::DtCigiWatercraftEntity::startDeadReckoning ( )

protectedvirtual

Create and set up Dead Reckoning updater.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiWatercraftEntity::endDeadReckoning ( )

protectedvirtual

Remove the Dead Reckoning updater.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiWatercraftEntity::slot_buoyancyDefaultLODDistanceChanged ( float distance )

protectedvirtual

virtual void makVrv::DtCigiWatercraftEntity::slot_buoyancyMinimumCullDistanceChanged ( float distance )

protectedvirtual

virtual void makVrv::DtCigiWatercraftEntity::slot_buoyancyCullTypeChanged ( makArchives::DtEntitySettingsRecord::BuoyancyCullType type )

protectedvirtual

Member Data Documentation

DtSurfaceClampingUpdaterAgent* makVrv::DtCigiWatercraftEntity::mySurfaceClampingUpdaterAgent

protected

DtWaterClampingUpdaterAgent* makVrv::DtCigiWatercraftEntity::myWaterClampingUpdaterAgent

protected

DtCigiWakeEntity* makVrv::DtCigiWatercraftEntity::myWakeEntity

protected

bool makVrv::DtCigiWatercraftEntity::myIsSinking

protected

bool makVrv::DtCigiWatercraftEntity::myIsMoving

protected

DtSignalConnectionManager makVrv::DtCigiWatercraftEntity::myConnections

protected

bool makVrv::DtCigiWatercraftEntity::myIsAmphibious

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCigi/DtCigiWaterCraftEntity.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation