THuiCosineMappingFunction Class Reference

class THuiCosineMappingFunction : public MHuiMappingFunction

Cosine mapping function.

Does not implement change flags, which means that if iFactor or iOffset is changed while the mapping function is in use, timed values will not notify the change.

Inherits from

Constructor & Destructor Documentation

THuiCosineMappingFunction(TReal32, TReal32)

IMPORT_C THuiCosineMappingFunction ( TReal32 aFactor = 1.0,
TReal32 aOffset = 0.0
)

Constructor.

Parameters

TReal32 aFactor = 1.0
TReal32 aOffset = 0.0

Member Functions Documentation

MapValue(TReal32, TInt)

IMPORT_C TReal32 MapValue ( TReal32 aValue,
TInt aMode
) const [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.

Member Data Documentation

TReal32 iFactor

TReal32 iFactor

TReal32 iOffset

TReal32 iOffset