Crazy Eddie's GUI System  ${CEGUI_VERSION}
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
CEGUI::Interpolator Class Referenceabstract

Defines a 'interpolator' class. More...

Inherits CEGUI::AllocatedObject< Interpolator >, and CEGUI::AllocatedObject< Interpolator >.

Inherited by CEGUI::QuaternionSlerpInterpolator, CEGUI::QuaternionSlerpInterpolator, CEGUI::TplInterpolatorBase, CEGUI::TplInterpolatorBase, and Interpolator_wrapper.

+ Collaboration diagram for CEGUI::Interpolator:

Public Member Functions

virtual ~Interpolator ()
 destructor
 
virtual const StringgetType () const =0
 returns type string of this interpolator
 
virtual String interpolateAbsolute (const String &value1, const String &value2, float position)=0
 
virtual String interpolateRelative (const String &base, const String &value1, const String &value2, float position)=0
 
virtual String interpolateRelativeMultiply (const String &base, const String &value1, const String &value2, float position)=0
 
virtual ~Interpolator ()
 destructor
 
virtual const StringgetType () const =0
 returns type string of this interpolator
 
virtual String interpolateAbsolute (const String &value1, const String &value2, float position)=0
 
virtual String interpolateRelative (const String &base, const String &value1, const String &value2, float position)=0
 
virtual String interpolateRelativeMultiply (const String &base, const String &value1, const String &value2, float position)=0
 

Detailed Description

Defines a 'interpolator' class.

Interpolator allows you to interpolate between 2 properties. You can jut pass them as strings and Interpolator does everything for you.

If you want to define your own interpolator, inherit this class and add it to AnimationManager via AnimationManager::addInterpolator to make it available for animations.

See also
AnimationManager

Member Function Documentation

virtual String CEGUI::Interpolator::interpolateAbsolute ( const String value1,
const String value2,
float  position 
)
pure virtual
virtual String CEGUI::Interpolator::interpolateAbsolute ( const String value1,
const String value2,
float  position 
)
pure virtual
virtual String CEGUI::Interpolator::interpolateRelative ( const String base,
const String value1,
const String value2,
float  position 
)
pure virtual
virtual String CEGUI::Interpolator::interpolateRelative ( const String base,
const String value1,
const String value2,
float  position 
)
pure virtual
virtual String CEGUI::Interpolator::interpolateRelativeMultiply ( const String base,
const String value1,
const String value2,
float  position 
)
pure virtual

this is used when Affector is set to apply values in relative multiply mode (application method == AM_RelativeMultiply)

Implemented in CEGUI::QuaternionSlerpInterpolator, CEGUI::QuaternionSlerpInterpolator, CEGUI::TplDiscreteInterpolator< T >, CEGUI::TplDiscreteInterpolator< T >, CEGUI::TplLinearInterpolator< T >, and CEGUI::TplLinearInterpolator< T >.

Referenced by CEGUI::Affector::apply().

virtual String CEGUI::Interpolator::interpolateRelativeMultiply ( const String base,
const String value1,
const String value2,
float  position 
)
pure virtual

this is used when Affector is set to apply values in relative multiply mode (application method == AM_RelativeMultiply)

Implemented in CEGUI::QuaternionSlerpInterpolator, CEGUI::QuaternionSlerpInterpolator, CEGUI::TplDiscreteInterpolator< T >, CEGUI::TplDiscreteInterpolator< T >, CEGUI::TplLinearInterpolator< T >, and CEGUI::TplLinearInterpolator< T >.