GlsAnimation Library  1.0.6
Provides classes and functions to support animating GL Studio objects programmatically or with script files
Public Types | Public Member Functions | List of all members
disti::GlsKeyframeInterpolator< T > Struct Template Referenceabstract

An abstract base class for all keyframe interpolators. More...

#include <gls_keyframe.h>

Public Types

typedef stdortr1::shared_ptr< GlsKeyframeInterpolatorPtr
 Alias for easier reading.
 
typedef stdortr1::shared_ptr< const GlsKeyframeInterpolatorPtrConst
 Alias for easier reading.
 
typedef GlsKeyframeCurveBase::Key Key
 Alias for easier reading.
 
typedef T Value
 Alias for easier reading.
 
typedef Detail::FloatSelector< Value >::Type Float
 Alias for easier reading.
 

Public Member Functions

virtual ~GlsKeyframeInterpolator ()
 Destructor.
 
virtual Value operator() (const Key &key, const Key &lowerKey, const Key &upperKey, const Value &lowerValue, const Value &upperValue) const =0
 

Detailed Description

template<class T>
struct disti::GlsKeyframeInterpolator< T >

An abstract base class for all keyframe interpolators.

Member Function Documentation

template<class T>
virtual Value disti::GlsKeyframeInterpolator< T >::operator() ( const Key key,
const Key lowerKey,
const Key upperKey,
const Value lowerValue,
const Value upperValue 
) const
pure virtual

The interpolation function

Parameters
keyThe current key value.
lowerKeyThe key from a list of keyframes less than or equal to the key.
upperKeyThe key from a list of keyframes greater than or equal to the key.
lowerValueThe value associated with the lower key.
upperValueThe value associated with the upper key.
Precondition
lowerKey <= key <= upperKey

Implemented in disti::GlsColorInterpolationAdapter.


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