HBhvInterpolatorQuatSquad

class HBhvInterpolatorQuatSquad

The HBhvInterpolatorQuatSquad class controls quaternion based rotation. This class can be used for camera interpolation as well other targets.

Inherits from: HBhvInterpolator

Methods

HBhvInterpolatorQuatSquad::HBhvInterpolatorQuatSquad(HBhvAnimation *animation = 0, char const *name = 0)

Constructs an HBhvInterpolatorQuatSquad object.

Parameters

animation: Animation that this interpolator belongs to

name: Name of Interpolator

char const *HBhvInterpolatorQuatSquad::GetType()

virtual

Returns

The type of the interpolator which is ‘QuatRot’.
virtual HBhvInterpolator *HBhvInterpolatorQuatSquad::CreateInstance(HBhvAnimation *ainst)

virtual

In special cases, you may want an interpolator that references this interpolator without changing it. Use this method to create the new interpolator passing a pointer to the animation that you want it to be associated with.

Parameters

ainst: The animation instance that this interpolator is associated with.

Returns

The newly created interpolator that references this interpolator.
void HBhvInterpolatorQuatSquad::Insert(HQuat q, int l = 0)

This method creates a new quaternion rotation keyframe with the passed q value and then inserts it after the passed position l into the keyframe array.

Parameters

q: The quaternion to use for new keyframe.

l: The array position to insert item after.

void HBhvInterpolatorQuatSquad::InsertLinear(HQuat q, int l = 0)

This method creates a new linear quaternion rotation keyframe with the passed q value and then inserts it after the passed position l into the keyframe array.

Parameters

q: The quaternion to use for new keyframe.

l: The array position to insert item after.

void HBhvInterpolatorQuatSquad::Replace(HQuat q, int l)

Replaces the item at the given position in the keyframe array with a new quaternion rotation keyframe that was created with the passed q value.

Parameters

q: The quaternion to use for the replace keyframe

l: The array position to replace.

void HBhvInterpolatorQuatSquad::ReplaceLinear(HQuat q, int l)

Replaces the item at the given position in the keyframe array with a new linear quaternion rotation keyframe that was created with the passed q value.

Parameters

q: The quaternion to use for the replace keyframe

l: The array position to replace.

void HBhvInterpolatorQuatSquad::AdjustQuaternions()

Recalculates the quaternion array to ensure shortest rotation path.

virtual void HBhvInterpolatorQuatSquad::Serialize(HUtilityXMLGenerator *xmlgen)

virtual

Writes XML data to a buffer using the passed XML generator.

virtual void HBhvInterpolatorQuatSquad::Interpolate(int keyframe, float fraction)

virtual

Performs an interpolation on the animation target.

Parameters

keyframe: The reference keyframe for this interpolation.

fraction: The fraction value from the specified keyframe to the next keyframe. The value is from 0 to 1.

virtual void HBhvInterpolatorQuatSquad::Evaluate(int keyframe, float fraction, bool &hasPos, HPoint &pos, bool &hasQuat, HQuat &quat, bool &hasScale, HPoint &scale)

virtual

virtual void HBhvInterpolatorQuatSquad::CalculateQuat(int keyframe, float fraction, HQuat &res)

virtual

Calculates the quaternion interpolation given a reference keyframe and a fraction.

Parameters

keyframe: The reference keyframe for this interpolation.

fraction: The fraction value from the specified keyframe to the next keyframe. The value is from 0 to 1.

res: Returns the result of the calculation.

static void *HBhvInterpolatorQuatSquad::XMLCallback(HUtilityXMLTag *xt, bool open, void *m_pExtraData)

static

This is XML read callback which parses XML data and then populates the member variables with the associated values.

virtual void HBhvInterpolatorQuatSquad::InterpolateCamera(HQuat &quat, bool simulate = false)

protected virtual

Calculates the interpolated camera orientation and position for camera types that are position driven.

Parameters

pos: New Camera Position Reference
virtual void HBhvInterpolatorQuatSquad::InterpolateCamera2(HQuat &quat, bool simulate = false)

protected virtual

Calculates the interpolated camera orientation for camera types that are target driven.

Parameters

pos: New Camera Position Reference