makVrv::DtCigiRotorWashEntity Class Reference

A DtCigiRotorWashEntity is a CIGI entity that loads rotor wash models. More...

Inheritance diagram for makVrv::DtCigiRotorWashEntity:

Public Member Functions
	DtCigiRotorWashEntity (DtCigiConnection &connection, DtAgentManagerInterface &sceneInterface, int entityId, int entityType)
	Constructor. More...
virtual	~DtCigiRotorWashEntity ()
	Destructor. More...
virtual void	init ()
	Initialises all washes. More...
virtual void	uninit ()
	Calls down DtCigiBaseEntity::uninit() and then calls deleteModelAgents() More...
virtual void	restart ()
	Calls down to DtCigiBaseEntity::restart(), and then restores the rotor wash's state (rotor diameter and rotor speed, if either have been set) More...
virtual void	setRotorWashDiameter (double rotorWashDiameter)
	RotorWash Diameter Set the diameter of the rotors (tip to tip) generating the wash Also calls down to myRotorWashModel. More...
virtual float	rotorWashDiameter ()
virtual void	setRotorWashWindSpeed (double rotorWashWindSpeed)
	RotorWash Wind speed Set the speed of the down-draft created by the rotors Also calls down to myRotorWashModel. More...
virtual float	rotorWashWindSpeed ()
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. More...
virtual	~DtCigiBaseEntity ()
	Destructor. More...
virtual DtUniqueID	uniqueId () const
	Returns the element ID of the entity's scene object. More...
virtual DtUniqueID	elementId () const
	Returns the element ID of the entity's scene object. More...
virtual int	cigiId () const
	Returns the CIGI Id of the CIGI entity. More...
virtual void	restartRequest ()
	This is called to request that the entity be restarted. More...
virtual int	entityType () const
	Get the entity type the entity was created with. More...
virtual bool	extendedEntityTypeOn () const
	Get whether the entity has extended type on. More...
virtual void	setExtendedEntityTypeOn (bool onOff)
	Set whether this entity uses extended entity type. More...
virtual void	setExtendedEntityType (DtEntityType &entityType)
	TODO Are we setting extended from CIGI or DIS? TODO Test whether this sets Set the extended type. More...
virtual void	setVisible (bool yesNo)
	Set whether the entity is visible. More...
virtual bool	isVisible () const
	Get the current visibility. More...
virtual void	setDeadReckoningOn (bool onOff)
	Turns dead-reckoning on/off. More...
virtual bool	isDeadReckoning () const
	Determine if the entity is ACTUALLY dead reckoning. More...
virtual void	setPosition (const DtGeodeticCoord &pos, bool force=false)
	Set the entity's geodetic position. More...
virtual const DtGeodeticCoord &	position () const
	Returns the last position set by a CIGI entity control message. More...
virtual const DtVector &	localPosition () const
	Returns the last computed local position set. More...
virtual void	setOrientation (const DtTaitBryan &orientation, bool force=false)
	Set the entity's orientation. More...
virtual const DtTaitBryan &	orientation () const
	Returns the last orientation set by a CIGI entity control message. More...
virtual const DtTaitBryan &	localOrientation () const
	Returns the computed last local orientation. More...
virtual const DtTaitBryan &	geocentricOrientation () const
	Get the last computed geocentric orientation. More...
virtual void	setLinearRate (const DtVector &rate, bool useWorldCoordinates, bool force=false)
	Sets the entity's linear rate. More...
virtual const DtVector &	linearRate () const
	Get the last set linear rate. More...
virtual void	setAngularRate (const DtVector &rate, bool useWorldCoordinates, bool force=false)
	Set's the entity's angular rate. More...
virtual const DtVector &	angularRate () const
	Get the last set angular rate. More...
virtual void	slot_deadReckoningAllowed (bool allowed)
	Called when IG-wide extrapolation is turned on or off. More...
virtual void	setAlpha (int alpha)
	Sets the entity's alpha value. More...
virtual int	alpha () const
	Returns the entity's alpha value. More...
virtual void	setInheritAlpha (bool inherit)
	Set whether the entity should inherit alpha from its parent. More...
virtual bool	isInheritingAlpha () const
	Determine if the entity is inheriting alpha. More...
virtual void	slot_alphaChanged (int alpha, DtUniqueID id)
	Slot so we can check if the parent's alpha has changed. More...
virtual void	slot_entityToBeDeleted (int cigiEntityId)
	Connected to the signal raised by the entity manager when an entity is removed, this is used to insure that signals connected to an embarkation parent are managed correctly if/when that parent is deleted. More...
