IInertiaProcessor::put_InitialOriginY method (manipulations.h)

Article
02/22/2024

The InitialOriginY property specifies the starting vertical location for a target with inertia.

This property is read/write.

Syntax

HRESULT put_InitialOriginY(
  FLOAT y
);

Parameters

y

Return value

None

Remarks

A user can manipulate an object to set the InitialOriginY to be outside of the elastic bounds. Setting InitialOriginY to a value outside of the elastic bounds will cause an exception to be thrown. To prevent users from setting the origin out of bounds, check that InitialOriginY is valid before setting it on an IInertiaProcessor interface. If Inertia processing has already started, calling put_InitialOriginY() will reset the inertia state to initial time stamp.

All locations used for the inertia and manipulation processor are relative. If you want to use screen coordinates, you pass screen coordinates to the manipulation (or inertia) processor; if you want to use absolute coordinates, you pass those into the processor you are using.

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)