VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | Friends
makVrv::DtModel Class Referenceabstract

A model which owns a single model instance. More...

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

Classes

struct  ObjectTransform
 

Public Member Functions

 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 void setModelDefinition (const std::string &str)
 Set the model definition. More...
 
virtual const std::string & modelDefinitionName ()
 returns the model definition name. More...
 
virtual void saveModelToFile (const std::string &filename)
 
virtual const std::string & className () const
 Get the class name of the model instance owner. More...
 
unsigned int transformSize () const
 Get the number of position/orientations this model has. More...
 
virtual void setPosition (int vtx, const DtVector &position)
 Set the position of a control vertex in the model. 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 void setVisible (bool isVisible)
 Set the visible state of the model. 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 setIsSupportModel (bool isSupport)=0
 Is this model part of the support group? (determines whether or not other scene objects can ground clamp to this model) 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...
 
abstract virtual api needs to be implemented by subclasses
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...
 

Public Attributes

boost::signal< void(DtModel *)> signal_modelToBeDestroyed
 Signal emitted when the model is to be destroyed. More...
 
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. More...
 
boost::signal< void(DtModelInstance
*, DtModel *)> 
signal_modelInstanceCreated
 Signal emitted when the model instance is created. More...
 
boost::signal< void(DtModelInstance
*, DtModel *)> 
signal_modelInstanceToBeDestroyed
 Signal emitted when the model instance is to be destroyed. More...
 

Protected Types

typedef std::vector
< ObjectTransform
TransformList
 

Protected Member Functions

virtual void addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)=0
 Virtual Functions to be implemented, add this model to the scene. More...
 
virtual void addToSceneAsProp (const DtUniqueID &sceneObjectId)
 Add this model to the scene as a prop. More...
 
virtual void removeFromScene ()=0
 Virtual Functions to be implemented, remove this model from the scene. 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

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
 

Static Protected Attributes

static bool theInittedState
 

Private Member Functions

void deleteModelInstance ()
 Delete the model instance (and emit signal_modelToBeDestroyed) More...
 

Friends

class DtBackgroundLoader
 
class DtBackgroundLoadAsyncTask
 

Detailed Description

A model which owns a single model instance.

A DtModel is a managing container for a single DtModelInstance, providing more attributes about how the DtModelInstance should be rendered. Initialization of a DtModel starts with giving it a model-definition. Unlike the DtModelInstance which can be handed a model-definition identifying the model to load, the DtModel retrieves a model-definition which has been pre-loaded into a definition-manager. Usually DtModelDefinition objects are automatically loaded from disk to populate the definition-manager.

Member Typedef Documentation

typedef std::vector<ObjectTransform> makVrv::DtModel::TransformList
protected

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtModel::~DtModel ( )
virtual

DTOR.

Member Function Documentation

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

Set the model definition and creates an instance of the model.

virtual void makVrv::DtModel::setModelDefinition ( const std::string &  str)
virtual
virtual const std::string& makVrv::DtModel::modelDefinitionName ( )
inlinevirtual

returns the model definition name.

virtual void makVrv::DtModel::saveModelToFile ( const std::string &  filename)
virtual
virtual const std::string& makVrv::DtModel::className ( ) const
virtual
virtual DtModelInstance* makVrv::DtModel::modelInstance ( )
virtual

Get the model instance.

virtual const DtModelInstance* makVrv::DtModel::modelInstance ( ) const
virtual
unsigned int makVrv::DtModel::transformSize ( ) const

Get the number of position/orientations this model has.

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

Set the position of a control vertex in the model.

