QuaternionSampler

class HPS.QuaternionSampler : public HPS.Sampler 

A QuaternionSampler is a type of Sampler which holds Keyframe which specify values as Quaternions. For example, if a Channel is setup to animate the value of the camera’s target, the values assumed by the camera target will have to be specified as Quaternions, and therefore be held in QuaternionKeyframes, which will be collected in a QuaternionSampler.

Public Functions

void AddKeyframe (HPS.QuaternionKeyframe in_keyframe)

Adds the provided keyframe to this Sampler. The provided keyframe will be automatically sorted into the Sampler. If the sampler already contains a keyframe targeting the same timer tick as in_keyframe, it will be replaced

Param in_keyframe: the keyframe to add to this Sampler

void AddKeyframes (HPS.QuaternionKeyframe[] in_keyframes)

Adds the provided keyframes to this Sampler. The provided keyframes will be automatically sorted and validated. Adding a key frame will replace already existing keyframes that target the same timer tick. Each element in in_keyframe should target a different timer tick. Not complying will result in an exception of type HPS.InvalidSpecificationException being thrown.

Param in_keyframes: the array of keyframes to add to this Sampler

override void Dispose ()

HPS.QuaternionSplineControlValues[] GetControlValues ()

Returns the control values this Sampler is set to use during Spline interpolation of keyframe values.

Return: An array of control point values previously specified to SetControlValues.

HPS.QuaternionKeyframe[] GetKeyframes ()

Returns the keyframes contained in this Sampler. Because keyframes are sorted as they are added to the Sampler, the order of keyframes returned might not match the order in which they were inserted in this Sampler.

Return: An array of keyframes contained in this Sampler.

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return: The declared type of the object in question, which may differ from the true, underlying type.

QuaternionSampler ()

QuaternionSampler (HPS.QuaternionSampler in_that)

QuaternionSampler (HPS.Sampler in_that)

void SetControlValues (HPS.QuaternionSplineControlValues[] in_control_points)

Sets control values used during Spline interpolation of keyframe values. If this Sampler is not set to use Spline interpolation these values will be ignored during playback.

Param in_control_points: The control points to use for interpolation. When executing playback this array must be equal in size to the keyframe array associated with this Sampler.

void SetKeyframes (HPS.QuaternionKeyframe[] in_keyframes)

Replaces the keyframes on this Sampler with those provided The provided keyframes will be automatically sorted and validated. Each element in in_keyframe should target a different timer tick. Not complying will result in an exception of type HPS.InvalidSpecificationException being thrown.

Param in_keyframes: the array of keyframes to add to this Sampler