VgEngine::VgDiscreteQuaternionFunctorDescriptor Class Reference

This class describes a functor for orientations using discrete samples. More...

Inheritance diagram for VgEngine::VgDiscreteQuaternionFunctorDescriptor:

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

Public Attributes
std::vector< std::pair < VgOrientation, double > >	mOrientationValues
	The vector of orientations paired with the corresponding timestamp in seconds. More...
double	mInitialTimestamp
	The initial timestamp of the animation in seconds. More...
double	mFinalTimestamp
	The final timestamp of the animation in seconds. 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
	VgDiscreteQuaternionFunctorDescriptor ()
	Class constructor. More...
virtual	~VgDiscreteQuaternionFunctorDescriptor ()
	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 describes a functor for orientations using discrete samples.

The resulting functor will interpolate the orientations using spheric linear quaternion interpolation. The mInitialTimestamp and mFinalTimestamp members will be mapped with the animation's duration (meaning that initial timestamp correspond to animation start, and final timestamp will be mapped to animation end) The descriptor must contain at leats one orientation value.

Version

2.0.7729

Constructor & Destructor Documentation

VgEngine::VgDiscreteQuaternionFunctorDescriptor::VgDiscreteQuaternionFunctorDescriptor ( )

protected

Class constructor.

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

virtual VgEngine::VgDiscreteQuaternionFunctorDescriptor::~VgDiscreteQuaternionFunctorDescriptor ( )

protectedvirtual

Class destructor.

Member Function Documentation

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

Friends And Related Function Documentation

friend class VgObjectBridge

friend

Member Data Documentation

double VgEngine::VgDiscreteQuaternionFunctorDescriptor::mFinalTimestamp

The final timestamp of the animation in seconds.

double VgEngine::VgDiscreteQuaternionFunctorDescriptor::mInitialTimestamp

The initial timestamp of the animation in seconds.

std::vector< std::pair<VgOrientation, double> > VgEngine::VgDiscreteQuaternionFunctorDescriptor::mOrientationValues

The vector of orientations paired with the corresponding timestamp in seconds.

The timestamps are not necessarily greater than mInitialTimestamp or lower than mFinalTimestamp .

---

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

• VgDiscreteQuaternionFunctorDescriptor.h