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. You need to set these values for defaults will be used.

Inheritance diagram for makVrv::DtCigiRotorWashEntity:

[legend]

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

virtual	~DtCigiRotorWashEntity ()

virtual void	init ()

virtual void	uninit ()

virtual void	restart ()


virtual void	setRotorWashDiameter (double rotorWashDiameter)

virtual float	rotorWashDiameter ()


virtual void	setRotorWashWindSpeed (double rotorWashWindSpeed)

virtual float	rotorWashWindSpeed ()

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	restartRequest ()

virtual int	entityType () const

virtual bool	extendedEntityTypeOn () const

virtual void	setExtendedEntityTypeOn (bool onOff)

virtual void	setExtendedEntityType (DtEntityType &entityType)

virtual void	setVisible (bool yesNo)

virtual bool	isVisible () const

virtual void	setDeadReckoningOn (bool onOff)

virtual bool	isDeadReckoning () const

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

virtual const DtGeodeticCoord &	position () const

virtual const DtGeodeticCoord &	previousPosition () const

virtual const DtVector &	localPosition () const

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

virtual const DtTaitBryan &	orientation () const

virtual const DtTaitBryan &	localOrientation () const

virtual const DtTaitBryan &	geocentricOrientation () const

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

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	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 void	setRelativeTo (DtCigiBaseEntity *parent)

virtual void	setRelativePosition (const DtVector &pos)

virtual void	setRelativeOrientation (const DtTaitBryan &orient)

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	slot_rotorWashEnabledChanged (bool enabled)

virtual void	setRotorWashEnabled (bool enable)

virtual void	startEmbarked () override

virtual void	endEmbarked () override

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

virtual void	endDeadReckoning ()

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
DtRotorWashModelAgent *	myRotorWashModel

DtRotorWashObjectAgent *	myRotorWashObject

DtRotorWashInfo	myRotorWashInfo

bool	myGlobalRotorWashEnabled

double	myRotorWashDiameter

double	myRotorWashWindSpeed

std::string	mySchema

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

DtSignalConnectionManager	mySignalConnections

vrvSignalsLib::connection	myAlphaChangedConnection

vrvSignalsLib::connection	myPreTickConnection

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::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. Set defaults for rotor diameter and rotor wind speed. If this Entity is NOT attached to a parent, the visibility is set to false. This is so that washes do not render when they are created.

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

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

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

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

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.

virtual void makVrv::DtCigiRotorWashEntity::startEmbarked ( )

overrideprotectedvirtual

Add the wash model to the parent's scene object if it is a particle system schema Start the wash.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiRotorWashEntity::endEmbarked ( )

overrideprotectedvirtual

Remove the Embarkation updater.

Reimplemented from makVrv::DtCigiBaseEntity.

Member Data Documentation

DtRotorWashModelAgent* makVrv::DtCigiRotorWashEntity::myRotorWashModel

protected

DtRotorWashObjectAgent* makVrv::DtCigiRotorWashEntity::myRotorWashObject

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

std::string makVrv::DtCigiRotorWashEntity::mySchema

protected

DtSignalConnectionManager makVrv::DtCigiRotorWashEntity::myConnections

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation