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.

Inheritance diagram for makVrv::DtModel:

[legend]

Classes
struct	ObjectTransform

Public Member Functions
	DtModel (DtDe &de, DtUniqueID id)

virtual	~DtModel ()

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

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

virtual const std::string &	modelDefinitionName ()

virtual void	saveModelToFile (const std::string &filename)

virtual const std::string &	className () const

unsigned int	transformSize () const

virtual void	setPosition (int vtx, const DtVector &position)

virtual const DtVector &	position (int vtx=0) const

virtual void	removePosition (int vtx)

virtual void	setPositionOffset (const DtVector &positionOffset)

virtual const DtVector &	positionOffset () const

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

virtual void	setPositionAndOrientation (int vtx, const DtVector &positionOffset, const DtTaitBryan &orientation)

virtual const DtTaitBryan &	orientation (int vtx=0) const

virtual void	setOrientationOffset (const DtTaitBryan &orientationOffset)

virtual const DtTaitBryan &	orientationOffset () const

virtual void	enableColorBlending (bool b)

virtual void	setBlendColor (float r, float g, float b, float a)

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

virtual bool	colorBlendingEnabled () const

virtual void	setColor (float r, float g, float b, float a)

virtual void	enableLighting (bool l)

virtual int	modelSet () const

const DtVector &	boundingBoxExtents () const

void	getBoundingBoxExtents (double &x, double &y, double &z) const

const DtVector &	boundingBoxCenter () const

virtual void	getBoundingBoxCenter (double &x, double &y, double &z) const

virtual void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)

void	setContributesToBound (bool trueOrFalse)

bool	contributesToBound () const

DtDe &	de ()

virtual void	setModelInstance (DtModelInstance *modelInstance)

virtual void	promoteBackgroundModelInstance (DtModelDefinition &defintion)

virtual void	setVisible (bool isVisible)

virtual bool	visible () const

DtUniqueID	parentSceneObjectID () const

virtual void	addedToSceneObjectAsProp (const DtUniqueID &sceneObj)

virtual void	addedToSceneObject (const DtUniqueID &sceneObj, int modelSet, int visualizerType)

virtual void	setElementId (DtUniqueID id)

virtual void	removedFromSceneObject ()

virtual void	setIsSupportModel (bool isSupport)=0

virtual void	setSolid (bool isSolid)

virtual bool	isProp ()

virtual void	updateMinLastFrameDistance (float distance)

virtual void	resetLastFrameDistance ()

virtual float	minLastFrameDistance () const


virtual DtModelInstance *	modelInstance ()

virtual const DtModelInstance *	modelInstance () const


int	visualizerType () const

abstract virtual api needs to be implemented by subclasses
virtual bool	supportsMultithreadedLoad ()

virtual void	backgroundLoad ()

virtual void	foregroundLoad ()

virtual bool	isActivelyBackgroundLoading ()

virtual DtLoaderHandle *	getLoadQueueHandle ()

Public Attributes
boost::signalslib::signal < void(DtModel *)>	signal_modelToBeDestroyed

boost::signalslib::signal < void(DtModel *)>	signal_modelChanged

boost::signalslib::signal < bool(DtModel *, bool), SlotReturnOR >	signal_visibilityChangeRequested

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

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

Protected Types
typedef std::vector < ObjectTransform >	TransformList

Protected Member Functions
virtual void	addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)=0

virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)

virtual void	removeFromScene ()=0

virtual void	initializeModelInstance ()

void	slot_modelInstanceChanged (DtModelInstance *instance)

virtual void	waitAndClearLoadHandle ()

virtual void	removedFromLoadQueue ()

virtual void	setDoneBackgroundLoading ()

virtual void	setActivelyBackgroundLoading ()

Protected Attributes
DtLoaderHandle *	myInLoadQueueHandle

DtDe &	myDe

const DtUniqueID	myUniqueId

bool	myColorBlendingEnabled

DtModelInstance *	myBackgroundModelInstance

float	myMinLastFrameDistance

TransformList	myTransforms

DtModelInstance *	myModelInstance

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 ()

Friends
class	DtBackgroundLoader

class	DtBackgroundLoadAsyncTask

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

Set the model definition.

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

Get the class name of the model instance owner. This is used to control how model instances are created.

Reimplemented in makVrv::DtCharacterModel, makVrv::DtDiGuyCharacterModel, makVrv::DtDummyCharacterModel, makVrv::DtOsgArticulatedModel, makVrv::DtArticulatedModel, makVrv::DtOsgRibbonModel, makVrv::DtRibbonModel, makVrv::DtTritonWakeModel, makVrv::DtOsgParticleSystemModel, makVrv::DtParticleSystemModel, makVrv::DtFxParticleCollisionObjectModel, makVrv::DtOsgEllipsoidArcModel, makVrv::DtOsgDecalModel, makVrv::DtOsgRotorWashModel, makVrv::DtOsgTacticalSmokeModel, makVrv::DtOsgRectangularPyramidModel, makVrv::DtTacticalSmokeModel, makVrv::DtOsgAnimationModel, makVrv::DtAnimationModel, makVrv::DtRectangularPyramidModel, makVrv::DtDecalModel, and makVrv::DtRotorWashModel.

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 const DtVector& makVrv::DtModel::position ( int vtx = 0 ) const

virtual

Get the Position of a given point.

Exceptions

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

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

virtual

Remove a transform at the given position.

Reimplemented in makVrv::DtOsg2DVolumetricLineModel, makVrv::DtOsgOverlayPolygonModel, makVrv::DtOsg3DVolumetricLineModel, makVrv::DtOsgPolygonModel, makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsgExtrudedEllipseModel, makVrv::DtOsgExtrudedPolygonModel, makVrv::DtOsgExtrudedLineModel, and makVrv::DtOsgOverlaySegmentedLineModel.

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::DtDiGuyCharacterModel, makVrv::DtDummyCharacterModel, makVrv::DtOsgArticulatedModel, makVrv::DtOsgOverlayDirectionLineModel, makVrv::DtOsgSimpleModel, makVrv::DtDeprecatedOsgSimpleModel, makVrv::DtOsgDecalModel, and makVrv::DtDeprecatedOsgArticulatedModel.

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

Set the orientation of a vertex in the model.

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, makVrv::DtOsgArticulatedModel, and makVrv::DtDeprecatedOsgArticulatedModel.

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

virtual

Get the Orientation of a given point.

Exceptions

DtCorruptedState if 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::DtDiGuyCharacterModel, makVrv::DtDummyCharacterModel, makVrv::DtOsgArticulatedModel, makVrv::DtOsgSimpleModel, makVrv::DtDeprecatedOsgSimpleModel, and makVrv::DtDeprecatedOsgArticulatedModel.

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, makVrv::DtDeprecatedOsgSimpleModel, makVrv::DtDeprecatedOsgArticulatedModel, 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, makVrv::DtOsgSimpleModel, makVrv::DtDeprecatedOsgSimpleModel, and makVrv::DtDeprecatedOsgArticulatedModel.

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

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, makVrv::DtOsgSimpleModel, and makVrv::DtDeprecatedOsgArticulatedModel.

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::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] isVisible is the new visible state; true = visible, false = hidden.

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

virtual

Get the visible state of the model.

Return values

true	if set visible.
false	otherwise.

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, makVrv::DtOsgSimpleModel, makVrv::DtDeprecatedOsgSimpleModel, and makVrv::DtDeprecatedOsgArticulatedModel.

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)

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

virtual

Set whether or not other this model is drawn filled in.

Reimplemented in makVrv::DtOsgOverlayPolygonModel, makVrv::DtOsgExtrudedPolygonModel, makVrv::DtOsg3DVolumetricLineModel, makVrv::DtOsgExtrudedLineModel, makVrv::DtOsg2DVolumetricLineModel, makVrv::Dt2DVolumetricLineModel, makVrv::Dt3DVolumetricLineModel, makVrv::DtOsgExtrudedEllipseModel, makVrv::DtOsgOverlayRectangleModel, and makVrv::DtExampleModel.

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.

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, makVrv::DtOsgSimpleModel, and makVrv::DtDeprecatedOsgSimpleModel.

virtual void makVrv::DtModel::removeFromScene ( )

protectedpure virtual

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

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::signalslib::signal<void (DtModel*)> makVrv::DtModel::signal_modelToBeDestroyed

Signal emitted when the model is to be destroyed.

boost::signalslib::signal<void (DtModel*)> makVrv::DtModel::signal_modelChanged

boost::signalslib::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::signalslib::signal<void (DtModelInstance*, DtModel*)> makVrv::DtModel::signal_modelInstanceCreated

Signal emitted when the model instance is created.

boost::signalslib::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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvCore/DtModel.h

Classes

Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Friends

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation