IDirectManipulationContentBehavior::SetSnapType method

  • Article

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps only

Sets the snap type for the manipulation value for inertia.

Syntax

HRESULT SetSnapType(
  [in]  DIRECTMANIPULATION_MOTION_TYPES motion,
  [in]  DIRECTMANIPULATION_SNAPPOINT_TYPE type
);

Parameters

  • motion [in]
    The motion type on which to set the interval.

  • type [in]
    The type of snap point behavior to observe for the motion.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Mandatory snap points indicate the final rest point must coincide with a specified snap point (if snap points exist). Optional snap points indicate the snap point behavior only if the position and velocity interaction ends close to a snap point.

Examples

The following example shows the syntax for this method.

HRESULT hr = pContent->SetSnapType(DIRECTMANIPULATION_MOTION_TRANSLATEX, 
    DIRECTMANIPULATION_SNAPPOINT_MANDATORY);

Requirements

Minimum supported client

 Windows Developer Preview

Minimum supported server

 Windows Server Developer Preview

IDL

 DirectManipulation.idl

See also

IDirectManipulationContentBehavior

 

 

Build date: 12/12/2011