Inheritance diagram for HPS::Sampler:
HPS::Sprocket HPS::Object HPS::FloatSampler HPS::PointSampler HPS::QuaternionSampler HPS::RGBColorSampler HPS::VectorSampler

Public Types

enum  InterpolationType { InterpolationType::Constant, InterpolationType::Linear, InterpolationType::SphericalLinear, InterpolationType::Spline }
 

Public Member Functions

void Assign (Sampler const &in_that)
 
bool Equals (Sampler const &in_that) const
 
InterpolationType GetInterpolation () const
 
HPS::Type ObjectType () 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::Sampler
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Member Enumeration Documentation

◆ InterpolationType

The type of interpolation to be used on the keyframes that are part of the Sampler.

Enumerator
Constant 

Channel values will not be interpolated between keyframes.

Linear 

Channel values will interpolated linearly between keyframes.

SphericalLinear 

Channel values will interpolated spherical-linearly between keyframes. If this is supplied to FloatSampler a linear interpolation is performed instead.

Spline 

Channel values will interpolated between keyframes by computing a spline from control values specified alongside the keyframes.

Member Function Documentation

◆ Assign()

void HPS::Sampler::Assign ( Sampler const &  in_that)

Share the underlying smart-pointer of the Sampler source.

Parameters
in_thatThe Sampler source of the assignment.
Returns
A reference to this Sampler.

◆ Equals()

bool HPS::Sampler::Equals ( Sampler const &  in_that) const

Check if the source Sampler points to the same underlying impl as this Sampler.

Parameters
in_thatThe source Sampler to compare to this Sampler.
Returns
true if the objects reference the same impl, false otherwise.

◆ GetInterpolation()

InterpolationType HPS::Sampler::GetInterpolation ( ) const

Returns the interpolation setting used by this Sampler.

Returns
in_interpolation the interpolation setting used by this Sampler.

◆ ObjectType()

HPS::Type HPS::Sampler::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::Object.

Reimplemented in HPS::FloatSampler, HPS::QuaternionSampler, HPS::PointSampler, HPS::VectorSampler, and HPS::RGBColorSampler.

◆ operator!=()

bool HPS::Sampler::operator!= ( Sampler const &  in_that) const

Check if the source Sampler points to a different impl than this Sampler.

Parameters
in_thatThe source Sampler to compare to this Sampler.
Returns
true if the objects reference different impls, false otherwise.

◆ operator==()

bool HPS::Sampler::operator== ( Sampler const &  in_that) const

Check if the source Sampler points to the same underlying impl as this Sampler.

Parameters
in_thatThe source Sampler to compare to this Sampler.
Returns
true if the objects reference the same impl, false otherwise.

◆ SetInterpolation()

void HPS::Sampler::SetInterpolation ( InterpolationType  in_interpolation)

Sets the interpolation to be used with this Sampler.

Returns
in_interpolation The interpolation to be used with this Sampler.

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