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

Inheritance diagram for makVrv::DtModel:

Classes
struct	ObjectTransform
Public Member Functions
	DtModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtModel ()
	DTOR.
virtual void	setModelDefinition (const std::string &str)
	Set the model definition.
virtual void	saveModelToFile (const std::string &filename)
virtual std::string	className () const
	Get the class name of the model instance owner.
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 DtVector &	position (int vtx=0) const
	Get the Position 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	setColor (float r, float g, float b, float a)
	set the model's color
virtual int	modelSet () const
	Get the model set this model is part of.
const DtVector &	boundingBoxExtents () 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 DtVector &	boundingBoxCenter () const
	Get the bounding box center of the model instance.
void	getBoundingBoxCenter (double &x, double &y, double &z) const
	Get the bounding box center of the model instance.
void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
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.
DtDe &	de ()
	Get the DtDe object.
virtual void	setModelInstance (DtModelInstance *modelInstance)
	Internally set the model instance pointer.
virtual void	setVisible (bool isVisible)
	Set the model visible or invisible.
virtual void	setVisibleViaSwitch (bool isVisible)
	Set the model visible or invisible.
bool	visible () const
	Get if the model is visible.
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 void	setSolid (bool isSolid)=0
	Set whether or not other scene objects can ground clamp to this model Default implementation does nothing.

virtual DtModelInstance *	modelInstance ()
	Get the model instance.
virtual const DtModelInstance *	modelInstance () 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(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 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.
virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)
	Add this model to the scene as a prop.
virtual void	removeFromScene ()=0
	Virtual Functions to be implemented, remove this model from the scene.
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.
Protected Attributes
DtDe &	myDe
const DtUniqueID	myUniqueId
Private Attributes
TransformList	myTransforms
	We keep our own copy in case we get updates before we get a model instance.
DtModelInstance *	myModelInstance
int	myModelSet
int	myVisualizerType
bool	myContributesToBound
DtUniqueID	myParentSceneObjectID
bool	myIsPropFlag
bool	myColorBlendingEnabled
float	myBlendColor [4]
bool	myVisibleFlag

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

virtual void makVrv::DtModel::setModelDefinition ( const std::string & str ) [virtual]

virtual void makVrv::DtModel::saveModelToFile ( const std::string & filename ) [virtual]

virtual std::string makVrv::DtModel::className ( ) const [virtual]

Get the class name of the model instance owner.

This is used to control how model instances are created.

Reimplemented in makVrv::DtCharacterModel, makVrv::DtDummyCharacterModel, makVrv::DtOsgArticulatedModel, makVrv::DtArticulatedModel, makVrv::DtDiGuyCharacterModel, makVrv::DtOsgEllipsoidArcModel, makVrv::DtOsgDecalModel, makVrv::DtOsgRibbonModel, makVrv::DtTreeModel, makVrv::DtParticleSystemModel, makVrv::DtOsgParticleSystemModel, makVrv::DtOsgAnimationModel, makVrv::DtDecalModel, makVrv::DtAnimationModel, makVrv::DtRibbonModel, and makVrv::DtSpeedTreeModel.

virtual DtModelInstance* makVrv::DtModel::modelInstance ( ) [virtual]

Get the model instance.

virtual const DtModelInstance* makVrv::DtModel::modelInstance ( ) const [virtual]

Get the model instance.

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.

virtual void makVrv::DtModel::removePosition ( int vtx ) [virtual]

Remove a transform at the given position.

Reimplemented in makVrv::DtOsgPolygonModel, makVrv::DtOsgOverlayPolygonModel, makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsgExtrudedCircleModel, makVrv::DtOsgExtrudedPolygonModel, makVrv::DtOsgExtrudedLineModel, and makVrv::DtOsgOverlaySegmentedLineModel.

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

Get the Position of a given point.

Exceptions:

DtCorruptedState if the vtx is not with-in the normal bounds.

virtual void makVrv::DtModel::setOrientation	(	int	vtx,
		const DtTaitBryan &	orientation
	)		`[virtual]`

Set the orientation of a vertex in the model.

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

Enable / disable color blending for this model.

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