Reimplemented in makVrv::DtOsgOverlayWedgeModel, makVrv::DtOsgOverlaySpiderWebModel, makVrv::DtOsgOverlayArcModel, makVrv::DtOsgEllipsoidArcModel, makVrv::DtOsg2DVolumetricLineModel, makVrv::DtOsg3DVolumetricLineModel, makVrv::DtOsgArticulatedModel, makVrv::DtDiGuyCharacterModel, makVrv::DtOsgOverlayEllipseArcModel, makVrv::DtOsgScribeBoxModel, makVrv::DtOsgRectangularPyramidModel, makVrf::DtVrfOverlayEllipseArcModel, makVrf::DtRadarCoverageModel, makVrv::DtOsgRibbonModel, makVrv::DtOsgParticleSystemModel, makVrv::DtOsgAttachableCuboidModel, makVrv::DtOsgAttachableEllipsoidModel, makVrv::DtOsgOverlayPolygonModel, makVrv::DtMovablePolygonModel, makVrv::DtOsgDecalModel, makVrv::DtEllipsoidArcModel, makVrv::DtOsgArticulatingCylinderModel, makVrv::DtOsgProjectedWidgetModel, makVrv::DtOsgCylinderModel, makVrv::DtOsgTacticalSmokeModel, makVrv::DtOsgAnimationModel, makVrv::DtOsgPinnableProjectedWidgetModel, makVrv::DtOsgPolygonModel, makVrv::DtTacticalSmokeModel, makVrv::DtOsgSimpleModel, makVrv::DtOsgExtrudedEllipseModel, makVrv::DtOsgExtrudedPolygonModel, makVrv::DtOsgProjectedTextModel, makVrv::DtOsgDrawModel, makVrv::DtOsgRotorWashModel, makVrv::DtOsg3DTextModel, makVrv::DtOsgExtrudedLineModel, makVrv::DtOsgOverlayRectangleModel, makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsg3DGreatCircleArcModel, makVrv::DtOsgOverlayGreatCircleArcModel, makVrv::DtOsgOverlaySegmentedLineModel, makVrv::DtOsgOverlayDirectionLineModel, and makVrv::DtExampleModel.

virtual const DtVector& makVrv::DtModel::position ( int  vtx = 0) const
virtual

Get the Position of a given point.

Exceptions
DtCorruptedStateif the vtx is not with-in the normal bounds.
virtual void makVrv::DtModel::removePosition ( int  vtx)
virtual
virtual void makVrv::DtModel::setPositionOffset ( const DtVector positionOffset)
virtual

Set the position offset of the model.

This offsets the position of the entire model. N.B. Currently only used by DtCharacterModel and DtArticulatedModel

Reimplemented in makVrv::DtDummyCharacterModel, makVrv::DtOsgArticulatedModel, makVrv::DtDiGuyCharacterModel, makVrv::DtOsgOverlayDirectionLineModel, makVrv::DtOsgSimpleModel, and makVrv::DtOsgDecalModel.

virtual const DtVector& makVrv::DtModel::positionOffset ( ) const
virtual

Get the Position Offset of the model.

virtual void makVrv::DtModel::setOrientation ( int  vtx,
const DtTaitBryan &  orientation 
)
virtual
virtual void makVrv::DtModel::setPositionAndOrientation ( int  vtx,
const DtVector positionOffset,
const DtTaitBryan &  orientation 
)
virtual

Set the position and orientation of a vertex in the model at the same time.

Reimplemented in makVrv::DtDiGuyCharacterModel.

virtual const DtTaitBryan& makVrv::DtModel::orientation ( int  vtx = 0) const
virtual

Get the Orientation of a given point.

Exceptions
DtCorruptedStateif the vtx is not with-in the normal bounds.
virtual void makVrv::DtModel::setOrientationOffset ( const DtTaitBryan &  orientationOffset)
virtual

Set the Orientation Offset of the model.

This offsets the orientation of the entire model. N.B. Currently only used by DtCharacterModel and DtArticulatedModel

Reimplemented in makVrv::DtDummyCharacterModel, makVrv::DtDiGuyCharacterModel, makVrv::DtOsgArticulatedModel, and makVrv::DtOsgSimpleModel.

virtual const DtTaitBryan& makVrv::DtModel::orientationOffset ( ) const
virtual

Get the Orientation Offset of the model.

virtual void makVrv::DtModel::enableColorBlending ( bool  b)
virtual

Enable / disable color blending for this model.

Reimplemented in makVrv::DtOsgArticulatedModel, makVrv::DtOsgSimpleModel, and makVrv::DtOsgPolygonModel.

virtual void makVrv::DtModel::setBlendColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

Set color to use if color blending is enabled.

