IInertiaProcessor::DesiredExpansion property

The DesiredExpansion property specifies the desired change in the object's average radius.

This property is read/write.

Syntax


HRESULT put_DesiredExpansion(
  [in]  FLOAT expansion
);

HRESULT get_DesiredExpansion(
  [out] FLOAT *expansion
);

Property value

Desired change in the target object's average radius.

Error codes

Returns S_OK on success; otherwise, returns an error code such as E_FAIL.

Remarks

DesiredExpansion and DesiredExpansionDeceleration are mutually exclusive. If one is set, the other should be NaN.

If inertia processing has already started, setting DesiredExpansion will reset the inertia engine to the initial state with new deceleration value applied.

Call this function to set the initial state of inertia. You would call this function most likely during the ManipulationCompleted event of the IManipulationProcessor or in the constructor of the IInertiaProcessor interface.

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Manipulations.h (include Manipulations.h)

See also

Inertia Mechanics
Handling Inertia in Unmanaged Code
DesiredExpansionDeceleration
InitialExpansionVelocity
IInertiaProcessor
Properties

 

 

Community Additions

ADD
Show: