Inheritance diagram for HPS::PointSampler:
HPS::Sampler HPS::Sprocket HPS::Object

Public Member Functions

void AddKeyframe (PointKeyframe const &in_keyframe)
 
void AddKeyframes (PointKeyframeArray const &in_keyframes)
 
void AddKeyframes (size_t in_count, PointKeyframe const in_keyframes[])
 
PointSplineControlValuesArray const & GetControlValues () const
 
PointKeyframeArray const & GetKeyframes () const
 
HPS::Type ObjectType () const
 
PointSampler (Sampler const &in_that)
 
PointSampler (PointSampler const &in_that)
 
void SetControlValues (PointSplineControlValuesArray const &in_control_points)
 
void SetKeyframes (PointKeyframeArray const &in_keyframes)
 
void SetKeyframes (size_t in_count, PointKeyframe const in_keyframes[])
 
- Public Member Functions inherited from HPS::Sampler
void Assign (Sampler const &in_that)
 
bool Equals (Sampler const &in_that) const
 
InterpolationType GetInterpolation () const
 
bool operator!= (Sampler const &in_that) const
 
Sampleroperator= (Sampler const &in_that)
 
Sampleroperator= (Sampler &&in_that)
 
bool operator== (Sampler const &in_that) const
 
Sampler (Sampler const &in_that)
 
void SetInterpolation (InterpolationType in_interpolation)
 
- Public Member Functions inherited from HPS::Sprocket
Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::PointSampler
 
- Static Public Attributes inherited from HPS::Sampler
static const HPS::Type staticType = HPS::Type::Sampler
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Public Types inherited from HPS::Sampler
enum  InterpolationType { InterpolationType::Constant, InterpolationType::Linear, InterpolationType::SphericalLinear, InterpolationType::Spline }
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Member Function Documentation

◆ AddKeyframe()

void HPS::PointSampler::AddKeyframe ( PointKeyframe const &  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

Parameters
in_keyframethe keyframe to add to this Sampler

◆ AddKeyframes() [1/2]

void HPS::PointSampler::AddKeyframes ( PointKeyframeArray const &  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.

Parameters
in_keyframesthe array of keyframes to add to this Sampler

◆ AddKeyframes() [2/2]

void HPS::PointSampler::AddKeyframes ( size_t  in_count,
PointKeyframe const  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.

Parameters
in_countthe number of keyframes in the in_keyframes array
in_keyframesthe array of keyframes to add to this Sampler

◆ GetControlValues()

PointSplineControlValuesArray const& HPS::PointSampler::GetControlValues ( ) const

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

PointKeyframeArray const& HPS::PointSampler::GetKeyframes ( ) const

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

HPS::Type HPS::PointSampler::ObjectType ( ) const
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::Sampler.

◆ SetControlValues()

void HPS::PointSampler::SetControlValues ( PointSplineControlValuesArray const &  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.

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() [1/2]

void HPS::PointSampler::SetKeyframes ( PointKeyframeArray const &  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.

Parameters
in_keyframesthe array of keyframes to add to this Sampler

◆ SetKeyframes() [2/2]

void HPS::PointSampler::SetKeyframes ( size_t  in_count,
PointKeyframe const  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.

Parameters
in_countthe number of keyframes in the in_keyframes array
in_keyframesthe array of keyframes to add to this Sampler

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