makVrv::DtDecalModelInstance Class Reference

A model instance creates a decal ribbon model instance effect from a model definition. More...

Inheritance diagram for makVrv::DtDecalModelInstance:

List of all members.

Public Member Functions
virtual	~DtDecalModelInstance ()
	DTOR.
virtual bool	realize (DtModelDefinition &definition)
	Attempt to realize a definition.
virtual void	addToConnector (DtOsgSceneConnector *connector)
	Brief Tell the model instance to add itself to the provided node.
virtual bool	removeFromConnector (DtOsgSceneConnector *connector)
	Brief Tell the model instance to remove itself from the provided node.
virtual void	setParentSceneObject (const DtUniqueID &sceneObjID)
	Set the parent scene object; used for dynamically sizing the ribbon.
virtual DtSceneObject *	parentSceneObject ()
	Get the scene object that the ribbon is attached to; returns null if none exists.
virtual void	setOcclusionEnabled (bool enabled)
	Turn on or off occlusion of the ribbon by other objects in the scene.
virtual void	setColor (const osg::Vec4 &color)
	Sets the color of the decal model's ribbon.
virtual void	setVisible (bool isVisible)
	no-op
virtual void	update ()
	Update the position of the ribbon.
Protected Member Functions
	DtDecalModelInstance (DtDe &de)
	CTOR.
virtual DtOsgRibbon *	createRibbonEffect (const osg::Vec3 &pointA, const osg::Vec3 &pointB)
	Create the ribbon effect.
virtual osg::Node *	findFromCache (DtModelDefinition &definition)
	Try to find an effect model instance in cache to copy.
Protected Attributes
osg::ref_ptr< DtOsgRibbon >	myRibbon
DtUniqueID	myParentId
bool	myOcclusionEnabled
bool	myColorSet
osg::Vec4	myColor
Friends
class	DtDecalModelInstanceCreator

---

Detailed Description

A model instance creates a decal ribbon model instance effect from a model definition.

---

Constructor & Destructor Documentation

virtual makVrv::DtDecalModelInstance::~DtDecalModelInstance

(

)

[virtual]

DTOR.

makVrv::DtDecalModelInstance::DtDecalModelInstance

(

DtDe &

de

)

[protected]

CTOR.

---

Member Function Documentation

virtual bool makVrv::DtDecalModelInstance::realize

(

DtModelDefinition &

definition

)

[virtual]

Attempt to realize a definition.

If the model instance can't realize the definition it should return false.

Reimplemented from makVrv::DtModelInstance.

virtual void makVrv::DtDecalModelInstance::addToConnector

(

DtOsgSceneConnector *

connector

)

[virtual]

Brief Tell the model instance to add itself to the provided node.

Reimplemented from makVrv::DtOsgModelInstance.

virtual bool makVrv::DtDecalModelInstance::removeFromConnector

(

DtOsgSceneConnector *

connector

)

[virtual]

Brief Tell the model instance to remove itself from the provided node.

Reimplemented from makVrv::DtOsgModelInstance.

virtual void makVrv::DtDecalModelInstance::setParentSceneObject

(

const DtUniqueID &

sceneObjID

)

[virtual]

Set the parent scene object; used for dynamically sizing the ribbon.

virtual DtSceneObject* makVrv::DtDecalModelInstance::parentSceneObject

(

)

[virtual]

Get the scene object that the ribbon is attached to; returns null if none exists.

virtual void makVrv::DtDecalModelInstance::setOcclusionEnabled

(

bool

enabled

)

[virtual]

Turn on or off occlusion of the ribbon by other objects in the scene.

Default is true

virtual void makVrv::DtDecalModelInstance::setColor

(

const osg::Vec4 &

color

)

[virtual]

Sets the color of the decal model's ribbon.

virtual void makVrv::DtDecalModelInstance::setVisible

(

bool

isVisible

)

[inline, virtual]

no-op

Implements makVrv::DtModelInstance.

virtual void makVrv::DtDecalModelInstance::update

(

)

[virtual]

Update the position of the ribbon.

virtual DtOsgRibbon* makVrv::DtDecalModelInstance::createRibbonEffect	(	const osg::Vec3 &	pointA,
		const osg::Vec3 &	pointB
	)		[protected, virtual]

Create the ribbon effect.

virtual osg::Node* makVrv::DtDecalModelInstance::findFromCache

(

DtModelDefinition &

definition

)

[protected, virtual]

Try to find an effect model instance in cache to copy.

---

Friends And Related Function Documentation

friend class DtDecalModelInstanceCreator [friend]

---

Member Data Documentation

osg::ref_ptr<DtOsgRibbon> makVrv::DtDecalModelInstance::myRibbon [protected]

DtUniqueID makVrv::DtDecalModelInstance::myParentId [protected]

bool makVrv::DtDecalModelInstance::myOcclusionEnabled [protected]

bool makVrv::DtDecalModelInstance::myColorSet [protected]

osg::Vec4 makVrv::DtDecalModelInstance::myColor [protected]

---

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

• include/vrvOsg/DtDecalModelInstance.h