Skip to main content

Module interactions

Module interactions 

Source
Expand description

Microsoft.UI.Composition.Interactions: interaction trackers and the visual interaction sources that drive them with input.

An InteractionTracker holds a position and a scale. Input redirected by a VisualInteractionSource moves them while interacting, inertia (with its decay rates and inertia modifiers) carries them to rest after a release, and requests (try_update_*) move them from code. Expression animations reference the tracker to move visuals with it.

The tracker runs on the UI thread and ticks with the animation frames of the media context; see the deviations of docs/porting/winui-composition.md.

Structs§

CompositionInteractionSourceCollection
The sources of a tracker (CompositionInteractionSourceCollection).
InteractionSourceConfiguration
Which axes the redirected mouse wheel drives (InteractionSourceConfiguration, the PointerWheelConfig of a source).
InteractionTracker
A position and a scale driven by input, inertia and requests (Microsoft.UI.Composition.Interactions.InteractionTracker).
InteractionTrackerCustomAnimationStateEnteredArgs
The arguments of IInteractionTrackerOwner::custom_animation_state_entered.
InteractionTrackerIdleStateEnteredArgs
The arguments of IInteractionTrackerOwner::idle_state_entered.
InteractionTrackerInertiaMotion
An inertia modifier that replaces the motion of the inertia (InteractionTrackerInertiaMotion): when Condition is true, the value of the axis is the value of Motion, evaluated every frame of the inertia, until it stops changing.
InteractionTrackerInertiaRestingValue
An inertia modifier that changes where the inertia comes to rest (InteractionTrackerInertiaRestingValue): when Condition is true, the axis comes to rest at the value of RestingValue, evaluated once when the inertia starts.
InteractionTrackerInertiaStateEnteredArgs
The arguments of IInteractionTrackerOwner::inertia_state_entered.
InteractionTrackerInteractingStateEnteredArgs
The arguments of IInteractionTrackerOwner::interacting_state_entered.
InteractionTrackerRequestIgnoredArgs
The arguments of IInteractionTrackerOwner::request_ignored.
InteractionTrackerValuesChangedArgs
The arguments of IInteractionTrackerOwner::values_changed.
VisualInteractionSource
The input of the element of a visual, redirected to the interaction trackers the source is added to (Microsoft.UI.Composition.Interactions.VisualInteractionSource).

Enums§

InteractionChainingMode
How the manipulations of nested sources chain (InteractionChainingMode).
InteractionSourceMode
How the input of a source drives an axis (InteractionSourceMode).
InteractionSourceRedirectionMode
Whether a kind of redirected input drives an axis (InteractionSourceRedirectionMode).
InteractionTrackerAnimation
A custom animation of the position or of the scale of a tracker: the CompositionAnimation that TryUpdatePositionWithAnimation and TryUpdateScaleWithAnimation take.
InteractionTrackerClampingOption
Whether a position request is clamped to the boundaries (InteractionTrackerClampingOption).
InteractionTrackerInertiaModifier
A modifier of the inertia of one axis of an interaction tracker (InteractionTrackerInertiaModifier): what configure_position_x_inertia_modifiers and its siblings take.
InteractionTrackerState
The states of an InteractionTracker.
VisualInteractionSourceRedirectionMode
Which input other than touch is redirected to a source without TryRedirectForManipulation (VisualInteractionSourceRedirectionMode).

Constants§

DEFAULT_INERTIA_DECAY_RATE
The decay rate of the position and of the scale while PositionInertiaDecayRate and ScaleInertiaDecayRate are not set.

Traits§

IInteractionTrackerOwner
The callbacks of an InteractionTracker (IInteractionTrackerOwner).