API

Interface PointerDrag

Pointer-drag behavior shared by gizmos and driven by the per-canvas dispatcher.

interface PointerDrag {
    dragging: boolean;
    enabled: boolean;
    hovering: boolean;
    onDrag: GizmoObservable<PointerDragMoveEvent>;
    onDragEnd: GizmoObservable<PointerDragEndEvent>;
    onDragStart: GizmoObservable<PointerDragStartEvent>;
    onHoverEnd: GizmoObservable<void>;
    onHoverStart: GizmoObservable<void>;
    options: Readonly<PointerDragOptions>;
}
Index
dragging: boolean

True while a drag is in progress.

enabled: boolean
hovering: boolean

True while the pointer is hovering one of _colliders (no drag).

onDrag: GizmoObservable<PointerDragMoveEvent>

Fired on every pointer-move while a drag is active.

onDragEnd: GizmoObservable<PointerDragEndEvent>

Fired once when the pointer is released.

onDragStart: GizmoObservable<PointerDragStartEvent>

Fired once when a pointer-down lands on one of _colliders.

onHoverEnd: GizmoObservable<void>

Fired when the pointer leaves a previously-hovered collider.

onHoverStart: GizmoObservable<void>

Fired when the pointer hovers over one of _colliders (no button pressed). Used by gizmos to swap to a hover-coloured material before any drag. Always fires AFTER a previous onHoverEnd for a different drag, so the receiver doesn't need to track which collider is currently hovered.

options: Readonly<PointerDragOptions>