A model of a ribbon effect.

Inheritance diagram for makVrv::DtRibbonModel:

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

virtual	~DtRibbonModel ()

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

virtual const std::string &	className () const =0

virtual void	setOcclusionEnabled (bool enabled)=0

virtual void	setRibbonSpacing (float sampleSpacing)=0

virtual void	setRibbonLength (int maxSamples)=0

virtual void	setRibbonTimeout (float duration)=0

virtual void	update ()=0

Public Member Functions inherited from makVrv::DtModel
	DtModel (DtDe &de, DtUniqueID id)

virtual	~DtModel ()

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

virtual const std::string &	modelDefinitionName ()

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

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

virtual bool	supportsMultithreadedLoad ()

virtual void	backgroundLoad ()

virtual void	foregroundLoad ()

virtual bool	isActivelyBackgroundLoading ()

virtual DtLoaderHandle *	getLoadQueueHandle ()

Private Member Functions
	DtRibbonModel ()

	DtRibbonModel (const DtRibbonModel &)

DtRibbonModel &	operator= (const DtRibbonModel &)

Additional Inherited Members
Public Attributes inherited from makVrv::DtModel
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 inherited from makVrv::DtModel
typedef std::vector < ObjectTransform >	TransformList

Protected Member Functions inherited from makVrv::DtModel
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 inherited from makVrv::DtModel
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 inherited from makVrv::DtModel
static bool	theInittedState

Constructor & Destructor Documentation

makVrv::DtRibbonModel::DtRibbonModel	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtRibbonModel::~DtRibbonModel ( )

virtual

DTOR.

makVrv::DtRibbonModel::DtRibbonModel ( )

private

unimplemented private default constructor

makVrv::DtRibbonModel::DtRibbonModel ( const DtRibbonModel & )

private

Copy Constructor not implemented � Copy not allowed.

Member Function Documentation

DtRibbonModel& makVrv::DtRibbonModel::operator= ( const DtRibbonModel & )

private

Assignment Operator not implemented � Copy not allowed.

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

pure virtual

Override the default model definition function.

Reimplemented from makVrv::DtModel.

Implemented in makVrv::DtOsgRibbonModel.

virtual const std::string& makVrv::DtRibbonModel::className ( ) const

pure virtual

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

Reimplemented from makVrv::DtModel.

Implemented in makVrv::DtOsgRibbonModel.

virtual void makVrv::DtRibbonModel::setOcclusionEnabled ( bool enabled )

pure virtual

Enable or disable occlusion of the ribbon by other objects in the scene.

Implemented in makVrv::DtOsgRibbonModel.

virtual void makVrv::DtRibbonModel::setRibbonSpacing ( float sampleSpacing )

pure virtual

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

Implemented in makVrv::DtOsgRibbonModel.

virtual void makVrv::DtRibbonModel::setRibbonLength ( int maxSamples )

pure 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.

Implemented in makVrv::DtOsgRibbonModel.

virtual void makVrv::DtRibbonModel::setRibbonTimeout ( float duration )

pure virtual

Sets the timeout of a ribbon segment (in seconds). If the given value, is negative or zero, the ribbon is unbounded and will not timeout.

Implemented in makVrv::DtOsgRibbonModel.

virtual void makVrv::DtRibbonModel::update ( )

pure virtual

Update the ribbon.

Implemented in makVrv::DtOsgRibbonModel.

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

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

Public Member Functions

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation