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:

Collaboration diagram for VgEngine::VgSplineOrientationQuaternionFunctorDescriptor:

List of all members.

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.
Public Attributes
float	mPostHeading
	Heading modification to apply in addition of the spline orientation (in degrees).
float	mPostPitch
	Pitching modification to apply in addition of the spline orientation (in degrees).
float	mPostBank
	Banking modification to apply in addition of the spline orientation (in degrees).
VgRefPtr < VgSplineVectorFunctorDescriptor >	mSplineVectorFunctorDescriptor
	The the spline vector functor descriptor to use.
Protected Member Functions
	VgSplineOrientationQuaternionFunctorDescriptor (VgRefPtr< VgSplineVectorFunctorDescriptor >const &pSplineVectorFunctorDescriptor)
	Class constructor.
virtual	~VgSplineOrientationQuaternionFunctorDescriptor ()
	Class destructor.

---

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

(

)

[protected, virtual]

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