virtual void	setGroundClampingOn (DtGroundClampingUpdater::GroundClampingMode clampType)
	Turns ground clamping on/off. More...
virtual DtGroundClampingUpdater::GroundClampingMode	groundClampingType () const
	Get the current ground clamping type. More...
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. More...
virtual bool	getArtPartTranslation (int partId, DtVector &translation)
	Get the art part translation from a specified CIGI part id. More...
virtual void	setArtPartOrientation (int partId, float yaw, float pitch, float roll, bool yawEnable, bool pitchEnable, bool rollEnable)
	Set the orientation of an articulated part. More...
virtual bool	getArtPartOrientation (int partId, DtTaitBryan &orientation)
	Returns false if the part id is not found. More...
virtual void	setArtPartLinearRate (int partId, float xRate, float yRate, float zRate)
	Set the linear rate of an articulated part. More...
virtual bool	getArtPartLinearRate (int partId, DtVector &rate)
	Get the art part translation rate from a specified CIGI part id. More...
virtual bool	getArtPartTranslationAndRate (int partId, DtVector &translation, DtVector &rate)
	Get the art part translation and rate from a specified CIGI part id. More...
virtual void	setArtPartAngularRate (int partId, float yawRate, float pitchRate, float rollRate)
	Set the angular rate of an articulated part. More...
virtual bool	getArtPartAngularRate (int partId, DtVector &rate)
	Returns false if the part id is not found. More...
virtual bool	getArtPartOrientationAndRate (int partId, DtTaitBryan &orientation, DtVector &rate)
	Returns false if the part id is not found. More...
virtual void	setArtPartEnable (int partId, bool trueFalse)
	Enable/disable an articulated part. More...
virtual DtSceneObjectAgent *	findSceneObjectAgent ()
virtual void	setRelativeTo (DtCigiBaseEntity *parent)
	Attachment control. More...
virtual void	setRelativePosition (const DtVector &pos)
	Sets the entity's relative position (if attached). More...
virtual void	setRelativeOrientation (const DtTaitBryan &orient)
	Sets the entity's relative orientation (relative to the parent's body coordinates) if attached. More...
virtual bool	isEmbarked () const
	Determine if the entity is attached to a parent entity. More...
virtual int	embarkedParentId () const
	Get the CIGI ID of the entity to which we are attached. More...
virtual const DtVector &	relativePosition () const
	Returns the last relative offset position. More...
virtual const DtTaitBryan &	relativeOrientation () const
	Returns the last relative orientation. More...
virtual void	addCollisionSegmentID (unsigned int segmentId)
	Methods for adding a removing collision segment IDs that are associated with this entity. More...
virtual void	removeCollisionSegmentID (unsigned int segmentId)

Protected Member Functions
virtual void	slot_rotorWashEnabledChanged (bool enabled)
	slot calls setRotorWashEnabled More...
virtual void	setRotorWashEnabled (bool enable)
	Enable/disable this effect Additionally sets this CIGI Entity to Visible Does not call down to base as that enables ALL washes. More...
Protected Member Functions inherited from makVrv::DtCigiBaseEntity
virtual void	startDeadReckoning ()
	Create and set up Dead Reckoning updater. More...
virtual void	endDeadReckoning ()
	Remove the Dead Reckoning updater. More...
virtual void	startEmbarked ()
	Create and set up Embarkation updater. More...
virtual void	endEmbarked ()
	Remove the Embarkation updater. More...
virtual void	startGroundClamping ()
	Create and set up Ground Clamping updater; uses buildGroundClampingUpdater() to create the updater agents. More...
virtual void	buildGroundClampingUpdater ()
	Create and intialize the ground clamping updater agents. More...
virtual void	endGroundClamping ()
	Remove the Ground Clamping updater. More...
virtual bool	isGroundClamping () const
	Returns false if ground clamping type is DtGroundClampingUpdater::ClampNone true otherwise. More...
virtual void	getExtrapolatedValuesAndRestart ()
	Request position and orientation values from the render thread if this entity is dead reckoned. More...
virtual void	delayedStartEmbarked ()
	When an embarked entity is restarted, it needs to be reattached to its parent at the start of the next frame (after all other entities have been restarted). More...
virtual void	queryExtrapolatedPositionAndOrientation (DtUniqueID drAgentId, bool relative)
	This is the render thread-run method that collects dead reckoned position and orientation. More...
virtual void	returnExtrapolatedPositionAndOrientation (const DtVector &resultPos, const DtTaitBryan &resultOri, bool relative, bool invokeRestart)
	This method returns the position and orientation collected from the render thread in the connection thread. More...
