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

Inheritance diagram for makVrv::DtRibbonModelInstance:

Public Member Functions
virtual	~DtRibbonModelInstance ()
	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 void	updateRibbonWidth ()
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 Default is true.
virtual void	setRibbonSpacing (float spacing)
	Sets the spacing between sample points along the ribbon (in meters).
virtual void	setRibbonLength (int maxSamples)
	Sets the maximum length of the ribbon (in samples).
virtual void	setColor (const osg::Vec4 &color)
	Sets the color of the ribbon.
virtual void	setVisible (bool isVisible)
	no-op
virtual void	update ()
	Update the position of the ribbon.
Protected Member Functions
	DtRibbonModelInstance (DtDe &de)
	CTOR.
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
float	myRibbonSpacing
int	myRibbonLength
bool	myColorSet
osg::Vec4	myColor
Friends
class	DtRibbonModelInstanceCreator

Detailed Description

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

Constructor & Destructor Documentation

virtual makVrv::DtRibbonModelInstance::~DtRibbonModelInstance ( ) [virtual]

DTOR.

makVrv::DtRibbonModelInstance::DtRibbonModelInstance ( DtDe & de ) [protected]

CTOR.

Member Function Documentation

virtual bool makVrv::DtRibbonModelInstance::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::DtRibbonModelInstance::addToConnector ( DtOsgSceneConnector * connector ) [virtual]

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

Reimplemented from makVrv::DtOsgModelInstance.

virtual void makVrv::DtRibbonModelInstance::updateRibbonWidth ( ) [virtual]

virtual bool makVrv::DtRibbonModelInstance::removeFromConnector ( DtOsgSceneConnector * connector ) [virtual]

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

Reimplemented from makVrv::DtOsgModelInstance.

virtual void makVrv::DtRibbonModelInstance::setParentSceneObject ( const DtUniqueID & sceneObjID ) [virtual]

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

virtual DtSceneObject* makVrv::DtRibbonModelInstance::parentSceneObject ( ) [virtual]

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

virtual void makVrv::DtRibbonModelInstance::setOcclusionEnabled ( bool enabled ) [virtual]

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

virtual void makVrv::DtRibbonModelInstance::setRibbonSpacing ( float spacing ) [virtual]

Sets the spacing between sample points along the ribbon (in meters).

virtual void makVrv::DtRibbonModelInstance::setRibbonLength ( int maxSamples ) [virtual]

Sets the maximum length of the ribbon (in samples).

If the given value (max number of samples in the ribbon), is negative or zero, the ribbon is unbounded and can be infinitely (or at least maximally) long.

virtual void makVrv::DtRibbonModelInstance::setColor ( const osg::Vec4 & color ) [virtual]

Sets the color of the ribbon.

virtual void makVrv::DtRibbonModelInstance::setVisible ( bool isVisible ) [inline, virtual]

no-op

Implements makVrv::DtModelInstance.

virtual void makVrv::DtRibbonModelInstance::update ( ) [virtual]

Update the position of the ribbon.

virtual osg::Node* makVrv::DtRibbonModelInstance::findFromCache ( DtModelDefinition & definition ) [protected, virtual]

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