A model of a triton rotorWash is used to interface with the triton API to generate a Kelvin rotorWash effect. More...

Inheritance diagram for makVrv::DtTritonRotorWashModel:

Public Member Functions
	DtTritonRotorWashModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtTritonRotorWashModel ()
	DTOR.
virtual void	setModelDefinition (const std::string &modelDef)
	Initialize this model from a model-definition.
virtual void	addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)
	AddToScene is called by the scene object with which this model is associated after it has been initialized.
virtual void	removeFromScene ()
	Destroy the triton rotorWash object.
virtual void	setVisible (bool isVisible)
	Set the visible state of the model.
virtual void	setSolid (bool isSolid)
	Unused, but required for all DtModels.

virtual void	setRotorDiameter (double diameter)
	Set/get the diameter of the rotors (tip to tip) generating the wake.
virtual double	rotorDiameter () const
	Set/get the diameter of the rotors (tip to tip) generating the wake.

virtual void	setRotorWindSpeed (double speed)
	Set/get the speed of the down-draft created by the rotors.
virtual double	rotorWindSpeed () const
	Set/get the speed of the down-draft created by the rotors.
Public Member Functions inherited from makVrv::DtRotorWashModel
	DtRotorWashModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtRotorWashModel ()
	DTOR.
Public Member Functions inherited from makVrv::DtModel
	DtModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtModel ()
	DTOR.
virtual void	saveModelToFile (const std::string &filename)
virtual std::string	className () const
	Get the class name of the model instance owner.
unsigned int	transformSize () const
	Get the number of position/orientations this model has.
virtual void	setPosition (int vtx, const DtVector &position)
	Set the position of a control vertex in the model.
virtual void	removePosition (int vtx)
	Remove a transform at the given position.
const DtVector &	position (int vtx=0) const
	Get the Position of a given point.
const DtTaitBryan &	orientation (int vtx=0) const
	Get the Orientation of a given point.
virtual void	setOrientation (int vtx, const DtTaitBryan &orientation)
	Set the orientation of a vertex in the model.
virtual void	enableColorBlending (bool b)
	Enable / disable color blending for this model.
virtual void	setBlendColor (float r, float g, float b, float a)
	Set color to use if color blending is enabled.
virtual void	getBlendColor (float &r, float &g, float &b, float &a)
	Returns the blend color.
virtual bool	colorBlendingEnabled () const
	Returns whether or not blending is enabled.
virtual void	setColor (float r, float g, float b, float a)
	set the model's color
virtual void	enableLighting (bool l)
	set whether the model is lit; this may not be an option on all models
virtual int	modelSet () const
	Get the model set this model is part of.
const DtVector &	boundingBoxExtents () const
	Get the bounding box extents of the model instance.
void	getBoundingBoxExtents (double &x, double &y, double &z) const
	Get the bounding box extents of the model instance.
const DtVector &	boundingBoxCenter () const
	Get the bounding box center of the model instance.
virtual void	getBoundingBoxCenter (double &x, double &y, double &z) const
	Get the bounding box center of the model instance.
virtual void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
	Get the minimum and maximum X,Y,Z components of the bounding box.
void	setContributesToBound (bool trueOrFalse)
	Set whether this model instance contributes to an object's overall bounding volume.
bool	contributesToBound () const
	Get whether this model instance contributes to an object's overall bounding volume.
DtDe &	de ()
	Get the DtDe object.
virtual void	setModelInstance (DtModelInstance *modelInstance)
	Internally set the model instance pointer.
virtual bool	visible () const
	Get the visible state of the model.
DtUniqueID	parentSceneObjectID () const
	Parent of the model.
virtual void	addedToSceneObjectAsProp (const DtUniqueID &sceneObj)
	Called when a scene object added the model as a prop.
virtual void	addedToSceneObject (const DtUniqueID &sceneObj, int modelSet, int visualizerType)
	Called when a scene object added the model with the given model set and visualizer type.
virtual void	removedFromSceneObject ()
	Called when the model was removed from a scene object.
virtual DtModelInstance *	modelInstance ()
	Get the model instance.
virtual const DtModelInstance *	modelInstance () const
	Get the model instance.
int	visualizerType () const
	The visualizer type determines which channel-specific group node this model will be parented to, and consequently, which observer setting will cause it to be rendered in which channel.

Protected Member Functions
virtual DtTritonRotorWashModelInstance *	rotorWashModelInstance ()
	Get a properly cast version of the model instance this model creates.
virtual DtTritonRotorWashModelInstance *	rotorWashModelInstance () const
	Get a properly cast const version of the model instance this model creates.
virtual DtVector	currentHeloPosition () const
	Get the helo's current position that this rotorWash is attached to.
virtual DtTaitBryan	currentHeloOrientation () const
	Ge the helo's current orientation that this rotorWash is attached to.
virtual DtSceneObject *	sceneObject () const
	Get the scene object that owns this model (and the ship's model)
virtual void	calcDefaults ()
	Calculate defaults for geometric parameters based on the ship model's bounding geometry.
virtual void	setIsOverWater (bool overWater)
	Called by the rotorWash updater to tell us if we are over water.
virtual void	slot_oceanAddedToScene ()
	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.

Protected Attributes
DtSignalConnectionManager	myConnections
boost::signalslib::connection	myTritonManagerConnection
std::string	myModelDefinitionName

Friends
class	DtTritonRotorWashUpdater
	Allow the updater to use our protected methods.

Additional Inherited Members
Public Attributes inherited from makVrv::DtModel
boost::signal< void(DtModel *)>	signal_modelToBeDestroyed
	Signal emitted when the model is to be destroyed.
boost::signal< void(DtModel *)>	signal_modelChanged
boost::signal< bool(DtModel *, bool), SlotReturnOR >	signal_visibilityChangeRequested
	Signal when the visibility has been requested, if any slot returns false, it will not change.
boost::signal< void(DtModelInstance , DtModel )>	signal_modelInstanceCreated
	Signal emitted when the model instance is created.
boost::signal< void(DtModelInstance , DtModel )>	signal_modelInstanceToBeDestroyed
	Signal emitted when the model instance is to be destroyed.
Protected Types inherited from makVrv::DtModel
typedef std::vector < ObjectTransform >	TransformList

Detailed Description

A model of a triton rotorWash is used to interface with the triton API to generate a Kelvin rotorWash effect.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtTritonRotorWashModel::~DtTritonRotorWashModel ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtTritonRotorWashModel::setModelDefinition ( const std::string & modelDef )

virtual

Initialize this model from a model-definition.

Implements makVrv::DtRotorWashModel.

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

virtual

Set/get the diameter of the rotors (tip to tip) generating the wake.

Implements makVrv::DtRotorWashModel.

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

virtual

Set/get the diameter of the rotors (tip to tip) generating the wake.

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

virtual

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

Implements makVrv::DtRotorWashModel.

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

virtual

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

virtual void makVrv::DtTritonRotorWashModel::addToScene	(	const DtUniqueID &	sceneObjectId,
		int	modelSet,
		int	visualizerType
	)

virtual

AddToScene is called by the scene object with which this model is associated after it has been initialized.

If the rotorWash should be visible, this will cause the triton rotorWash object to be created

Implements makVrv::DtModel.

virtual void makVrv::DtTritonRotorWashModel::removeFromScene ( )

virtual

Destroy the triton rotorWash object.

Implements makVrv::DtModel.

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

virtual

Set the visible state of the model.

Parameters

[in] isVisible is the new visible state; true = visible, false = hidden.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtTritonRotorWashModel::setSolid ( bool isSolid )

inlinevirtual

Unused, but required for all DtModels.

Implements makVrv::DtModel.

virtual DtTritonRotorWashModelInstance* makVrv::DtTritonRotorWashModel::rotorWashModelInstance ( )

protectedvirtual

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

virtual DtTritonRotorWashModelInstance* makVrv::DtTritonRotorWashModel::rotorWashModelInstance ( ) const

protectedvirtual

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

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

protectedvirtual

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

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

protectedvirtual

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

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

protectedvirtual

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

virtual void makVrv::DtTritonRotorWashModel::calcDefaults ( )

protectedvirtual

Calculate defaults for geometric parameters based on the ship model's bounding geometry.

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

protectedvirtual

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

virtual void makVrv::DtTritonRotorWashModel::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 DtTritonRotorWashUpdater

friend

Allow the updater to use our protected methods.

Member Data Documentation

DtSignalConnectionManager makVrv::DtTritonRotorWashModel::myConnections

protected

boost::signalslib::connection makVrv::DtTritonRotorWashModel::myTritonManagerConnection

protected

std::string makVrv::DtTritonRotorWashModel::myModelDefinitionName

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvTriton/DtTritonRotorWashModel.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