virtual DtDeadReckonUpdater *	findDRUpdaterInRenderThread (DtUniqueID drAgentId) const
	Helper function called by queryExtrapolatedPositionAndOrientation to look up the the dead reckon updater object given its agent id. More...

Protected Attributes
DtRotorWashModelAgent *	myRotorWashModel
DtRotorWashUpdaterAgent *	myRotorWashUpdater
DtRotorWashInfo	myRotorWashInfo
bool	myGlobalRotorWashEnabled
	This is the tick box from the gui settings. More...
double	myRotorWashDiameter
double	myRotorWashWindSpeed
DtSignalConnectionManager	myConnections
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
	List for Collision Detection Segment IDs from collision segment detection definition packets. More...
DtSignalConnectionManager	mySignalConnections

Additional Inherited Members
Public Types inherited from makVrv::DtCigiBaseEntity
enum	AnimationStateGroup { Stop = 0, Pause = 1, Play = 2, Continue = 3 }
	AnimationStateGroup in Cigi Order. More...
Public Attributes inherited from makVrv::DtCigiBaseEntity
boost::signal< void(int, DtUniqueID)>	signal_alphaChanged
	Emitted when this entity's alpha has changed. More...

Detailed Description

A DtCigiRotorWashEntity is a CIGI entity that loads rotor wash models.

Large portions of this class are based on DtEntityRotorWashVisualiser Rotorwash is controlled through Cigi Component Control Packets, which are called from DtCigiEntityVisualizer The type of Rotorwash is specified by the model definition mapped to the entity type. Valid types are currently mapped as: RotorWashDirt RotorWashGravel RotorWashHardPacked RotorWashMuck RotorWashPavedRoad RotorWashRocks RotorWashSand RotorWashSnow OceanRotorWash - Triton OceanRotorWashLarge - Triton OceanRotorWashSmall - Triton There is additional support for this entity through the use of component control packets. "Rotorwash Diameter" and "Rotorwash Windspeed" can be adjusted.

Constructor & Destructor Documentation

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

Constructor.

virtual makVrv::DtCigiRotorWashEntity::~DtCigiRotorWashEntity ( )

virtual

Destructor.

Member Function Documentation

virtual void makVrv::DtCigiRotorWashEntity::init ( )

virtual

Initialises all washes.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiRotorWashEntity::uninit ( )

virtual

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

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiRotorWashEntity::restart ( )

virtual

Calls down to DtCigiBaseEntity::restart(), and then restores the rotor wash's state (rotor diameter and rotor speed, if either have been set)

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiRotorWashEntity::setRotorWashDiameter ( double  rotorWashDiameter )

virtual

RotorWash Diameter Set the diameter of the rotors (tip to tip) generating the wash Also calls down to myRotorWashModel.

virtual float makVrv::DtCigiRotorWashEntity::rotorWashDiameter ( )

virtual

virtual void makVrv::DtCigiRotorWashEntity::setRotorWashWindSpeed ( double  rotorWashWindSpeed )

virtual

RotorWash Wind speed Set the speed of the down-draft created by the rotors Also calls down to myRotorWashModel.

virtual float makVrv::DtCigiRotorWashEntity::rotorWashWindSpeed ( )

virtual

virtual void makVrv::DtCigiRotorWashEntity::slot_rotorWashEnabledChanged ( bool  enabled )

protectedvirtual

slot calls setRotorWashEnabled

virtual void makVrv::DtCigiRotorWashEntity::setRotorWashEnabled ( bool  enable )

protectedvirtual

Enable/disable this effect Additionally sets this CIGI Entity to Visible Does not call down to base as that enables ALL washes.

Member Data Documentation

DtRotorWashModelAgent* makVrv::DtCigiRotorWashEntity::myRotorWashModel

protected

DtRotorWashUpdaterAgent* makVrv::DtCigiRotorWashEntity::myRotorWashUpdater

protected

DtRotorWashInfo makVrv::DtCigiRotorWashEntity::myRotorWashInfo

protected

bool makVrv::DtCigiRotorWashEntity::myGlobalRotorWashEnabled

protected

This is the tick box from the gui settings.

double makVrv::DtCigiRotorWashEntity::myRotorWashDiameter

protected

double makVrv::DtCigiRotorWashEntity::myRotorWashWindSpeed

protected

DtSignalConnectionManager makVrv::DtCigiRotorWashEntity::myConnections

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCigi/DtCigiRotorWashEntity.h