VgEngine::VgVectorInterpolationFunctorDescriptor Class Reference

This class implements descriptors for vector interpolation functors. More...

Inheritance diagram for VgEngine::VgVectorInterpolationFunctorDescriptor:

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

Public Attributes
VgEngine::VgPosition	mStartPosition
	The starting position. More...
VgEngine::VgPosition	mEndPosition
	The target position. More...
bool	mCubic
	This boolean value tells whether we should use a cubic function 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
	VgVectorInterpolationFunctorDescriptor ()
	Class constructor. More...
virtual	~VgVectorInterpolationFunctorDescriptor ()
	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 vector interpolation functors.

It will simply interpolate between the start and end vectors using linear interpolation. It is possible to set the functor to use a cubic function to have acceleration at start and deceleration at end.

Version

2.0.7729

Constructor & Destructor Documentation

VgEngine::VgVectorInterpolationFunctorDescriptor::VgVectorInterpolationFunctorDescriptor ( )

protected

Class constructor.

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

virtual VgEngine::VgVectorInterpolationFunctorDescriptor::~VgVectorInterpolationFunctorDescriptor ( )

protectedvirtual

Class destructor.

Member Function Documentation

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

bool VgEngine::VgVectorInterpolationFunctorDescriptor::mCubic

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

VgEngine::VgPosition VgEngine::VgVectorInterpolationFunctorDescriptor::mEndPosition

The target position.

VgEngine::VgPosition VgEngine::VgVectorInterpolationFunctorDescriptor::mStartPosition

The starting position.

---

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

• VgVectorInterpolationFunctorDescriptor.h