VgEngine::VgAxialRotationQuaternionFunctorDescriptor Class Reference

This class implements descriptors for axial rotation functors. More...

Inheritance diagram for VgEngine::VgAxialRotationQuaternionFunctorDescriptor:

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

Public Attributes
VgOrientation	mPreOrientation
	The pre-orientation value. More...
float	mAxis [3]
	The rotation axis. More...
float	mStartAngle
	This is the starting rotation angle (in degrees). More...
float	mEndAngle
	This is the target rotation angle (in degrees). More...
bool	mCubic
	This boolean value tells whether a cubic function should be used to add acceleration and deceleration (true) or pure linear with constant velocity (false). 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
	VgAxialRotationQuaternionFunctorDescriptor ()
	Class constructor. More...
virtual	~VgAxialRotationQuaternionFunctorDescriptor ()
	Class destructor. More...
Protected Member Functions inherited from VgEngine::VgFunctorDescriptor
	VgFunctorDescriptor ()
	This class constructor is protected to prevent instantiation. More...

Friends
class	VgObjectBridge

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 implements descriptors for axial rotation functors.

It will simply interpolate between two angle values and apply rotation of the given angle along the axis. It is possible to set the functor to use a cubic function to have acceleration at start and deceleration at end. There is a possibility of setting a fixed pre-orientation value that will be applied prior to the interpolation's value.

Version

2.0.7729

Constructor & Destructor Documentation

VgEngine::VgAxialRotationQuaternionFunctorDescriptor::VgAxialRotationQuaternionFunctorDescriptor ( )

protected

Class constructor.

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

Version

2.0.7729

virtual VgEngine::VgAxialRotationQuaternionFunctorDescriptor::~VgAxialRotationQuaternionFunctorDescriptor ( )

protectedvirtual

Class destructor.

Version

2.0.7729

Member Function Documentation

static VgEngine::VgRefPtr< VgAxialRotationQuaternionFunctorDescriptor > VgEngine::VgAxialRotationQuaternionFunctorDescriptor::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.

Version

2.0.7729

Friends And Related Function Documentation

friend class VgObjectBridge

friend

Member Data Documentation

float VgEngine::VgAxialRotationQuaternionFunctorDescriptor::mAxis[3]

The rotation axis.

Warning

If axis vector length is not long enough (below 1e-6), the functor creation will fail.

Version

2.0.7729

bool VgEngine::VgAxialRotationQuaternionFunctorDescriptor::mCubic

This boolean value tells whether a cubic function should be used to add acceleration and deceleration (true) or pure linear with constant velocity (false).

Version

2.0.7729

float VgEngine::VgAxialRotationQuaternionFunctorDescriptor::mEndAngle

This is the target rotation angle (in degrees).

Version

2.0.7729

VgOrientation VgEngine::VgAxialRotationQuaternionFunctorDescriptor::mPreOrientation

The pre-orientation value.

This will be applied each time the functor is evaluated, before the interpolated orientation.

Version

2.0.7729

float VgEngine::VgAxialRotationQuaternionFunctorDescriptor::mStartAngle

This is the starting rotation angle (in degrees).

Version

2.0.7729

---

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

• VgAxialRotationQuaternionFunctorDescriptor.h