MHuiMappingFunction Class Reference

class MHuiMappingFunction

Mapping function interface. Timed values use this interface for mapping the return value of a timed value evaluation. Can be used to define custom interpolation functions for example timed values.

THuiTimedValue::SetFunction()

Constructor & Destructor Documentation

~MHuiMappingFunction()

~MHuiMappingFunction ( ) [inline, virtual]

Virtual destructor.

Member Functions Documentation

MapValue(TReal32, TInt)

TReal32 MapValue ( TReal32 aValue,
TInt aMode
) const [pure virtual]

Perform the mapping. Defines a function y = f(x, mode).

Implement this method that calculates a output value for a timed value based on the input value and a component/mode parameter.

For example the aValue input could be an angle, and the aMode could be a X or Y component enumeration, then the MapValue could calculate return a x or y position on a curve path.

Parameters

TReal32 aValue Unmapped value.
TInt aMode Mapping mode used for mapping this value.

MappingFunctionChanged()

IMPORT_C TBool MappingFunctionChanged ( ) const [virtual]

Determines whether the mapping function has changed since the last call to MHuiMappingFunction::MappingFunctionClearChanged() .

By default, mapping functions themselves are assumed to be constant (not changing over time).

MappingFunctionClearChanged()

IMPORT_C void MappingFunctionClearChanged ( ) [virtual]

Clears the change flags of the mapping function. This is called by the refresh loop after a frame has been fully drawn.