makVrv::DtRibbonModel Class Reference

A model of a ribbon effect. More...

Inheritance diagram for makVrv::DtRibbonModel:

List of all members.

Public Member Functions
	DtRibbonModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtRibbonModel ()
	DTOR.
virtual void	setModelDefinition (const std::string &str)=0
	Override the default model definition function.
virtual std::string	className () const =0
	Get the class name of the model instance owner.
virtual void	setOcclusionEnabled (bool enabled)=0
	Enable or disable occlusion of the ribbon by other objects in the scene.
virtual void	setRibbonSpacing (float sampleSpacing)=0
	Sets the spacing between sample points along the ribbon (in meters).
virtual void	setRibbonLength (int maxSamples)=0
	Sets the maximum length of the ribbon (in samples).
virtual void	update ()=0
	Update the ribbon.

---

Detailed Description

A model of a ribbon effect.

---

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtRibbonModel::~DtRibbonModel

(

)

[virtual]

DTOR.

---

Member Function Documentation

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 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::update

(

)

[pure virtual]

Update the ribbon.

Implemented in makVrv::DtOsgRibbonModel.

---

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

• include/vrvCore/DtRibbonModel.h