HPS.Sampler
- class HPS.Sampler : public HPS.Sprocket
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.
Subclassed by HPS.FloatSampler, HPS.PointSampler, HPS.QuaternionSampler, HPS.RGBColorSampler, HPS.VectorSampler
Public Types
- enum InterpolationType
The type of interpolation to be used on the keyframes that are part of the Sampler.
Values:
- SphericalLinear
Channel values will interpolated spherical-linearly between keyframes. If this is supplied to FloatSampler a linear interpolation is performed instead.
Public Functions
- void Assign (HPS.Sampler in_that)
Share the underlying smart-pointer of the Sampler source.
- bool Equals (HPS.Sampler in_that)
Check if the source Sampler points to the same underlying impl as this Sampler.
- HPS.Sampler.InterpolationType GetInterpolation ()
Returns the interpolation setting used by this Sampler.
- Return
in_interpolation the interpolation setting used by 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.
- void SetInterpolation (HPS.Sampler.InterpolationType in_interpolation)
Sets the interpolation to be used with this Sampler.
- Return
in_interpolation The interpolation to be used with this Sampler.