Reimplemented in makVrv::DtOsgArticulatedModel, and makVrv::DtOsgSimpleModel.

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

Returns the blend color.

virtual bool makVrv::DtModel::colorBlendingEnabled ( ) const
virtual

Returns whether or not blending is enabled.

virtual void makVrv::DtModel::setColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

set the model's color

Reimplemented in makVrv::DtOsgArticulatedModel, makVrv::DtOverlayWedgeModel, makVrv::DtOsgOverlayWedgeModel, makVrv::DtOverlaySpiderWebModel, makVrv::DtOverlayArcModel, makVrv::DtOsgOverlaySpiderWebModel, makVrv::DtOsgOverlayArcModel, makVrv::DtOsgRectangularPyramidModel, makVrv::DtOsgRibbonModel, makVrv::DtOsgEllipsoidArcModel, makVrv::DtOsgDecalModel, makVrv::DtRectangularPyramidModel, makVrv::DtOsgExtrudedPolygonModel, makVrv::DtOsgExtrudedLineModel, makVrv::DtPolygonModel, makVrv::DtOsgExtrudedEllipseModel, makVrv::DtOsgScribeBoxModel, makVrv::DtOsgAttachableCuboidModel, makVrv::DtOsgAttachableEllipsoidModel, makVrv::DtOsg3DSegmentedLineModel, makVrv::Dt3DVolumetricLineModel, makVrv::DtOsgCylinderModel, makVrf::DtVrfOverlayEllipseArcModel, makVrv::Dt2DVolumetricLineModel, makVrv::DtOsg3DVolumetricLineModel, makVrv::DtOsgArticulatingCylinderModel, makVrv::DtOsg3DTextModel, makVrv::DtOsgOverlayGreatCircleArcModel, makVrv::DtOsgOverlaySegmentedLineModel, makVrv::DtEllipsoidArcModel, makVrv::DtOverlayEllipseArcModel, makVrv::DtOsgOverlayEllipseArcModel, makVrv::DtOsg3DGreatCircleArcModel, makVrv::DtOsg2DVolumetricLineModel, makVrv::DtOsgPolygonModel, makVrv::DtOsgOverlayDirectionLineModel, makVrv::DtOsgOverlayRectangleModel, makVrv::DtAttachableCuboidModel, makVrv::DtOsgOverlayPolygonModel, makVrv::DtCylinderModel, makVrv::DtScribeBoxModel, makVrv::DtAttachableEllipsoidModel, makVrf::DtSensorContactLinesModel, makVrv::Dt3DTextModel, makVrv::DtArticulatingCylinderModel, and makVrv::DtLineModel.

virtual void makVrv::DtModel::enableLighting ( bool  l)
virtual

set whether the model is lit; this may not be an option on all models

Reimplemented in makVrv::DtOsgPolygonModel.

virtual int makVrv::DtModel::modelSet ( ) const
virtual

Get the model set this model is part of.

const DtVector& makVrv::DtModel::boundingBoxExtents ( ) const

Get the bounding box extents of the model instance.

void makVrv::DtModel::getBoundingBoxExtents ( double x,
double y,
double z 
) const

Get the bounding box extents of the model instance.

const DtVector& makVrv::DtModel::boundingBoxCenter ( ) const

Get the bounding box center of the model instance.

virtual void makVrv::DtModel::getBoundingBoxCenter ( double x,
double y,
double z 
) const
virtual

Get the bounding box center of the model instance.

virtual void makVrv::DtModel::getBoundingBoxComponents ( DtVector minimum,
DtVector maximum 
)
virtual

Get the minimum and maximum X,Y,Z components of the bounding box.

Reimplemented in makVrv::DtOsgArticulatedModel, and makVrv::DtOsgSimpleModel.

void makVrv::DtModel::setContributesToBound ( bool  trueOrFalse)

Set whether this model instance contributes to an object's overall bounding volume.

bool makVrv::DtModel::contributesToBound ( ) const

Get whether this model instance contributes to an object's overall bounding volume.

int makVrv::DtModel::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.

DtDe& makVrv::DtModel::de ( )
inline

Get the DtDe object.

virtual void makVrv::DtModel::setModelInstance ( DtModelInstance modelInstance)
virtual

