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:

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.

Spline

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

Public Functions

void Assign (HPS.Sampler in_that)

Share the underlying smart-pointer of the Sampler source.

Param in_that

The Sampler source of the assignment.

Return

A reference to this Sampler.

override void Dispose ()

bool Equals (HPS.Sampler in_that)

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

Param in_that

The source Sampler to compare to this Sampler.

Return

true if the objects reference the same impl, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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.

Sampler ()

Sampler (HPS.Sampler in_that)

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.

Public Static Functions

bool operator!= (HPS.Sampler a, HPS.Sampler b)

bool operator== (HPS.Sampler a, HPS.Sampler b)