VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
makVrv::DtRotorWashDistributor Class Reference

The DtRotorWashDistributor is used to update the currently active. More...

Public Member Functions

 DtRotorWashDistributor (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtRotorWashDistributor ()
 DTOR. More...
 
virtual const std::string & className () const
 Return the class name of this model. More...
 
void setupRotorWashModel (DtUniqueID helicopterUniqueID, DtUniqueID rwModelUniqueID)
 Lookup local rotor wash model (if it can be found) This needs to be done first before you start calling setRotorDiameter, etc. More...
 
virtual void modelToBeDestroyed (DtModel *model)
 Slot for the model to be destroyed signal. More...
 
virtual void setModelDefinition (const std::string &def)
 Override the set model definition function. More...
 
virtual void start ()
 Start the rotorwash effect. More...
 
virtual void stop ()
 Stop the rotor wash effect. More...
 
virtual void setOffsetPos (const DtVector &offset)
 Position the rotorwash via an offset vector. More...
 
virtual void setVisible (bool isVisible)
 Set the visible state of the model. More...
 
virtual bool isStopped ()
 Get whether the rotorwash has stopped. More...
 
virtual void setHelicopterPos (DtVector modelPos)
 Use for mimic mode so that the helicopter rotorwash position will correspond with the mimic mode model. More...
 
virtual void setHelicopterOri (DtTaitBryan modelOri)
 Use for mimic mode so that the helicopter rotorwash orientation will correspond with the mimic mode model. More...
 
virtual void setIntensity (float intensity)
 Set the speed of the down-draft created by the rotors. More...
 
virtual void setRotorWashDir (DtVector dir)
 Set the direction out of the bottom of the helicopter. More...
 
virtual void update ()
 For updating any values needed for rotor wash. More...
 
virtual void setRotorDiameter (double diameter)
 Set/get the diameter of the rotors (tip to tip) More...
 
virtual double rotorDiameter () const
 
virtual void setRotorWindSpeed (double speed)
 Set/get the speed of the down-draft created by the rotors. More...
 
virtual double rotorWindSpeed () const
 
virtual void setDefaultRotorDiameter (double diameter)
 Set/get the default diameter of the rotors (tip to tip) (default value if no one sets rotor diameter) More...
 
virtual double defaultRotorDiameter () const
 
virtual void setDefaultRotorWindSpeed (double speed)
 Set/get the speed of the down-draft created by the rotors. More...
 
virtual double defaultRotorWindSpeed () const
 

Protected Member Functions

virtual DtVector currentHeloPosition () const
 Get the helo's current position that this rotorWash is attached to. More...
 
virtual DtTaitBryan currentHeloOrientation () const
 Get the helo's current orientation that this rotorWash is attached to. More...
 
virtual DtSceneObjectsceneObject () const
 Get the scene object that owns this model (and the ship's model) More...
 

Protected Attributes

DtDemyDe
 
DtUniqueID myUniqueId
 
DtRotorWashModelmyRotorWashModel
 

Private Member Functions

 DtRotorWashDistributor ()
 Default Constructor not implemented – default constructor not allowed. More...
 
 DtRotorWashDistributor (const DtRotorWashDistributor &)
 Copy Constructor not implemented – Copy not allowed. More...
 
DtRotorWashDistributoroperator= (const DtRotorWashDistributor &)
 Assignment Operator not implemented – Copy not allowed. More...
 

Detailed Description

The DtRotorWashDistributor is used to update the currently active.

See Also
DtRotorWashModel visual effect model (on each display engine) with the current update values from that entity's
DtRotorWashProcess. The
DtRotorWashDistributor will look up the local visual effect model using its agent id and update it.

Constructor & Destructor Documentation

makVrv::DtRotorWashDistributor::DtRotorWashDistributor ( DtDe de,
DtUniqueID  id 
)

CTOR.

virtual makVrv::DtRotorWashDistributor::~DtRotorWashDistributor ( )
virtual

DTOR.

makVrv::DtRotorWashDistributor::DtRotorWashDistributor ( )
private

Default Constructor not implemented – default constructor not allowed.

makVrv::DtRotorWashDistributor::DtRotorWashDistributor ( const DtRotorWashDistributor )
private

Copy Constructor not implemented – Copy not allowed.

Member Function Documentation

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

Return the class name of this model.

void makVrv::DtRotorWashDistributor::setupRotorWashModel ( DtUniqueID  helicopterUniqueID,
DtUniqueID  rwModelUniqueID 
)

Lookup local rotor wash model (if it can be found) This needs to be done first before you start calling setRotorDiameter, etc.

virtual void makVrv::DtRotorWashDistributor::modelToBeDestroyed ( DtModel model)
virtual

Slot for the model to be destroyed signal.

Handle cleanup for this model here

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

Override the set model definition function.

Use this to parse a model after it is loaded.

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

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

virtual double makVrv::DtRotorWashDistributor::rotorDiameter ( ) const
virtual
virtual void makVrv::DtRotorWashDistributor::setRotorWindSpeed ( double  speed)
virtual

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

virtual double makVrv::DtRotorWashDistributor::rotorWindSpeed ( ) const
virtual
virtual void makVrv::DtRotorWashDistributor::setDefaultRotorDiameter ( double  diameter)
virtual

Set/get the default diameter of the rotors (tip to tip) (default value if no one sets rotor diameter)

virtual double makVrv::DtRotorWashDistributor::defaultRotorDiameter ( ) const
virtual
virtual void makVrv::DtRotorWashDistributor::setDefaultRotorWindSpeed ( double  speed)
virtual

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

(default value if no one sets rotor speed)

virtual double makVrv::DtRotorWashDistributor::defaultRotorWindSpeed ( ) const
virtual
virtual void makVrv::DtRotorWashDistributor::start ( )
virtual

Start the rotorwash effect.

virtual void makVrv::DtRotorWashDistributor::stop ( )
virtual

Stop the rotor wash effect.

virtual void makVrv::DtRotorWashDistributor::setOffsetPos ( const DtVector offset)
virtual

Position the rotorwash via an offset vector.

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

Set the visible state of the model.

Parameters
[in]isVisibleis 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
virtual bool makVrv::DtRotorWashDistributor::isStopped ( )
virtual

Get whether the rotorwash has stopped.

virtual void makVrv::DtRotorWashDistributor::setHelicopterPos ( DtVector  modelPos)
virtual

Use for mimic mode so that the helicopter rotorwash position will correspond with the mimic mode model.

virtual void makVrv::DtRotorWashDistributor::setHelicopterOri ( DtTaitBryan  modelOri)
virtual

Use for mimic mode so that the helicopter rotorwash orientation will correspond with the mimic mode model.

virtual void makVrv::DtRotorWashDistributor::setIntensity ( float  intensity)
virtual

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

Only applies to water rotor wash.

virtual void makVrv::DtRotorWashDistributor::setRotorWashDir ( DtVector  dir)
virtual

Set the direction out of the bottom of the helicopter.

virtual void makVrv::DtRotorWashDistributor::update ( )
virtual

For updating any values needed for rotor wash.

virtual DtVector makVrv::DtRotorWashDistributor::currentHeloPosition ( ) const
protectedvirtual

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

virtual DtTaitBryan makVrv::DtRotorWashDistributor::currentHeloOrientation ( ) const
protectedvirtual

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

virtual DtSceneObject* makVrv::DtRotorWashDistributor::sceneObject ( ) const
protectedvirtual

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

DtRotorWashDistributor& makVrv::DtRotorWashDistributor::operator= ( const DtRotorWashDistributor )
private

Assignment Operator not implemented – Copy not allowed.

Member Data Documentation

DtDe& makVrv::DtRotorWashDistributor::myDe
protected
DtUniqueID makVrv::DtRotorWashDistributor::myUniqueId
protected
DtRotorWashModel* makVrv::DtRotorWashDistributor::myRotorWashModel
protected

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)