Internally set the model instance pointer.

If an existing model instance is set, it will be deleted. To clear the current model instance only, passing a Null pointer 0 is supported.

Warning
Only public for internal use
Parameters
Input
modelInstancepointer to a model instance.

Reimplemented in makVrv::MyParticleSystemModel, makVrv::DtOsg3DTextModel, makVrv::DtOsgRibbonModel, and makVrv::DtOsgDecalModel.

virtual void makVrv::DtModel::promoteBackgroundModelInstance ( DtModelDefinition defintion)
virtual

Internally set the model instance pointer to the background one, also realizes and sends signal.

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

Set the visible state of the model.

Parameters
[in]isVisibleis the new visible state; true = visible, false = hidden.

Reimplemented in makVrv::DtTritonWakeModel, makVrv::DtDummyCharacterModel, makVrv::DtOsgOverlayPolygonModel, makVrv::DtOsgOverlaySegmentedLineModel, makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsgArticulatedModel, makVrv::DtOsg3DGreatCircleArcModel, makVrv::DtOverlayWedgeModel, makVrv::DtOsg3DVolumetricLineModel, makVrv::DtOsgOverlayWedgeModel, makVrv::DtOsgExtrudedPolygonModel, makVrv::DtOsgEllipsoidArcModel, makVrv::DtOsgRibbonModel, makVrv::DtOverlaySpiderWebModel, makVrv::DtTritonTidalStreamWakeModel, makVrv::DtOsgExtrudedLineModel, makVrv::DtOsgOverlaySpiderWebModel, makVrv::DtRotorWashModel, makVrv::DtOsg2DVolumetricLineModel, makVrv::DtOverlayArcModel, makVrv::DtOsgOverlayGreatCircleArcModel, makVrv::DtOsgExtrudedEllipseModel, makVrv::DtOsgParticleSystemModel, makVrv::DtOsgOverlayArcModel, makVrv::DtOsgDecalModel, makVrv::DtOsgPolygonModel, makVrv::DtOsgAnimationModel, makVrv::DtOsgScribeBoxModel, makVrv::DtOsgOverlayDirectionLineModel, makVrv::DtOsgCylinderModel, makVrv::DtOsgTacticalSmokeModel, makVrv::DtOsgProjectedWidgetModel, makVrv::DtOsgPinnableProjectedWidgetModel, makVrv::DtOsgAttachableCuboidModel, makVrv::DtOsgAttachableEllipsoidModel, makVrv::DtOsgProjectedTextModel, makVrf::DtVrfOverlayEllipseArcModel, makVrv::DtMultiLineModel, makVrv::DtMovablePolygonModel, makVrv::DtOsgArticulatingCylinderModel, makVrv::DtOsgSimpleModel, makVrf::DtRadarCoverageModel, makVrv::DtOsgDrawModel, makVrv::DtOsg3DTextModel, and makVrv::DtExampleModel.

virtual bool makVrv::DtModel::visible ( ) const
virtual

Get the visible state of the model.

Return values
trueif set visible.
falseotherwise.
See Also
setVisible()
DtUniqueID makVrv::DtModel::parentSceneObjectID ( ) const

Parent of the model.

virtual void makVrv::DtModel::addedToSceneObjectAsProp ( const DtUniqueID sceneObj)
virtual

Called when a scene object added the model as a prop.

virtual void makVrv::DtModel::addedToSceneObject ( const DtUniqueID sceneObj,
int  modelSet,
int  visualizerType 
)
virtual

Called when a scene object added the model with the given model set and visualizer type.

virtual void makVrv::DtModel::setElementId ( DtUniqueID  id)
virtual

Called when the element ID of the model's parent object is set.

No-op by default

Reimplemented in makVrv::DtOsgArticulatedModel, and makVrv::DtOsgSimpleModel.

virtual void makVrv::DtModel::removedFromSceneObject ( )
virtual

Called when the model was removed from a scene object.

virtual void makVrv::DtModel::setIsSupportModel ( bool  isSupport)
pure virtual

Is this model part of the support group? (determines whether or not other scene objects can ground clamp to this model)

Implemented in makVrv::DtOsgArticulatedModel, makVrv::DtDiGuyCharacterModel, makVrv::DtOsgOverlayWedgeModel, makVrv::DtTritonWakeModel, makVrv::DtOsgOverlaySpiderWebModel, makVrv::DtOsgEllipsoidArcModel, makVrv::DtOsgExtrudedLineModel, makVrv::DtOsgRectangularPyramidModel, makVrv::DtOsgOverlayArcModel, makVrv::DtOsgOverlaySegmentedLineModel, makVrv::DtOsgOverlayEllipseArcModel, makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsg3DVolumetricLineModel, makVrv::DtRectangularPyramidModel, makVrv::DtOsg3DGreatCircleArcModel, makVrv::DtDummyCharacterModel, makVrv::DtOsgRibbonModel, makVrv::DtMultiLineModel, makVrv::DtTritonTidalStreamWakeModel, makVrv::DtOsgOverlayPolygonModel, makVrv::DtOsg2DVolumetricLineModel, makVrv::DtOsgExtrudedPolygonModel, makVrv::DtOsgParticleSystemModel, makVrf::DtRadarCoverageModel, makVrv::DtTritonWaterImpactModel, makVrv::DtOsgDecalModel, makVrv::DtOsgOverlayGreatCircleArcModel, makVrv::DtOsgPolygonModel, makVrv::DtOsgAnimationModel, makVrv::DtOsgScribeBoxModel, makVrv::DtOsgExtrudedEllipseModel, makVrv::DtOsgSimpleModel, makVrv::DtOsgOverlayRectangleModel, makVrv::DtRotorWashModel, makVrv::DtOsgAttachableCuboidModel, makVrv::DtOsgAttachableEllipsoidModel, makVrv::DtOsgCylinderModel, makVrv::DtOsgTacticalSmokeModel, makVrv::DtOsgArticulatingCylinderModel, makVrv::DtOsgProjectedWidgetModel, makVrv::DtOsgPinnableProjectedWidgetModel, makVrv::DtOsgOverlayDirectionLineModel, makVrv::DtFxParticleCollisionObjectModel, makVrv::DtOsg3DTextModel, makVrv::DtOsgProjectedTextModel, makVrv::DtOsgDrawModel, and makVrv::DtExampleModel.

virtual void makVrv::DtModel::setSolid ( bool  isSolid)
virtual
virtual bool makVrv::DtModel::isProp ( )
virtual

Return whether or not this model was added as a prop.

virtual bool makVrv::DtModel::supportsMultithreadedLoad ( )
inlinevirtual

can be quickly overridden to disable background loading

Reimplemented in makVrv::DtArticulatedModel, makVrv::DtParticleSystemModel, and makVrv::DtAnimationModel.

virtual void makVrv::DtModel::backgroundLoad ( )
inlinevirtual

the chunk of loading that can safely happen in the background

Reimplemented in makVrv::DtOsgArticulatedModel, makVrv::DtOsgParticleSystemModel, and makVrv::DtOsgAnimationModel.

virtual void makVrv::DtModel::foregroundLoad ( )
inlinevirtual

the chunk of loading that must happen happen in the foreground, adding to scene graph etc.

Reimplemented in makVrv::DtOsgArticulatedModel, makVrv::DtOsgParticleSystemModel, and makVrv::DtOsgAnimationModel.

virtual bool makVrv::DtModel::isActivelyBackgroundLoading ( )
virtual

is this being actively loaded (it has a myInLoadQueueHandle object and it's loading)

virtual DtLoaderHandle* makVrv::DtModel::getLoadQueueHandle ( )
virtual

returns the load queue object

virtual void makVrv::DtModel::updateMinLastFrameDistance ( float  distance)
virtual

updates the closest distance to an observer over the last frame

virtual void makVrv::DtModel::resetLastFrameDistance ( )
virtual

resets the closest distance to an observer

virtual float makVrv::DtModel::minLastFrameDistance ( ) const
virtual

gets the closest distance to an observer last frame

virtual void makVrv::DtModel::addToScene ( const DtUniqueID sceneObjectId,
int  modelSet,
int  visualizerType 
)
protectedpure virtual

Virtual Functions to be implemented, add this model to the scene.

Implemented in makVrv::DtOsgArticulatedModel, makVrv::DtOsgOverlayWedgeModel, makVrv::DtTritonWakeModel, makVrv::DtOsgExtrudedPolygonModel, makVrv::DtOsgExtrudedEllipseModel, makVrv::DtOsgOverlaySpiderWebModel, makVrv::DtOsgOverlayArcModel, makVrv::DtOsgExtrudedLineModel, makVrv::DtOsgOverlayGreatCircleArcModel, makVrv::DtOsg3DGreatCircleArcModel, makVrv::DtOsgEllipsoidArcModel, makVrv::DtOsg3DVolumetricLineModel, makVrv::DtOsgOverlayPolygonModel, makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsgOverlaySegmentedLineModel, makVrv::DtOsgOverlayRectangleModel, makVrv::DtOsgOverlayEllipseArcModel, makVrv::DtOsgPolygonModel, makVrv::DtOsgParticleSystemModel, makVrv::DtOsgTacticalSmokeModel, makVrv::DtOsgScribeBoxModel, makVrv::DtMultiLineModel, makVrv::DtOsgAnimationModel, makVrv::DtDiGuyCharacterModel, makVrv::DtTritonTidalStreamWakeModel, makVrv::DtOsg2DVolumetricLineModel, makVrv::DtTritonWaterImpactModel, makVrf::DtRadarCoverageModel, makVrv::DtOsgAttachableCuboidModel, makVrv::DtOsgAttachableEllipsoidModel, makVrv::DtOsgOverlayDirectionLineModel, makVrv::DtOsgCylinderModel, makVrv::DtOsgArticulatingCylinderModel, makVrv::DtOsgRibbonModel, makVrv::DtOsgSimpleModel, makVrv::DtOsg3DTextModel, makVrv::DtRotorWashModel, makVrv::DtOsgProjectedTextModel, makVrf::DtVrfOverlayEllipseArcModel, makVrv::DtOsgDecalModel, makVrv::DtExampleModel, makVrv::DtFxParticleCollisionObjectModel, makVrv::DtOsgDrawModel, makVrv::DtOsgRectangularPyramidModel, makVrv::DtOsgRotorWashModel, makVrv::DtDummyCharacterModel, makVrv::DtOsgProjectedWidgetModel, and makVrv::DtOsgPinnableProjectedWidgetModel.

virtual void makVrv::DtModel::addToSceneAsProp ( const DtUniqueID sceneObjectId)
inlineprotectedvirtual

Add this model to the scene as a prop.

All models are not required to re-implement this

Reimplemented in makVrv::DtOsgParticleSystemModel, makVrv::DtOsgScribeBoxModel, and makVrv::DtOsgSimpleModel.

virtual void makVrv::DtModel::removeFromScene ( )
protectedpure virtual

Virtual Functions to be implemented, remove this model from the scene.

Implemented in makVrv::DtOsgArticulatedModel, makVrv::DtOsgOverlayWedgeModel, makVrv::DtTritonWakeModel, makVrv::DtOsgExtrudedPolygonModel, makVrv::DtOsgExtrudedEllipseModel, makVrv::DtOsgOverlaySpiderWebModel, makVrv::DtOsgOverlayArcModel, makVrv::DtOsgExtrudedLineModel, makVrv::DtOsgOverlayGreatCircleArcModel, makVrv::DtOsgEllipsoidArcModel, makVrv::DtOsg3DGreatCircleArcModel, makVrv::DtOsg3DVolumetricLineModel, makVrv::DtOsgOverlayPolygonModel, makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsgOverlayRectangleModel, makVrv::DtOsgOverlaySegmentedLineModel, makVrv::DtOsgOverlayEllipseArcModel, makVrv::DtOsgPolygonModel, makVrv::DtOsgParticleSystemModel, makVrv::DtOsgTacticalSmokeModel, makVrv::DtOsgScribeBoxModel, makVrv::DtMultiLineModel, makVrv::DtOsgAnimationModel, makVrv::DtDiGuyCharacterModel, makVrv::DtTritonTidalStreamWakeModel, makVrv::DtTritonWaterImpactModel, makVrf::DtRadarCoverageModel, makVrv::DtOsg2DVolumetricLineModel, makVrv::DtOsgAttachableCuboidModel, makVrv::DtOsgAttachableEllipsoidModel, makVrv::DtOsgOverlayDirectionLineModel, makVrv::DtOsgCylinderModel, makVrv::DtOsgArticulatingCylinderModel, makVrv::DtOsgSimpleModel, makVrv::DtOsgRibbonModel, makVrv::DtRotorWashModel, makVrv::DtOsg3DTextModel, makVrv::DtOsgDecalModel, makVrv::DtOsgProjectedTextModel, makVrv::DtExampleModel, makVrv::DtFxParticleCollisionObjectModel, makVrv::DtOsgDrawModel, makVrv::DtOsgRectangularPyramidModel, makVrv::DtOsgRotorWashModel, makVrv::DtDummyCharacterModel, makVrv::DtOsgProjectedWidgetModel, and makVrv::DtOsgPinnableProjectedWidgetModel.

virtual void makVrv::DtModel::initializeModelInstance ( )
protectedvirtual

Push any state maintained by the model to the model instance.

Reimplemented in makVrv::DtOsgRibbonModel, makVrv::DtOsgDecalModel, and makVrv::DtOsgDrawModel.

void makVrv::DtModel::slot_modelInstanceChanged ( DtModelInstance instance)
protected

Called when the model instance changed.

virtual void makVrv::DtModel::waitAndClearLoadHandle ( )
protectedvirtual

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

virtual void makVrv::DtModel::removedFromLoadQueue ( )
protectedvirtual

deletes the myInLoadQueueHandle handle

virtual void makVrv::DtModel::setDoneBackgroundLoading ( )
protectedvirtual

called by async task, updates myCurrentlyLoading atomic

virtual void makVrv::DtModel::setActivelyBackgroundLoading ( )
protectedvirtual

called right before tbb task creation

void makVrv::DtModel::deleteModelInstance ( )
private

Delete the model instance (and emit signal_modelToBeDestroyed)

Friends And Related Function Documentation

friend class DtBackgroundLoader
friend
friend class DtBackgroundLoadAsyncTask
friend

Member Data Documentation

boost::signal<void (DtModel*)> makVrv::DtModel::signal_modelToBeDestroyed

Signal emitted when the model is to be destroyed.

boost::signal<void (DtModel*)> makVrv::DtModel::signal_modelChanged
boost::signal<bool (DtModel*,bool ), SlotReturnOR> makVrv::DtModel::signal_visibilityChangeRequested

Signal when the visibility has been requested, if any slot returns false, it will not change.

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

Signal emitted when the model instance is created.

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

Signal emitted when the model instance is to be destroyed.

DtLoaderHandle* makVrv::DtModel::myInLoadQueueHandle
protected
bool makVrv::DtModel::theInittedState
staticprotected
DtDe& makVrv::DtModel::myDe
protected
const DtUniqueID makVrv::DtModel::myUniqueId
protected

The unique id is constant after initialization.

bool makVrv::DtModel::myColorBlendingEnabled
protected

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.

DtModelInstance* makVrv::DtModel::myBackgroundModelInstance
protected

holds the model created in the background for a bit

float makVrv::DtModel::myMinLastFrameDistance
protected

last frames mimimal distance to the camera, calculated by the instancing system

TransformList makVrv::DtModel::myTransforms
protected

We keep our own copy in case we get updates before we get a model instance.

DtModelInstance* makVrv::DtModel::myModelInstance
protected
int makVrv::DtModel::myModelSet
protected
int makVrv::DtModel::myVisualizerType
protected
bool makVrv::DtModel::myContributesToBound
protected
DtUniqueID makVrv::DtModel::myParentSceneObjectID
protected
bool makVrv::DtModel::myIsPropFlag
protected
float makVrv::DtModel::myBlendColor[4]
protected
bool makVrv::DtModel::myVisibleFlag
protected
DtVector makVrv::DtModel::myPositionOffset
protected
DtTaitBryan makVrv::DtModel::myOrientationOffset
protected
std::string makVrv::DtModel::myModelDefinitionName
protected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)