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::DtOsgRotorWashModel Class Reference

Osg implementation of DtRotorWashModel. More...

Inheritance diagram for makVrv::DtOsgRotorWashModel:
Inheritance graph
[legend]

Public Member Functions

 DtOsgRotorWashModel (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtOsgRotorWashModel ()
 DTOR. More...
 
virtual const std::string & className () const
 Get the class name of the model instance owner. More...
 
virtual void setPosition (int vtx, const DtVector &position)
 Sets the position of the rotor wash. More...
 
- Public Member Functions inherited from makVrv::DtRotorWashModel
 DtRotorWashModel (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtRotorWashModel ()
 DTOR. More...
 
virtual void setModelDefinition (const std::string &def)
 Override the set model definition function. More...
 
virtual void setIsSupportModel (bool isSupport)
 Unused, but required for all DtModels. 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 rotor wash system via an offset vector (x,y,z) 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 setIntensity (const float intensity)
 Set intensity of system 0 is no intensity, 1 is full intensity See. More...
 
virtual void setRotorWashDir (DtVector dir)
 Set direction of coming out of the bottom of the helicopter to aid in positioning the rotorwash. 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 setDefaultRotorDiameter (double diameter)
 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) More...
 
virtual double defaultRotorDiameter () 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 setDefaultRotorWindSpeed (double speed)
 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) More...
 
virtual double defaultRotorWindSpeed () const
 
virtual void setHelicopterID (DtUniqueID helicopterID)
 Set/get the helicopter ID this rotorwash is attached to. More...
 
virtual DtUniqueID helicopterID ()
 
- Public Member Functions inherited from makVrv::DtModel
 DtModel (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtModel ()
 DTOR. More...
 
DtModelInstancecreateModelInstance (const std::string &modelDefName, bool realize=true)
 Set the model definition and creates an instance of the model. More...
 
virtual const std::string & modelDefinitionName ()
 returns the model definition name. More...
 
virtual void saveModelToFile (const std::string &filename)
 
unsigned int transformSize () const
 Get the number of position/orientations this model has. More...
 
virtual const DtVectorposition (int vtx=0) const
 Get the Position of a given point. More...
 
virtual void removePosition (int vtx)
 Remove a transform at the given position. More...
 
virtual void setPositionOffset (const DtVector &positionOffset)
 Set the position offset of the model. More...
 
virtual const DtVectorpositionOffset () const
 Get the Position Offset of the model. More...
 
virtual void setOrientation (int vtx, const DtTaitBryan &orientation)
 Set the orientation of a vertex in the model. More...
 
virtual void setPositionAndOrientation (int vtx, const DtVector &positionOffset, const DtTaitBryan &orientation)
 Set the position and orientation of a vertex in the model at the same time. More...
 
virtual const DtTaitBryan & orientation (int vtx=0) const
 Get the Orientation of a given point. More...
 
virtual void setOrientationOffset (const DtTaitBryan &orientationOffset)
 Set the Orientation Offset of the model. More...
 
virtual const DtTaitBryan & orientationOffset () const
 Get the Orientation Offset of the model. More...
 
virtual void enableColorBlending (bool b)
 Enable / disable color blending for this model. More...
 
virtual void setBlendColor (float r, float g, float b, float a)
 Set color to use if color blending is enabled. More...
 
virtual void getBlendColor (float &r, float &g, float &b, float &a)
 Returns the blend color. More...
 
virtual bool colorBlendingEnabled () const
 Returns whether or not blending is enabled. More...
 
virtual void setColor (float r, float g, float b, float a)
 set the model's color More...
 
virtual void enableLighting (bool l)
 set whether the model is lit; this may not be an option on all models More...
 
virtual int modelSet () const
 Get the model set this model is part of. More...
 
const DtVectorboundingBoxExtents () const
 Get the bounding box extents of the model instance. More...
 
void getBoundingBoxExtents (double &x, double &y, double &z) const
 Get the bounding box extents of the model instance. More...
 
const DtVectorboundingBoxCenter () const
 Get the bounding box center of the model instance. More...
 
virtual void getBoundingBoxCenter (double &x, double &y, double &z) const
 Get the bounding box center of the model instance. More...
 
virtual void getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
 Get the minimum and maximum X,Y,Z components of the bounding box. More...
 
void setContributesToBound (bool trueOrFalse)
 Set whether this model instance contributes to an object's overall bounding volume. More...
 
bool contributesToBound () const
 Get whether this model instance contributes to an object's overall bounding volume. More...
 
DtDede ()
 Get the DtDe object. More...
 
virtual void setModelInstance (DtModelInstance *modelInstance)
 Internally set the model instance pointer. More...
 
virtual void promoteBackgroundModelInstance (DtModelDefinition &defintion)
 Internally set the model instance pointer to the background one, also realizes and sends signal. More...
 
virtual bool visible () const
 Get the visible state of the model. More...
 
DtUniqueID parentSceneObjectID () const
 Parent of the model. More...
 
virtual void addedToSceneObjectAsProp (const DtUniqueID &sceneObj)
 Called when a scene object added the model as a prop. More...
 
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. More...
 
virtual void setElementId (DtUniqueID id)
 Called when the element ID of the model's parent object is set. More...
 
virtual void removedFromSceneObject ()
 Called when the model was removed from a scene object. More...
 
virtual void setSolid (bool isSolid)
 Set whether or not other this model is drawn filled in. More...
 
virtual bool isProp ()
 Return whether or not this model was added as a prop. More...
 
virtual void updateMinLastFrameDistance (float distance)
 updates the closest distance to an observer over the last frame More...
 
virtual void resetLastFrameDistance ()
 resets the closest distance to an observer More...
 
virtual float minLastFrameDistance () const
 gets the closest distance to an observer last frame More...
 
virtual DtModelInstancemodelInstance ()
 Get the model instance. More...
 
virtual const DtModelInstancemodelInstance () const
 
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. More...
 
virtual bool supportsMultithreadedLoad ()
 can be quickly overridden to disable background loading More...
 
virtual void backgroundLoad ()
 the chunk of loading that can safely happen in the background More...
 
virtual void foregroundLoad ()
 the chunk of loading that must happen happen in the foreground, adding to scene graph etc. More...
 
virtual bool isActivelyBackgroundLoading ()
 is this being actively loaded (it has a myInLoadQueueHandle object and it's loading) More...
 
virtual DtLoaderHandlegetLoadQueueHandle ()
 returns the load queue object More...
 

Protected Member Functions

virtual void addToScene (const DtUniqueID &id, int modelSet, int visualizerType)
 Attaches the model to the scene If this model has a modelinstance, it is attached to the scene. More...
 
virtual void removeFromScene ()
 Detaches the model to the scene If this model has a modelinstance, it is detached to the scene. More...
 
- Protected Member Functions inherited from makVrv::DtRotorWashModel
virtual
DtRotorWashModelInstanceInterface
rotorWashModelInstanceInterface ()
 Get a properly cast version of the model instance this model creates. More...
 
virtual const
DtRotorWashModelInstanceInterface
rotorWashModelInstanceInterface () const
 Get a properly cast const version of the model instance this model creates. More...
 
virtual DtVector currentHeloPosition () const
 Get the helo's current position that this rotorWash is attached to. More...
 
virtual DtTaitBryan currentHeloOrientation () const
 Ge 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...
 
virtual void calcRotorWashSystemDefaults ()
 Set default values for rotor wash. More...
 
virtual void setIsOverWater (bool overWater)
 Called by the rotorWash updater to tell us if we are over water. More...
 
virtual bool anyObserverMimic ()
 We don't want to hide the rotorwash when in mimic mode so check if any observer in is mimic or mimic track. More...
 
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. More...
 
- Protected Member Functions inherited from makVrv::DtModel
virtual void addToSceneAsProp (const DtUniqueID &sceneObjectId)
 Add this model to the scene as a prop. More...
 
virtual void initializeModelInstance ()
 Push any state maintained by the model to the model instance. More...
 
void slot_modelInstanceChanged (DtModelInstance *instance)
 Called when the model instance changed. More...
 
virtual void waitAndClearLoadHandle ()
 avoids race condition, on destruction subclasses need to wait for the model to cleanly finish loading this can happen if an object times in and out very quickly More...
 
virtual void removedFromLoadQueue ()
 deletes the myInLoadQueueHandle handle More...
 
virtual void setDoneBackgroundLoading ()
 called by async task, updates myCurrentlyLoading atomic More...
 
virtual void setActivelyBackgroundLoading ()
 called right before tbb task creation More...
 

Protected Attributes

DtOsgSceneConnectormySceneConnector
 
- Protected Attributes inherited from makVrv::DtRotorWashModel
DtSignalConnectionManager myConnections
 
bool myRotorWashStopped
 
DtUniqueID myHelicopterID
 
- Protected Attributes inherited from makVrv::DtModel
DtLoaderHandlemyInLoadQueueHandle
 
DtDemyDe
 
const DtUniqueID myUniqueId
 The unique id is constant after initialization. More...
 
bool myColorBlendingEnabled
 The color blending enabled is needed to be set by the derived class so it doesn't get down to the model instances when instancing is enabled. More...
 
DtModelInstancemyBackgroundModelInstance
 holds the model created in the background for a bit More...
 
float myMinLastFrameDistance
 last frames mimimal distance to the camera, calculated by the instancing system More...
 
TransformList myTransforms
 We keep our own copy in case we get updates before we get a model instance. More...
 
DtModelInstancemyModelInstance
 
int myModelSet
 
int myVisualizerType
 
bool myContributesToBound
 
DtUniqueID myParentSceneObjectID
 
bool myIsPropFlag
 
float myBlendColor [4]
 
bool myVisibleFlag
 
DtVector myPositionOffset
 
DtTaitBryan myOrientationOffset
 
std::string myModelDefinitionName
 

Private Member Functions

 DtOsgRotorWashModel (const DtOsgRotorWashModel &other)
 Copy Constructor not implemented – Copy Not Allowed. More...
 
DtOsgRotorWashModeloperator= (const DtOsgRotorWashModel &other)
 Assignment Operator Not implemented – Assignment Not Allowed. More...
 

Additional Inherited Members

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

Detailed Description

Osg implementation of DtRotorWashModel.

Used for adding rotorwash to the osg scene graph. The rotorWash can be from Triton (water) or the particle system (land) The water rotorwash uses the

See Also
DtTritonRotorWashModelInstance. The land uses the
DtParticleRotorWashModelInstance. Please see
DtRotorWashModelInstanceInterface for specific API calls for each type.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtOsgRotorWashModel::~DtOsgRotorWashModel ( )
virtual

DTOR.

makVrv::DtOsgRotorWashModel::DtOsgRotorWashModel ( const DtOsgRotorWashModel other)
private

Copy Constructor not implemented – Copy Not Allowed.

Member Function Documentation

DtOsgRotorWashModel& makVrv::DtOsgRotorWashModel::operator= ( const DtOsgRotorWashModel other)
private

Assignment Operator Not implemented – Assignment Not Allowed.

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

Get the class name of the model instance owner.

This is used to control how model instances are created.

Reimplemented from makVrv::DtRotorWashModel.

virtual void makVrv::DtOsgRotorWashModel::setPosition ( int  vtx,
const DtVector position 
)
virtual

Sets the position of the rotor wash.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgRotorWashModel::addToScene ( const DtUniqueID id,
int  modelSet,
int  visualizerType 
)
protectedvirtual

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

Reimplemented from makVrv::DtRotorWashModel.

virtual void makVrv::DtOsgRotorWashModel::removeFromScene ( )
protectedvirtual

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

Reimplemented from makVrv::DtRotorWashModel.

Member Data Documentation

DtOsgSceneConnector* makVrv::DtOsgRotorWashModel::mySceneConnector
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)