HPS.QuaternionSampler Class Reference
Inheritance diagram for HPS.QuaternionSampler:
HPS.Sampler HPS.Sprocket HPS.Object

Public Member Functions

void AddKeyframe (HPS.QuaternionKeyframe in_keyframe)
 
void AddKeyframes (HPS.QuaternionKeyframe[] in_keyframes)
 
override void Dispose ()
 
HPS.QuaternionSplineControlValues [] GetControlValues ()
 
HPS.QuaternionKeyframe [] GetKeyframes ()
 
override HPS.Type ObjectType ()
 
QuaternionSampler (HPS.Sampler in_that)
 
QuaternionSampler (HPS.QuaternionSampler in_that)
 
void SetControlValues (HPS.QuaternionSplineControlValues[] in_control_points)
 
void SetKeyframes (HPS.QuaternionKeyframe[] in_keyframes)
 
- Public Member Functions inherited from HPS.Sampler
void Assign (HPS.Sampler in_that)
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Sampler in_that)
 
override int GetHashCode ()
 
HPS.Sampler.InterpolationType GetInterpolation ()
 
override HPS.Type ObjectType ()
 
Sampler (HPS.Sampler in_that)
 
void SetInterpolation (HPS.Sampler.InterpolationType in_interpolation)
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Sampler
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Sprocket
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Sampler
enum  InterpolationType { InterpolationType.Constant = 0, InterpolationType.Linear = 1, InterpolationType.SphericalLinear = 2, InterpolationType.Spline = 3 }
 
- Static Public Member Functions inherited from HPS.Sampler
static bool operator!= (HPS.Sampler a, HPS.Sampler b)
 
static bool operator== (HPS.Sampler a, HPS.Sampler b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Member Function Documentation

◆ AddKeyframe()

void HPS.QuaternionSampler.AddKeyframe ( HPS.QuaternionKeyframe  in_keyframe)
inline

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

Parameters
in_keyframethe keyframe to add to this Sampler

◆ AddKeyframes()

void HPS.QuaternionSampler.AddKeyframes ( HPS.QuaternionKeyframe []  in_keyframes)
inline

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.

Parameters
in_keyframesthe array of keyframes to add to this Sampler

◆ GetControlValues()

HPS.QuaternionSplineControlValues [] HPS.QuaternionSampler.GetControlValues ( )
inline

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

Returns
An array of control point values previously specified to SetControlValues.

◆ GetKeyframes()

HPS.QuaternionKeyframe [] HPS.QuaternionSampler.GetKeyframes ( )
inline

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.

Returns
An array of keyframes contained in this Sampler.

◆ ObjectType()

override HPS.Type HPS.QuaternionSampler.ObjectType ( )
inlinevirtual

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).

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

Reimplemented from HPS.Object.

◆ SetControlValues()

void HPS.QuaternionSampler.SetControlValues ( HPS.QuaternionSplineControlValues []  in_control_points)
inline

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.

Parameters
in_control_pointsThe control points to use for interpolation. When executing playback this array must be equal in size to the keyframe array associated with this Sampler.

◆ SetKeyframes()

void HPS.QuaternionSampler.SetKeyframes ( HPS.QuaternionKeyframe []  in_keyframes)
inline

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.

Parameters
in_keyframesthe array of keyframes to add to this Sampler

The documentation for this class was generated from the following file:
  • internals/hps_sprk/source/cs/HPS.QuaternionSampler.cs