makVrv::DtRibbonModelInstance Class Reference

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.
osg::Node *	sensorNode ()
	Get the model instance's sensor node, .
const osg::Node *	sensorNode () const
	Get the model instance's sensor node, .
Public Member Functions inherited from makVrv::DtOsgModelInstance
virtual	~DtOsgModelInstance ()
	DTOR.
virtual bool	saveModelToFile (const std::string &filename) const
	Attempt to save the model to a file.
virtual void	enableColorBlending (bool b)
	Enable / disable coloring on all models in the scene object.
virtual void	setBlendColor (float r, float g, float b, float a)
	set the model's color
virtual void	enableTexture (bool onOff)
virtual osg::Node *	rootNode ()
	Get the model instance's root node.
virtual const osg::Node *	rootNode () const
	Get the model instance's root node.
virtual void	addDynamicSensorRegion (const std::string &region)
	Add an active region state.
virtual void	setDynamicSensorRegion (const std::string &region, bool state)
	Set the state of an active region.
virtual bool	dynamicSensorRegion (const std::string &region)
	Get the current state of the specified sensor region.
SensorRegionStateMap const	dynamicSensorRegionMap () const
	Get the map containing all regions and their current states.
Public Member Functions inherited from makVrv::DtModelInstance
	DtModelInstance (DtDe &de)
	CTOR.
virtual	~DtModelInstance ()
	DTOR.
const std::string &	realizedDefinitionName () const
	Get the name of the definition that this model instance was realized with.
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)
virtual 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.

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 Member Functions inherited from makVrv::DtOsgModelInstance
virtual void	updateColorBlending ()
	calls update color blending with the model root.
virtual void	updateColorBlending (osg::Node *node)
virtual void	enableTexture (osg::Node *root, bool onOff)
virtual void	updateBoundingBoxViaContents ()
	DtOsgModelInstance (DtDe &de)
	CTOR.
virtual void	setRootNode (osg::Node *node)
	Set the model instance's root node.

Protected Attributes
DtSignalConnectionManager	myConnections
osg::ref_ptr< DtOsgRibbon >	myRibbon
DtUniqueID	myParentId
bool	myOcclusionEnabled
float	myRibbonSpacing
int	myRibbonLength
bool	myColorSet
osg::Vec4	myColor
Protected Attributes inherited from makVrv::DtOsgModelInstance
osg::ref_ptr< osg::Node >	myModelRoot
osg::ref_ptr< osg::StateSet >	myCachedState
SensorRegionStateMap	mySensorRegionMap
Protected Attributes inherited from makVrv::DtModelInstance
DtDe &	myDe
std::string	myRealizedModelDefinitionName
DtVector	myBoundingBoxCenter
DtVector	myBoundingBoxExtents
DtVector	myBoundingBoxMinimum
DtVector	myBoundingBoxMaximum
bool	myContributesToBound
bool	myColorBlendingEnabled
float	myBlendRed
float	myBlendBlue
float	myBlendGreen
float	myBlendAlpha

Friends
class	DtRibbonModelInstanceCreator

Additional Inherited Members
Public Types inherited from makVrv::DtOsgModelInstance
typedef boost::unordered_map < std::string, bool >	SensorRegionStateMap
	Dynamic Sensor Region methods.
Static Public Member Functions inherited from makVrv::DtOsgModelInstance
static osg::Vec4	readVec4 (const std::string &paramName, const DtModelDefinition &definition)
static osg::Vec3	readVec3 (const std::string &paramName, const DtModelDefinition &definition)
Public Attributes inherited from makVrv::DtOsgModelInstance
boost::signal< void(const std::string &) >	signal_dynamicSensorRegionAdded
	Signal raised when a dynamic sensor region is added.
boost::signal< void(const std::string &, bool) >	signal_dynamicSensorRegionChanged
	Signal raised when a dynamic sensor region's state changes.
Public Attributes inherited from makVrv::DtModelInstance
boost::signal< void(DtModelInstance *)>	signal_modelInstanceChanged

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 )

inlinevirtual

no-op

Implements makVrv::DtModelInstance.

virtual void makVrv::DtRibbonModelInstance::update ( )

virtual

Update the position of the ribbon.

osg::Node* makVrv::DtRibbonModelInstance::sensorNode ( )

inlinevirtual

Get the model instance's sensor node, .

Reimplemented from makVrv::DtOsgModelInstance.

const osg::Node* makVrv::DtRibbonModelInstance::sensorNode ( ) const

inlinevirtual

Get the model instance's sensor node, .

Reimplemented from makVrv::DtOsgModelInstance.

virtual osg::Node* makVrv::DtRibbonModelInstance::findFromCache ( DtModelDefinition &  definition )

protectedvirtual

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

Friends And Related Function Documentation

friend class DtRibbonModelInstanceCreator

friend

Member Data Documentation

DtSignalConnectionManager makVrv::DtRibbonModelInstance::myConnections

protected

osg::ref_ptr<DtOsgRibbon> makVrv::DtRibbonModelInstance::myRibbon

protected

DtUniqueID makVrv::DtRibbonModelInstance::myParentId

protected

bool makVrv::DtRibbonModelInstance::myOcclusionEnabled

protected

float makVrv::DtRibbonModelInstance::myRibbonSpacing

protected

int makVrv::DtRibbonModelInstance::myRibbonLength

protected

bool makVrv::DtRibbonModelInstance::myColorSet

protected

osg::Vec4 makVrv::DtRibbonModelInstance::myColor

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvOsg/DtRibbonModelInstance.h