The interface for a model of a rotorWash.

Inheritance diagram for makVrv::DtRotorWashModel:

Public Member Functions
	DtRotorWashModel (DtDe &de, DtUniqueID id)

virtual	~DtRotorWashModel ()

virtual const std::string &	className () const

virtual void	setModelDefinition (const std::string &def)

virtual void	addToScene (const DtUniqueID &id, DtModelSetId modelSet, int visualizerType)

virtual void	removeFromScene ()

virtual void	setIsSupportModel (bool isSupport)

virtual void	start ()

virtual void	stop ()

virtual void	setOffsetPos (const DtVector &offset)

virtual void	setVisible (bool isVisible)

virtual bool	isStopped ()

virtual void	setIntensity (const float intensity)

virtual void	setRotorWashDir (const DtVector &dir)

virtual void	update ()


virtual void	setRotorDiameter (double diameter)

virtual double	rotorDiameter () const


virtual void	setDefaultRotorDiameter (double diameter)

virtual double	defaultRotorDiameter () const


virtual void	setRotorWindSpeed (double speed)

virtual double	rotorWindSpeed () const


virtual void	setDefaultRotorWindSpeed (double speed)

virtual double	defaultRotorWindSpeed () const


virtual void	setHelicopterID (DtUniqueID helicopterID)

virtual DtUniqueID	helicopterID ()

Public Member Functions inherited from makVrv::DtModel
	DtModel (DtDe &de, DtUniqueID id)

virtual	~DtModel ()

DtModelInstance *	createModelInstance (const std::string &modelDefName, bool realize=true)

virtual const std::string &	modelDefinitionName ()

virtual void	saveModelToFile (const std::string &filename)

virtual DtUniqueID	uniqueId () const

unsigned int	transformSize () const

virtual void	setPosition (int vtx, const DtVector &position)

virtual const DtVector &	position (int vtx=0) const

virtual void	removePosition (int vtx)

virtual void	setPositionOffset (const DtVector &positionOffset)

virtual const DtVector &	positionOffset () const

virtual void	setOrientation (int vtx, const DtTaitBryan &orientation)

virtual void	setPositionAndOrientation (int vtx, const DtVector &positionOffset, const DtTaitBryan &orientation)

virtual const DtTaitBryan &	orientation (int vtx=0) const

virtual void	setOrientationOffset (const DtTaitBryan &orientationOffset)

virtual const DtTaitBryan &	orientationOffset () const

virtual void	enableColorBlending (bool b)

virtual void	setBlendColor (float r, float g, float b, float a)

virtual void	getBlendColor (float &r, float &g, float &b, float &a)

virtual bool	colorBlendingEnabled () const

virtual void	setColor (float r, float g, float b, float a)

virtual void	enableLighting (bool l)

virtual DtModelSetId	modelSet () const

const DtVector &	boundingBoxExtents () const

void	getBoundingBoxExtents (double &x, double &y, double &z) const

const DtVector &	boundingBoxCenter () const

virtual void	getBoundingBoxCenter (double &x, double &y, double &z) const

virtual void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)

void	setContributesToBound (bool trueOrFalse)

bool	contributesToBound () const

DtDe &	de ()

virtual void	setModelInstance (DtModelInstance *modelInstance)

virtual void	promoteBackgroundModelInstance (const DtModelDefinition &defintion)

virtual bool	visible () const

DtUniqueID	sceneObjectId () const

virtual void	addedToSceneObjectAsProp (const DtUniqueID &sceneObj)

virtual void	addedToSceneObject (const DtUniqueID &sceneObj, DtModelSetId modelSet, int visualizerType)

virtual void	setElementId (DtElementID id)

virtual void	removedFromSceneObject ()

virtual void	setSolid (bool isSolid)

virtual bool	isProp ()

virtual void	updateMinLastFrameDistance (float distance)

virtual void	resetLastFrameDistance ()

virtual float	minLastFrameDistance () const

virtual DtModelInstance *	modelInstance ()

virtual const DtModelInstance *	modelInstance () const

int	visualizerType () const

virtual bool	supportsMultithreadedLoad ()

virtual void	backgroundLoad ()

virtual void	foregroundLoad ()

virtual bool	isActivelyBackgroundLoading ()

virtual DtLoaderHandle *	getLoadQueueHandle ()

Protected Member Functions
virtual DtRotorWashModelInstanceInterface *	rotorWashModelInstanceInterface ()

virtual const DtRotorWashModelInstanceInterface *	rotorWashModelInstanceInterface () const

virtual DtVector	currentHeloPosition () const

virtual DtTaitBryan	currentHeloOrientation () const

virtual DtSceneObject *	sceneObject () const

virtual void	calcRotorWashSystemDefaults ()

virtual void	setIsOverWater (bool overWater)

virtual bool	anyObserverMimic ()

virtual void	slot_oceanAddedToScene ()

Protected Member Functions inherited from makVrv::DtModel
virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)

virtual void	initializeModelInstance ()

void	slot_modelInstanceChanged (DtModelInstance *instance)

virtual void	waitAndClearLoadHandle ()

virtual void	removedFromLoadQueue ()

virtual void	setDoneBackgroundLoading ()

virtual void	setActivelyBackgroundLoading ()

Protected Attributes
DtSignalConnectionManager	myConnections

bool	myRotorWashStopped

DtUniqueID	myHelicopterID

Protected Attributes inherited from makVrv::DtModel
DtLoaderHandle *	myInLoadQueueHandle

DtDe &	myDe

const DtUniqueID	myUniqueId

DtUniqueID	myElementId

DtUniqueID	myParentSceneObjectID

bool	myColorBlendingEnabled

DtModelInstance *	myBackgroundModelInstance

float	myMinLastFrameDistance

TransformList	myTransforms

DtModelInstance *	myModelInstance

DtModelSetId	myModelSet

int	myVisualizerType

bool	myContributesToBound

bool	myIsPropFlag

float	myBlendColor [4]

bool	myVisibleFlag

DtVector	myPositionOffset

DtTaitBryan	myOrientationOffset

std::string	myModelDefinitionName

bool	myRequireModelInstance = true

Friends
class	DtRotorWashDistributor

Additional Inherited Members
Public Attributes inherited from makVrv::DtModel
boost::signalslib::signal < void(DtModel *)>	signal_modelToBeDestroyed

boost::signalslib::signal < void(DtModel *)>	signal_modelChanged

boost::signalslib::signal < bool(DtModel *, bool), SlotReturnOR >	signal_visibilityChangeRequested

boost::signalslib::signal < void(DtModelInstance , DtModel )>	signal_modelInstanceCreated

boost::signalslib::signal < void(DtModelInstance , DtModel )>	signal_modelInstanceToBeDestroyed

Protected Types inherited from makVrv::DtModel
typedef std::vector < ObjectTransform >	TransformList

Static Protected Attributes inherited from makVrv::DtModel
static bool	theInittedState

Constructor & Destructor Documentation

makVrv::DtRotorWashModel::DtRotorWashModel	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtRotorWashModel::~DtRotorWashModel ( )

virtual

DTOR.

Member Function Documentation

virtual const std::string& makVrv::DtRotorWashModel::className ( ) const

virtual

Return the class name of this model.

Reimplemented from makVrv::DtModel.

Reimplemented in makVrv::DtOsgRotorWashModel.

virtual void makVrv::DtRotorWashModel::setModelDefinition ( const std::string & def )

virtual

Override the set model definition function. Use this to parse a model after it is loaded.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtRotorWashModel::setRotorDiameter ( double diameter )

virtual

Set/get the diameter of the rotors (tip to tip)

virtual double makVrv::DtRotorWashModel::rotorDiameter ( ) const

virtual

Set/get the diameter of the rotors (tip to tip)

virtual void makVrv::DtRotorWashModel::setDefaultRotorDiameter ( double diameter )

virtual

Set/get the default diameter of the rotors (tip to tip) if setRotorDiameter is not called (returns -1 if no rotor diameter or default diameter set)

virtual double makVrv::DtRotorWashModel::defaultRotorDiameter ( ) const

virtual

Set/get the default diameter of the rotors (tip to tip) if setRotorDiameter is not called (returns -1 if no rotor diameter or default diameter set)

virtual void makVrv::DtRotorWashModel::setRotorWindSpeed ( double speed )

virtual

Set/get the speed of the down-draft created by the rotors.

virtual double makVrv::DtRotorWashModel::rotorWindSpeed ( ) const

virtual

Set/get the speed of the down-draft created by the rotors.

virtual void makVrv::DtRotorWashModel::setDefaultRotorWindSpeed ( double speed )

virtual

Set/get the default speed of the down-draft created by the rotors if setRotorWindSpeed is not called (returns -1 if no rotor wind speed or default rotor wind speed set)

virtual double makVrv::DtRotorWashModel::defaultRotorWindSpeed ( ) const

virtual

Set/get the default speed of the down-draft created by the rotors if setRotorWindSpeed is not called (returns -1 if no rotor wind speed or default rotor wind speed set)

virtual void makVrv::DtRotorWashModel::addToScene	(	const DtUniqueID &	id,
		DtModelSetId	modelSet,
		int	visualizerType
	)

virtual

Attaches the model to the scene If this model has a modelinstance, it is attached to the scene.

Implements makVrv::DtModel.

Reimplemented in makVrv::DtOsgRotorWashModel.

virtual void makVrv::DtRotorWashModel::removeFromScene ( )

virtual

Detaches the model to the scene If this model has a modelinstance, it is detached to the scene.

Implements makVrv::DtModel.

Reimplemented in makVrv::DtOsgRotorWashModel.

virtual void makVrv::DtRotorWashModel::setIsSupportModel ( bool isSupport )

virtual

Unused, but required for all DtModels.

Implements makVrv::DtModel.

virtual void makVrv::DtRotorWashModel::start ( )

virtual

Start the rotorwash effect.

virtual void makVrv::DtRotorWashModel::stop ( )

virtual

Stop the rotor wash effect.

virtual void makVrv::DtRotorWashModel::setOffsetPos ( const DtVector & offset )

virtual

Position the rotor wash system via an offset vector (x,y,z)

virtual void makVrv::DtRotorWashModel::setVisible ( bool isVisible )

virtual

Set the visible state of the model.

Parameters

[in] isVisible is the new visible state; true = visible, false = hidden. There is a special case for mimic mode, we want the active rotor wash to continue being visible

Reimplemented from makVrv::DtModel.

virtual bool makVrv::DtRotorWashModel::isStopped ( )

virtual

Get whether the rotorwash has stopped.

virtual void makVrv::DtRotorWashModel::setIntensity ( const float intensity )

virtual

Set intensity of system 0 is no intensity, 1 is full intensity See.

See Also: DtRotorWashModelInstanceInterface

virtual void makVrv::DtRotorWashModel::setRotorWashDir ( const DtVector & dir )

virtual

Set direction of coming out of the bottom of the helicopter to aid in positioning the rotorwash.

virtual void makVrv::DtRotorWashModel::update ( )

virtual

For updating any values needed for rotor wash.

virtual void makVrv::DtRotorWashModel::setHelicopterID ( DtUniqueID helicopterID )

virtual

Set/get the helicopter ID this rotorwash is attached to.

virtual DtUniqueID makVrv::DtRotorWashModel::helicopterID ( )

virtual

Set/get the helicopter ID this rotorwash is attached to.

virtual DtRotorWashModelInstanceInterface* makVrv::DtRotorWashModel::rotorWashModelInstanceInterface ( )

protectedvirtual

Get a properly cast version of the model instance this model creates.

virtual const DtRotorWashModelInstanceInterface* makVrv::DtRotorWashModel::rotorWashModelInstanceInterface ( ) const

protectedvirtual

Get a properly cast const version of the model instance this model creates.

virtual DtVector makVrv::DtRotorWashModel::currentHeloPosition ( ) const

protectedvirtual

Get the helo's current position that this rotorWash is attached to.

virtual DtTaitBryan makVrv::DtRotorWashModel::currentHeloOrientation ( ) const

protectedvirtual

Ge the helo's current orientation that this rotorWash is attached to.

virtual DtSceneObject* makVrv::DtRotorWashModel::sceneObject ( ) const

protectedvirtual

Get the scene object that owns this model (and the ship's model)

virtual void makVrv::DtRotorWashModel::calcRotorWashSystemDefaults ( )

protectedvirtual

Set default values for rotor wash. Defaults can be set multiple times. If someone uses a set function (ex. setRotorDiameter) then setDefaultRotorDiameter doesn't do anything.

virtual void makVrv::DtRotorWashModel::setIsOverWater ( bool overWater )

protectedvirtual

Called by the rotorWash updater to tell us if we are over water.

virtual bool makVrv::DtRotorWashModel::anyObserverMimic ( )

protectedvirtual

We don't want to hide the rotorwash when in mimic mode so check if any observer in is mimic or mimic track.

virtual void makVrv::DtRotorWashModel::slot_oceanAddedToScene ( )

protectedvirtual

If a rotorWash is requested and Triton hasn't been initialized, this model connects to the DtTritonManager's signal_addedToScene signal, and creates the rotorWash (and disconnects) when the signal is raised.

Friends And Related Function Documentation

friend class DtRotorWashDistributor

friend

Member Data Documentation

DtSignalConnectionManager makVrv::DtRotorWashModel::myConnections

protected

bool makVrv::DtRotorWashModel::myRotorWashStopped

protected

DtUniqueID makVrv::DtRotorWashModel::myHelicopterID

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCore/DtRotorWashModel.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