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

A DtTreeModel owns the DtModelInstance of a tree instance. More...

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

Public Member Functions

virtual ~DtTreeModel ()
 DTOR.
virtual void setModelDefinition (const std::string &str)
 Set the model definition.
virtual std::string className () const
 Get the class name of the model instance owner.
virtual void slot_modelInstanceCreated (DtModelInstance *instance)
 Slot called when DtTreeModel gets a model instance associated with it.
virtual void slot_modelInstanceToBeDestroyed (DtModelInstance *instance)
 Slot called right before a DtTreeModel has it's model instance deleted.
virtual void addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)
 Virtual Functions to be implemented, add this model to the scene.
virtual void removeFromScene ()
 Virtual Functions to be implemented, remove this model from the scene.
virtual void setSolid (bool soild)
 Make the tree geometry solid.
- Public Member Functions inherited from makVrv::DtModel
 DtModel (DtDe &de, DtUniqueID id)
 CTOR.
virtual ~DtModel ()
 DTOR.
virtual void saveModelToFile (const std::string &filename)
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 DtVectorposition (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 DtVectorboundingBoxExtents () 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 DtVectorboundingBoxCenter () 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.
DtDede ()
 Get the DtDe object.
virtual void setModelInstance (DtModelInstance *modelInstance)
 Internally set the model instance pointer.
virtual void setVisible (bool isVisible)
 Set the visible state of the model.
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 DtModelInstancemodelInstance ()
 Get the model instance.
virtual const DtModelInstancemodelInstance () 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.

Public Attributes

boost::signal< void(const
std::string &)> 
signal_treeModelInstanceToBeDestroyed
 Signal emitted when the model instance is going to be destroyed.
boost::signal< void(const
std::string &)> 
signal_treeModelInstanceCreated
 Signal emitted when the model instance is created.
- 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 Member Functions

 DtTreeModel (DtDe &de, DtUniqueID id)
 CTOR Constructor is protected because this class is created via the creator pattern.
- Protected Member Functions inherited from makVrv::DtModel
virtual void addToSceneAsProp (const DtUniqueID &sceneObjectId)
 Add this model to the scene as a prop.
virtual void initializeModelInstance ()
 Push any state maintained by the model to the model instance.
void slot_modelInstanceChanged (DtModelInstance *instance)
 Called when the model instance changed.

Friends

class DtTreeModelCreator
class DtTreeModelClassesCreator

Additional Inherited Members

- Protected Types inherited from makVrv::DtModel
typedef std::vector
< ObjectTransform
TransformList
- Protected Attributes inherited from makVrv::DtModel
DtDemyDe
const DtUniqueID myUniqueId

Detailed Description

A DtTreeModel owns the DtModelInstance of a tree instance.

Constructor & Destructor Documentation

virtual makVrv::DtTreeModel::~DtTreeModel ( )
virtual

DTOR.

makVrv::DtTreeModel::DtTreeModel ( DtDe de,
DtUniqueID  id 
)
protected

CTOR Constructor is protected because this class is created via the creator pattern.

Member Function Documentation

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

Set the model definition.

Reimplemented from makVrv::DtModel.

virtual std::string makVrv::DtTreeModel::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::DtModel.

Reimplemented in makVrv::DtSpeedTreeModel.

virtual void makVrv::DtTreeModel::slot_modelInstanceCreated ( DtModelInstance instance)
virtual

Slot called when DtTreeModel gets a model instance associated with it.

virtual void makVrv::DtTreeModel::slot_modelInstanceToBeDestroyed ( DtModelInstance instance)
virtual

Slot called right before a DtTreeModel has it's model instance deleted.

virtual void makVrv::DtTreeModel::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::DtTreeModel::removeFromScene ( )
virtual

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

Implements makVrv::DtModel.

virtual void makVrv::DtTreeModel::setSolid ( bool  soild)
virtual

Make the tree geometry solid.

Implements makVrv::DtModel.

Friends And Related Function Documentation

friend class DtTreeModelCreator
friend
friend class DtTreeModelClassesCreator
friend

Member Data Documentation

boost::signal<void (const std::string&)> makVrv::DtTreeModel::signal_treeModelInstanceToBeDestroyed

Signal emitted when the model instance is going to be destroyed.

boost::signal<void (const std::string&)> makVrv::DtTreeModel::signal_treeModelInstanceCreated

Signal emitted when the model instance is created.


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

Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)