THuiTimedPoint Class Reference

class THuiTimedPoint

X/Y coordinate pair using timed values.

THuiTimedValue

Public Member Functions
THuiTimedPoint ()
THuiTimedPoint ( TReal32 , TReal32 )
TBool Changed ()
void ClearChanged ()
IMPORT_C void Finish ()
IMPORT_C TPoint Now ()
IMPORT_C THuiRealPoint RealNow ()
IMPORT_C THuiRealPoint RealTarget ()
IMPORT_C void Set (const THuiRealPoint &, TInt )
IMPORT_C void Set ( TReal32 , TInt )
IMPORT_C void SetFunction ( MHuiMappingFunction *)
IMPORT_C void SetStyle ( THuiInterpolationStyle )
IMPORT_C void SetWithSpeed (const THuiRealPoint &, TReal32 )
IMPORT_C void SetWithSpeed ( TReal32 , TReal32 )
IMPORT_C TPoint Target ()
Public Attributes
THuiTimedValue iX
THuiTimedValue iY
Private Attributes
TInt iSpare1
TInt iSpare2

Constructor & Destructor Documentation

THuiTimedPoint()

IMPORT_C THuiTimedPoint ( )

THuiTimedPoint(TReal32, TReal32)

IMPORT_C THuiTimedPoint ( TReal32 aX,
TReal32 aY
)

Constructor that sets default values.

Parameters

TReal32 aX Sets the timed value's initial X component.
TReal32 aY Sets the timed value's initial Y component.

Member Functions Documentation

Changed()

TBool Changed ( ) const

Checks if the point has been changed.

THuiTimedValue::Changed()

ClearChanged()

void ClearChanged ( )

Clears the changed flags for X and Y values.

THuiTimedValue::Changed()

Finish()

IMPORT_C void Finish ( )

Finishes the current interpolation.

Now()

IMPORT_C TPoint Now ( ) const

Returns the current interpolatad value of the point rounded to nearest integer values. Note that the THuiTimedPoint values are floating-point.

RealNow() For returning the floating-point current value.

RealNow()

IMPORT_C THuiRealPoint RealNow ( ) const

Returns the current value of the point.

RealTarget()

IMPORT_C THuiRealPoint RealTarget ( ) const

Returns the target value of the point.

Set(const THuiRealPoint &, TInt)

IMPORT_C void Set ( const THuiRealPoint & aPoint,
TInt aTransitionTime = 0
)

Sets the target for the timed point.

Parameters

const THuiRealPoint & aPoint Target point.
TInt aTransitionTime = 0 Duration for reaching the target.

Set(TReal32, TInt)

IMPORT_C void Set ( TReal32 aValue,
TInt aTransitionTime = 0
)

Sets the target value of both components of the timed point.

Parameters

TReal32 aValue New target value.
TInt aTransitionTime = 0 Duration for reaching the target.

SetFunction(MHuiMappingFunction *)

IMPORT_C void SetFunction ( MHuiMappingFunction * aFunction )

Sets the mapping function for both the X and Y components. For example you can use a mapping function to constrain your visuals onto a path.

Note:

If the mapping function does not support multiple modes (mode for X calculation and mode for Y calculation), both the X and Y components of the timed point will share the same value.

The mapping component/mode parameter used to calculate value for X is mode 0, and the value for U is mode 1. MHuiMappingFunction::MapValue() is called twice with mode 0 for X and mode 1 for Y. CHuiCurvePath for curve path mapping fuction.

Parameters

MHuiMappingFunction * aFunction

SetStyle(THuiInterpolationStyle)

IMPORT_C void SetStyle ( THuiInterpolationStyle aStyle )

Sets the interpolation style of both components of the point.

Parameters

THuiInterpolationStyle aStyle Timed value interpolation style.

SetWithSpeed(const THuiRealPoint &, TReal32)

IMPORT_C void SetWithSpeed ( const THuiRealPoint & aPoint,
TReal32 aUnitsPerSecond
)

Sets the target value for the timed point, with a transition that is done using a specific speed.

Parameters

const THuiRealPoint & aPoint Target point.
TReal32 aUnitsPerSecond Units per second during the transition.

SetWithSpeed(TReal32, TReal32)

IMPORT_C void SetWithSpeed ( TReal32 aValue,
TReal32 aUnitsPerSecond
)

Sets the target value of both components of the timed point.

Parameters

TReal32 aValue New target value.
TReal32 aUnitsPerSecond Speed of change.

Target()

IMPORT_C TPoint Target ( ) const

Returns the target value of the point rounded to nearest integer values. Note that the THuiTimedPoint values are floating-point.

RealTarget() For returning the floating-point values.

Member Data Documentation

TInt iSpare1

TInt iSpare1 [private]

TInt iSpare2

TInt iSpare2 [private]

THuiTimedValue iX

THuiTimedValue iX

X coordinate.

THuiTimedValue iY

THuiTimedValue iY

Y coordinate.