IInertiaProcessor::get_DesiredDisplacement method (manipulations.h)

Article
02/22/2024

The DesiredDisplacement property specifies the desired distance that the object will travel.

This property is read/write.

Syntax

HRESULT get_DesiredDisplacement(
  FLOAT *displacement
);

Parameters

displacement

Return value

None

Remarks

DesiredDisplacement and DesiredDeceleration are mutually exclusive. If one is set, the other should be NaN.

If inertia processing has already started, setting DesiredDisplacement 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

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	manipulations.h (include Manipulations.h)