VgEngine::VgSplineVectorFunctorDescriptor Class Reference

This class describes a functor that approximates a sequence of vectors with a spline. More...

Inheritance diagram for VgEngine::VgSplineVectorFunctorDescriptor:

Collaboration diagram for VgEngine::VgSplineVectorFunctorDescriptor:

List of all members.

Static Public Member Functions
static VgRefPtr < VgSplineVectorFunctorDescriptor >	create ()
	This static method returns a new heap-allocated descriptor.
Public Attributes
std::vector< VgPosition >	mPoints
	The vector of points of the spline.
float	mSplineMetricRadius
	The maximal metric radius of the rounded angle at spline points.
float	mDistanceFromSpline
	The distance at which we will place the animated object from the spline.
Protected Member Functions
	VgSplineVectorFunctorDescriptor ()
	Class constructor.
virtual	~VgSplineVectorFunctorDescriptor ()
	Class destructor.

---

Detailed Description

This class describes a functor that approximates a sequence of vectors with a spline.

It also has the ability to specify a "distance from spline". It is the metric distance the animated object will be from the spline along it's negative Z axis.

Version:

2.0.7729

---

Constructor & Destructor Documentation

VgEngine::VgSplineVectorFunctorDescriptor::VgSplineVectorFunctorDescriptor

(

)

[protected]

Class constructor.

This can't be called publicly, instances must be obtained through the VgSplineVectorFunctorDescriptor::create method.

virtual VgEngine::VgSplineVectorFunctorDescriptor::~VgSplineVectorFunctorDescriptor

(

)

[protected, virtual]

Class destructor.

---

Member Function Documentation

static VgRefPtr< VgSplineVectorFunctorDescriptor > VgEngine::VgSplineVectorFunctorDescriptor::create

(

)

[static]

This static method returns a new heap-allocated descriptor.

It is the only method that should be used to instantiate new descriptors. It is a way to make sure no one will delete it, except the last VgRefPtr pointing to it.

---

Member Data Documentation

float VgEngine::VgSplineVectorFunctorDescriptor::mDistanceFromSpline

The distance at which we will place the animated object from the spline.

Remarks:

this parameter is ignored if no orientation spline functor is used.

std::vector< VgPosition > VgEngine::VgSplineVectorFunctorDescriptor::mPoints

The vector of points of the spline.

float VgEngine::VgSplineVectorFunctorDescriptor::mSplineMetricRadius

The maximal metric radius of the rounded angle at spline points.

---

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

• VgSplineVectorFunctorDescriptor.h