Om  1.0.0
A universal framework for multimedia simulation
Public Types | Public Member Functions | List of all members
om::math::Interpolation Class Reference

A class that enumerates the different types of sampled function interpolation. More...

#include <omInterpolation.h>

Public Types

enum  Enum {
  UNDEFINED = 0, NONE = 1, NEAREST = NONE, LINEAR = 2,
  BEZIER = 3, HERMITE = 4, B_SPLINE = 5, SINC = 6,
  SLERP = 7
}
 An enum type which represents the different interpolation types. More...
 

Public Member Functions

 Interpolation ()
 Create a new interpolation type with the UNDEFINED enum value. More...
 
 Interpolation (Enum newType)
 Create a new interpolation type with the specified interpolation type enum value. More...
 
 operator Enum () const
 Convert this interpolation type to an enum value. More...
 
data::String toString () const
 Return a string representation of the interpolation type. More...
 
 operator data::String () const
 Convert this interpolation type into a string representation. More...
 

Detailed Description

A class that enumerates the different types of sampled function interpolation.

Member Enumeration Documentation

An enum type which represents the different interpolation types.

Enumerator
UNDEFINED 

An undefined or unknown interpolation type.

NONE 

An interpolation type where no interpolation is performed.

The nearest sample value is used to determine the final interpolated value.

NEAREST 

An interpolation type where the nearest sample value is used to determine the final interpolated value.

LINEAR 

An interpolation type where basic linear interpolation is used between end points.

BEZIER 

An interpolation type where cubic interpolation is used to interpolate between end points + control points.

This type of interpolation requires an additional control point for each end point that determines the shape of the curve.

HERMITE 

An interpolation type where cubic interpolation is used to interpolate between end points + tangents.

This type of interpolation requires an additional tangent value for each end point that determines the shape of the curve.

B_SPLINE 

An interpolation type which only guarantees to go through the start and end points, but not necessarily the middle ones.

SINC 

An interpolation type which uses a sinc low-pass filter to interpolate control points.

SLERP 

An interpolation type which uses spherical linear interpolation for correct rotation interpolation.

This animation type is only valid for quaternion attribute types (4-component vectors).

Constructor & Destructor Documentation

om::math::Interpolation::Interpolation ( )
inline

Create a new interpolation type with the UNDEFINED enum value.

om::math::Interpolation::Interpolation ( Enum  newType)
inline

Create a new interpolation type with the specified interpolation type enum value.

Member Function Documentation

om::math::Interpolation::operator Enum ( ) const
inline

Convert this interpolation type to an enum value.

data::String om::math::Interpolation::toString ( ) const

Return a string representation of the interpolation type.

om::math::Interpolation::operator data::String ( ) const
inline

Convert this interpolation type into a string representation.


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