VgEngine::VgSplineVectorFunctorDescriptor Class Reference

Inheritance diagram for VgEngine::VgSplineVectorFunctorDescriptor:

Static Public Member Functions
static VgRefPtr< VgSplineVectorFunctorDescriptor >	create ()

Public Attributes
std::vector< VgPosition >	mPoints
float	mSplineMetricRadius
float	mDistanceFromSpline
Public Attributes inherited from VgEngine::VgFunctorDescriptor
float	mStartTime
float	mEndTime

Protected Member Functions
	VgSplineVectorFunctorDescriptor ()
virtual	~VgSplineVectorFunctorDescriptor ()
Protected Member Functions inherited from VgEngine::VgFunctorDescriptor
	VgFunctorDescriptor ()

Additional Inherited Members
Public Member Functions inherited from VgEngine::VgFunctorDescriptor
virtual	~VgFunctorDescriptor ()
Public Member Functions inherited from VgEngine::VgReferenced
	VgReferenced ()
	VgReferenced (const VgReferenced &pThis)
virtual	~VgReferenced ()
VgReferenced &	operator= (const VgReferenced &pThis)
void	ref () const
int	unref () const
int	getNbReferences () const
Protected Attributes inherited from VgEngine::VgFunctorDescriptor
Private *	mPrivate
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences

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 ( )

protectedvirtual

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