VgEngine::VgAxialRotationQuaternionFunctorDescriptor Class Reference

Inheritance diagram for VgEngine::VgAxialRotationQuaternionFunctorDescriptor:

Static Public Member Functions
static VgEngine::VgRefPtr< VgAxialRotationQuaternionFunctorDescriptor >	create ()

Public Attributes
VgOrientation	mPreOrientation
float	mAxis [3]
float	mStartAngle
float	mEndAngle
bool	mCubic
Public Attributes inherited from VgEngine::VgFunctorDescriptor
float	mStartTime
float	mEndTime

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

Friends
class	VgObjectBridge

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 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 determines whether a cubic function is used to control the animation velocity. If true, animation will accelerate at the start and decelerate at the end. If set to false, then the animation velocity will be have a constant linear velocity.

The default value is 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