Struct GestureState 

pub struct GestureState(/* private fields */);

Retain one handle per logical control. Clones share input/motion state. Mouse release outside the hitbox, lost button, Escape, blur and deactivation clear ownership. Pinch and supported native touch gestures are opt-in; raw multi-touch availability depends on the backend/platform.

Implementations

impl GestureState

pub fn with_drag(self, drag: Drag) -> Self

Adds bounded native pointer/arrow-key dragging. Configure once in the view.

pub fn touch_drag(self, enabled: bool) -> Self

Enables stock Kit touch-drag ownership. Claiming a touch prevents the containing scroll view from also handling that gesture. Platform delivery remains native; this does not synthesize touch input on desktop macOS.

pub fn constraints(self, container: MotionAnchor) -> Self

Measures drag bounds against a retained native container anchor. Resize changes retarget from the current presentation rather than resetting it.

pub fn on_drag( self, callback: impl Fn(DragEvent, &mut Window, &mut App) + 'static, ) -> Self

Reports structured pointer start/move/end/cancel events outside state borrows. Also enables a host-controlled pan surface without with_drag.

pub fn on_pinch( self, callback: impl Fn(PinchGesture, &mut Window, &mut App) + 'static, ) -> Self

Reports native pinch gestures without assuming ordinary elements can scale.

pub fn start_drag( &self, pointer: [f64; 2], window: &mut Window, cx: &mut App, ) -> bool

Starts from a separate handle or scrubber. Available after the target’s first layout; focus, cancellation and outside release remain target-owned.

pub fn view_root(self, root: MotionAnchor) -> Self

Uses another measured viewport for in-view checks, intersected with normal ancestor clipping. Missing measurements preserve the previous visibility.

pub fn view_margins(self, margins: [f64; 4]) -> Self

Insets top/right/bottom/left visibility edges; negative values expand them.

pub fn in_view(self, amount: f64, once: bool) -> Self

Enables automatically measured clipped viewport visibility. Configure once.

pub fn interaction(&self) -> Interaction

Current resolved interaction flags, supplied automatically by the element.

pub fn presented(&self) -> Target

Last presented target, including drag displacement.

pub fn focus_handle(&self) -> Option<FocusHandle>

The stable focus handle, available after the first layout.

pub fn cancel(&self, cx: &mut App)

Cancels pointer/key state and bounded dragging, notifying the owning view.

pub fn bind<E: IntoElement + StatefulInteractiveElement + Styled + 'static>( &self, id: impl Into<ElementId>, child: E, motion: Motion, targets: GestureTargets, ) -> GestureElement<E>

Wraps a styled native control and automatically binds hover/press/focus, viewport and optional drag. Supply role, label and click behavior on the child. The adapter supplies a stable tab-stop focus handle. Configure layout styles before binding; x/y are owned by this adapter, not a second LayoutGroup on the same control. Native activation remains Kit’s behavior.

use gpui_kit::{div, prelude::*, Role};
use gpui_motion_kit::{GestureState, core::{GestureTargets, Motion, Target}};
let state = GestureState::default(); // persistent view field
let control = state.bind("motion-button", div().id("button").role(Role::Button).child("Press"),
    Motion::new(Target::default()), GestureTargets::default().while_press(Target::default().opacity(0.5)));

Trait Implementations

impl Clone for GestureState

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for GestureState

fn default() -> Self

Returns the “default value” for a type.