VgEngine::VgSplineOrientationQuaternionFunctorDescriptor Class Reference

This class is a descriptor for quaternion functors that follow orientation of given spline definitions. More...

Inheritance diagram for VgEngine::VgSplineOrientationQuaternionFunctorDescriptor:

Static Public Member Functions
static VgEngine::VgRefPtr < VgEngine::VgSplineOrientationQuaternionFunctorDescriptor >	create (VgEngine::VgRefPtr< VgEngine::VgSplineVectorFunctorDescriptor >const &pSplineVectorFunctorDescriptor)
	This static method returns a new heap-allocated descriptor. More...

Public Attributes
float	mPostHeading
	Heading modification to apply in addition of the spline orientation (in degrees). More...
float	mPostPitch
	Pitching modification to apply in addition of the spline orientation (in degrees). More...
float	mPostBank
	Banking modification to apply in addition of the spline orientation (in degrees). More...
VgRefPtr < VgSplineVectorFunctorDescriptor >	mSplineVectorFunctorDescriptor
	The the spline vector functor descriptor to use. More...
Public Attributes inherited from VgEngine::VgFunctorDescriptor
float	mStartTime
	The functor start time (relative to the animation's start time). More...
float	mEndTime
	The functor's end time (relative to the animation's start time). More...

Protected Member Functions
	VgSplineOrientationQuaternionFunctorDescriptor (VgRefPtr< VgSplineVectorFunctorDescriptor >const &pSplineVectorFunctorDescriptor)
	Class constructor. More...
virtual	~VgSplineOrientationQuaternionFunctorDescriptor ()
	Class destructor. More...
Protected Member Functions inherited from VgEngine::VgFunctorDescriptor
	VgFunctorDescriptor ()
	This class constructor is protected to prevent instantiation. More...

Additional Inherited Members
Public Member Functions inherited from VgEngine::VgFunctorDescriptor
virtual	~VgFunctorDescriptor ()
	Class destructor. More...
Public Member Functions inherited from VgEngine::VgReferenced
	VgReferenced ()
	Constructor. More...
	VgReferenced (const VgReferenced &pThis)
	Copy constructor. More...
virtual	~VgReferenced ()
	Destructor. More...
VgReferenced &	operator= (const VgReferenced &pThis)
	Assignment operator. More...
void	ref () const
	This method is used to add a reference to this object. More...
int	unref () const
	This method is used to remove a reference to this object. More...
int	getNbReferences () const
	Retrieves the number of references to this object. More...
Protected Attributes inherited from VgEngine::VgFunctorDescriptor
Private *	mPrivate
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences
	The number of references to this object. More...

Detailed Description

This class is a descriptor for quaternion functors that follow orientation of given spline definitions.

It bases itself on a VgSplineVectorFunctorDescriptor that defines the spline to use. It allows the user to specify an additional rotation parameter that will be applied after the spline's rotation.

Version

2.0.7729

Constructor & Destructor Documentation

VgEngine::VgSplineOrientationQuaternionFunctorDescriptor::VgSplineOrientationQuaternionFunctorDescriptor ( VgRefPtr< VgSplineVectorFunctorDescriptor >const &  pSplineVectorFunctorDescriptor )

protected

Class constructor.

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

virtual VgEngine::VgSplineOrientationQuaternionFunctorDescriptor::~VgSplineOrientationQuaternionFunctorDescriptor ( )

protectedvirtual

Class destructor.

Member Function Documentation

static VgEngine::VgRefPtr< VgEngine::VgSplineOrientationQuaternionFunctorDescriptor > VgEngine::VgSplineOrientationQuaternionFunctorDescriptor::create ( VgEngine::VgRefPtr< VgEngine::VgSplineVectorFunctorDescriptor >const &  pSplineVectorFunctorDescriptor )

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::VgSplineOrientationQuaternionFunctorDescriptor::mPostBank

Banking modification to apply in addition of the spline orientation (in degrees).

float VgEngine::VgSplineOrientationQuaternionFunctorDescriptor::mPostHeading

Heading modification to apply in addition of the spline orientation (in degrees).

float VgEngine::VgSplineOrientationQuaternionFunctorDescriptor::mPostPitch

Pitching modification to apply in addition of the spline orientation (in degrees).

VgRefPtr< VgSplineVectorFunctorDescriptor > VgEngine::VgSplineOrientationQuaternionFunctorDescriptor::mSplineVectorFunctorDescriptor

The the spline vector functor descriptor to use.

---

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

• VgSplineOrientationQuaternionFunctorDescriptor.h