InitialAngularVelocity Property

IInertiaProcessor::InitialAngularVelocity property

The InitialAngularVelocity property specifies the rotational (angular) velocity of the target when movement begins.

This property is read/write.

Syntax


HRESULT put_InitialAngularVelocity(
  [in]  FLOAT velocity
);

HRESULT get_InitialAngularVelocity(
  [out] FLOAT *velocity
);

Property value

The rotational (angular) velocity of the target when movement begins.

Error codes

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

Remarks

DesiredRotation and DesiredAngularDeceleration are mutually exclusive. If one is set, the other should be NaN. If the DesiredRotation property is set, the API will set the DesiredAngularDeceleration property so that the object will stop after the desired number of radians. The unit of angular accelleration is radians.

If inertia processing has already started, setting InitialAngularVelocity will reset the inertia engine to the initial state with new velocity values 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
DesiredRotation
GetAngularVelocity
InitialExpansionVelocity
IInertiaProcessor
Properties

 

 

Community Additions

ADD
Show:
© 2016 Microsoft