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 | Protected Attributes
makVrv::DtOsgSimpleModel Class Reference

This is a realization of DtModel. More...

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

Classes

class  BoundingBoxCache
 Model Definition cache of bounding box information for instanced models. More...
 

Public Member Functions

 DtOsgSimpleModel (DtDe &de, DtUniqueID &id)
 
virtual ~DtOsgSimpleModel ()
 
virtual void setElementId (DtUniqueID id)
 Set the element ID for this model. More...
 
virtual void enableColorBlending (bool b)
 enable color blending for the model More...
 
virtual void setBlendColor (float r, float g, float b, float a)
 Set the blend color for the model. More...
 
virtual void setModelScalingEnabled (bool b)
 Indicate whether or not this model may be model-scaled Default is false. More...
 
virtual bool modelScalingEnabled ()
 getter for model scaling enabled flag More...
 
virtual void slot_atcModeEnableChanged (bool state)
 
virtual void setModelDefinition (const std::string &str)
 Set the model definition. More...
 
virtual void setVisible (bool visible)
 Set the visible state of the model. More...
 
virtual void setPosition (int vtx, const DtVector &position)
 Set the position of a control vertex in the model. More...
 
virtual void setOrientation (int vtx, const DtTaitBryan &orientation)
 Set the orientation of a vertex in the model. More...
 
virtual void setPositionOffset (const DtVector &positionOffset)
 Set the position offset of the model. More...
 
virtual void setOrientationOffset (const DtTaitBryan &orientationOffset)
 Set the Orientation Offset of the model. More...
 
virtual void addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)
 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 ()
 Virtual Functions to be implemented, remove this model from the scene. More...
 
virtual void setIsSupportModel (bool isSupport)
 Set whether the model is part of the support group (whether or not other scene objects can ground clamp to this model) More...
 
virtual void getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
 Get opposite corners of the bounding box for this model. More...
 
- 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)
 
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 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 const DtVectorpositionOffset () const
 Get the Position Offset of 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 const DtTaitBryan & orientationOffset () const
 Get the Orientation Offset of the model. 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...
 
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 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 Attributes

DtOsgSceneConnectormySceneConnector
 
bool myIsInstanced
 
bool myModelScalingEnabled
 
std::string myModelDefinition
 
DtUniqueID mySceneObjectId
 
bool myInitialPositionSet
 
DtVector mySetPosition
 
bool myInitialOrientationSet
 
DtTaitBryan mySetOrientation
 
bool myInitialPositionOffsetSet
 
bool myInitialOrientationOffsetSet
 
DtVector myBoundMin
 
DtVector myBoundMax
 
DtSignalConnectionManager myConnections
 
- 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
 

Additional Inherited Members

- Public Attributes inherited from makVrv::DtModel
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 inherited from makVrv::DtModel
typedef std::vector
< ObjectTransform
TransformList
 
- Protected Member Functions inherited from makVrv::DtModel
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...
 
- Static Protected Attributes inherited from makVrv::DtModel
static bool theInittedState
 

Detailed Description

This is a realization of DtModel.

It is a model class that is used to create a simple, model definition-based modelInstance. Renaming (when the Attachable- is removed from the class name) is recommended

Constructor & Destructor Documentation

makVrv::DtOsgSimpleModel::DtOsgSimpleModel ( DtDe de,
DtUniqueID id 
)
virtual makVrv::DtOsgSimpleModel::~DtOsgSimpleModel ( )
virtual

Member Function Documentation

virtual void makVrv::DtOsgSimpleModel::setModelDefinition ( const std::string &  str)
virtual

Set the model definition.

Reimplemented from makVrv::DtModel.

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

Set the visible state of the model.

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

Reimplemented from makVrv::DtModel.

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

Set the position of a control vertex in the model.

Reimplemented from makVrv::DtModel.

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

Set the orientation of a vertex in the model.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgSimpleModel::setPositionOffset ( const DtVector positionOffset)
virtual

Set the position offset of the model.

This offsets the position of the entire model.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgSimpleModel::setOrientationOffset ( const DtTaitBryan &  orientationOffset)
virtual

Set the Orientation Offset of the model.

This offsets the orientation of the entire model.

Reimplemented from makVrv::DtModel.

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

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

Implements makVrv::DtModel.

virtual void makVrv::DtOsgSimpleModel::addToSceneAsProp ( const DtUniqueID sceneObjectId)
virtual

Add this model to the scene as a prop.

All models are not required to re-implement this

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgSimpleModel::removeFromScene ( )
virtual

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

Implements makVrv::DtModel.

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

Set whether the model is part of the support group (whether or not other scene objects can ground clamp to this model)

Implements makVrv::DtModel.

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

Get opposite corners of the bounding box for this model.

Reimplemented from makVrv::DtModel.

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

Set the element ID for this model.

Reimplemented from makVrv::DtModel.

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

enable color blending for the model

Reimplemented from makVrv::DtModel.

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

Set the blend color for the model.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgSimpleModel::setModelScalingEnabled ( bool  b)
virtual

Indicate whether or not this model may be model-scaled Default is false.

virtual bool makVrv::DtOsgSimpleModel::modelScalingEnabled ( )
virtual

getter for model scaling enabled flag

virtual void makVrv::DtOsgSimpleModel::slot_atcModeEnableChanged ( bool  state)
virtual

Member Data Documentation

DtOsgSceneConnector* makVrv::DtOsgSimpleModel::mySceneConnector
protected
bool makVrv::DtOsgSimpleModel::myIsInstanced
protected
bool makVrv::DtOsgSimpleModel::myModelScalingEnabled
protected
std::string makVrv::DtOsgSimpleModel::myModelDefinition
protected
DtUniqueID makVrv::DtOsgSimpleModel::mySceneObjectId
protected
bool makVrv::DtOsgSimpleModel::myInitialPositionSet
protected
DtVector makVrv::DtOsgSimpleModel::mySetPosition
protected
bool makVrv::DtOsgSimpleModel::myInitialOrientationSet
protected
DtTaitBryan makVrv::DtOsgSimpleModel::mySetOrientation
protected
bool makVrv::DtOsgSimpleModel::myInitialPositionOffsetSet
protected
bool makVrv::DtOsgSimpleModel::myInitialOrientationOffsetSet
protected
DtVector makVrv::DtOsgSimpleModel::myBoundMin
protected
DtVector makVrv::DtOsgSimpleModel::myBoundMax
protected
DtSignalConnectionManager makVrv::DtOsgSimpleModel::myConnections
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)