#include <sprk.h>
|
static const HPS::Type | staticType = HPS::Type::Sampler |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
template<typename T > |
static intptr_t | ClassID () |
|
Sampler is an abstract class which is contains settings common to all kinds of Samplers. A Sampler is an object that contains a series of Keyframes and which describe how the Animation will interpolate between the values specified in the Keyframes. Objects of the Sampler class should not be instantiated directly, rather, users should created objects of type FloatSampler, VectorSampler, PointSampler or RGBColorSampler, based on the type of data required by the Channel to which the Sampler will be assigned.
◆ 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.
|
◆ Assign()
void HPS::Sampler::Assign |
( |
Sampler const & |
in_that | ) |
|
Share the underlying smart-pointer of the Sampler source.
- Parameters
-
in_that | The 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
-
- Returns
- true if the objects reference the same impl, false otherwise.
◆ GetInterpolation()
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 |
◆ operator!=()
bool HPS::Sampler::operator!= |
( |
Sampler const & |
in_that | ) |
const |
Check if the source Sampler points to a different impl than this Sampler.
- Parameters
-
- 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
-
- Returns
- true if the objects reference the same impl, false otherwise.
◆ SetInterpolation()
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: