weasel API - v0.8.0
    Preparing search index...

    Interface UseLassoToolOptions

    interface UseLassoToolOptions {
        behaviors?: LassoSelectBehavior[];
        debug?: DebugSink;
        keybinding?: ToolKeybinding | null;
        label?: string;
        minVertexSpacing?: number;
        mode?: LassoHitMode;
        onGestureEnd?: (committed: boolean) => void;
        onGestureStart?: () => void;
        transient?: boolean;
    }

    Hierarchy

    • Pick<
          UseLassoSelectOptions,
          | "behaviors"
          | "transient"
          | "label"
          | "onGestureStart"
          | "onGestureEnd"
          | "minVertexSpacing"
          | "debug",
      >
      • UseLassoToolOptions
    Index

    Properties

    behaviors? debug? keybinding? label? minVertexSpacing? mode? onGestureEnd? onGestureStart? transient?

    Properties

    behaviors?: LassoSelectBehavior[]
    debug?: DebugSink

    Optional debug sink; receives the live polygon AABB on every move.

    keybinding?: ToolKeybinding | null

    Override the default keybinding ({ key: 'L' }). Pass null to omit.

    label?: string

    Label used when transient is false and the hook falls back to applyOps. Default 'Lasso select'.

    minVertexSpacing?: number

    Skip vertices closer than this many world-px to the previous one. Default 2. Set 0 to record every move sample.

    mode?: LassoHitMode

    Hit mode forwarded to the default selectFromLasso behavior when no explicit behaviors array is passed. Default 'intersect'.

    onGestureEnd?: (committed: boolean) => void
    onGestureStart?: () => void
    transient?: boolean

    When set, overrides any behavior's defaultTransient.

    Settings

    Member Visibility

    On This Page

    Properties