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 = 0, InterpolationType.Linear = 1, InterpolationType.SphericalLinear = 2, InterpolationType.Spline = 3 }
 

Public Member Functions

void Assign (HPS.Sampler in_that)
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Sampler in_that)
 
override int GetHashCode ()
 
HPS.Sampler.InterpolationType GetInterpolation ()
 
override HPS.Type ObjectType ()
 
Sampler (HPS.Sampler in_that)
 
void SetInterpolation (HPS.Sampler.InterpolationType in_interpolation)
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static bool operator!= (HPS.Sampler a, HPS.Sampler b)
 
static bool operator== (HPS.Sampler a, HPS.Sampler b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Sprocket
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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 ( HPS.Sampler  in_that)
inline

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 ( HPS.Sampler  in_that)
inline

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

HPS.Sampler.InterpolationType HPS.Sampler.GetInterpolation ( )
inline

Returns the interpolation setting used by this Sampler.

Returns
in_interpolation the interpolation setting used by this Sampler.

◆ ObjectType()

override HPS.Type HPS.Sampler.ObjectType ( )
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.VectorSampler.

◆ SetInterpolation()

void HPS.Sampler.SetInterpolation ( HPS.Sampler.InterpolationType  in_interpolation)
inline

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:
  • internals/hps_sprk/source/cs/HPS.Sampler.cs