Set color to use if color 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::DtOsgEllipsoidArcModel, makVrv::DtOsgRibbonModel, makVrv::DtPolygonModel, makVrv::DtOsgDecalModel, makVrv::DtOsgExtrudedCircleModel, makVrv::DtOsgExtrudedPolygonModel, makVrv::DtOsgScribeBoxModel, makVrv::DtOsgCylinderModel, makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsgAttachableCuboidModel, makVrv::DtOsgAttachableEllipsoidModel, makVrv::DtEllipsoidArcModel, makVrv::DtOverlayEllipseArcModel, makVrv::DtOsgArticulatingCylinderModel, makVrv::DtOsgExtrudedLineModel, makVrv::DtOsg3DTextModel, makVrv::DtOsg3DGreatCircleArcModel, makVrv::DtOsgOverlayEllipseArcModel, makVrv::DtOsgOverlayGreatCircleArcModel, makVrv::DtOsgOverlayRectangleModel, makVrv::DtOsgPolygonModel, makVrv::DtCylinderModel, makVrv::DtOsgOverlayDirectionLineModel, makVrv::DtOsgOverlaySegmentedLineModel, makVrv::DtAttachableCuboidModel, makVrv::DtAttachableEllipsoidModel, makVrv::DtScribeBoxModel, makVrv::DtOsgOverlayPolygonModel, makVrv::Dt3DTextModel, makVrv::DtArticulatingCylinderModel, and makVrv::DtLineModel.

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.

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

Get the bounding box center of the model instance.

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

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
modelInstance	pointer to a model instance.

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

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

Set the model visible or invisible.

virtual void makVrv::DtModel::setVisibleViaSwitch ( bool isVisible ) [virtual]

Set the model visible or invisible.

Reimplemented in makVrv::DtOsgArticulatedModel.

bool makVrv::DtModel::visible ( ) const

Get if the model is visible.

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::removedFromSceneObject ( ) [virtual]

Called when the model was removed from a scene object.

virtual void makVrv::DtModel::setSolid ( bool isSolid ) [pure virtual]

Set whether or not other scene objects can ground clamp to this model Default implementation does nothing.

Implemented in makVrv::DtOsgArticulatedModel, makVrv::DtOsgEllipsoidArcModel, makVrv::DtDiGuyCharacterModel, makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsgOverlaySegmentedLineModel, makVrv::DtOsg3DGreatCircleArcModel, makVrv::DtMultiLineModel, makVrv::DtOsgOverlayEllipseArcModel, makVrv::DtDummyCharacterModel, makVrv::DtOsgRibbonModel, makVrv::DtOsgOverlayGreatCircleArcModel, makVrv::DtOsgParticleSystemModel, makVrv::DtOsgAnimationModel, makVrv::DtOsgDecalModel, makVrv::DtOsgOverlayRectangleModel, makVrv::DtOsgCylinderModel, makVrv::DtOsgExtrudedCircleModel, makVrv::DtOsgExtrudedPolygonModel, makVrv::DtOsgPolygonModel, makVrv::DtOsgAttachableCuboidModel, makVrv::DtOsgAttachableEllipsoidModel, makVrv::DtOsgOverlayPolygonModel, makVrv::DtOsgSimpleModel, makVrv::DtTreeModel, makVrv::DtOsgArticulatingCylinderModel, makVrv::DtOsgProjectedWidgetModel, makVrv::DtOsgScribeBoxModel, makVrv::DtOsgExtrudedLineModel, makVrv::DtOsgOverlayDirectionLineModel, makVrv::DtOsgProjectedTextModel, makVrv::DtOsg3DTextModel, and makVrv::DtOsgDrawModel.

virtual void makVrv::DtModel::addToScene	(	const DtUniqueID &	sceneObjectId,
		int	modelSet,
		int	visualizerType
	)		`[protected, pure virtual]`

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

virtual void makVrv::DtModel::addToSceneAsProp ( const DtUniqueID & sceneObjectId ) [inline, protected, virtual]

Add this model to the scene as a prop.

All models are not required to re-implement this

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

virtual void makVrv::DtModel::removeFromScene ( ) [protected, pure virtual]

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

virtual void makVrv::DtModel::initializeModelInstance ( ) [protected, virtual]

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.

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.

DtDe& makVrv::DtModel::myDe [protected]

const DtUniqueID makVrv::DtModel::myUniqueId [protected]

TransformList makVrv::DtModel::myTransforms [private]

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

DtModelInstance* makVrv::DtModel::myModelInstance [private]

int makVrv::DtModel::myModelSet [private]

int makVrv::DtModel::myVisualizerType [private]

bool makVrv::DtModel::myContributesToBound [private]

DtUniqueID makVrv::DtModel::myParentSceneObjectID [private]

bool makVrv::DtModel::myIsPropFlag [private]

bool makVrv::DtModel::myColorBlendingEnabled [private]

float makVrv::DtModel::myBlendColor[4] [private]

bool makVrv::DtModel::myVisibleFlag [private]

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

include/vrvCore/DtModel.h

Classes

Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation