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

    Interface AnimateOnSetPoseOptions<TPose>

    interface AnimateOnSetPoseOptions<TPose> {
        easing?: EasingFn;
        geometry?: PoseProjection<TPose>;
        gestureScope?: ReadonlySet<string>;
        ms?: number;
        opLabel?: string;
        shouldAnimate?: (id: string, from: TPose, to: TPose) => boolean;
        skipDuringGesture?: boolean;
        spring?: {
            damping?: number;
            mass?: number;
            preset?: SpringPresetName;
            stiffness?: number;
        };
    }

    Type Parameters

    • TPose
    Index

    Properties

    easing? geometry? gestureScope? ms? opLabel? shouldAnimate? skipDuringGesture? spring?

    Properties

    easing?: EasingFn
    geometry?: PoseProjection<TPose>
    gestureScope?: ReadonlySet<string>

    Optional: a Set the kit (or app) populates with ids currently being manipulated by a gesture. When skipDuringGesture is true and the id is in this Set, the wrapper writes through immediately.

    ms?: number

    Default: 200ms tween with easeOut.

    opLabel?: string

    Op label for the recorded transform op. Default: 'animate'.

    shouldAnimate?: (id: string, from: TPose, to: TPose) => boolean

    Predicate: return false to skip animation and write through immediately.

    skipDuringGesture?: boolean

    Convenience: when true, auto-skip animation if the id is currently being manipulated by an active gesture. Implementation: see gestureScope — the wrapper consults a shared "in-flight ids" Set if one is provided, otherwise this option is a no-op (treat as shouldAnimate returning true). Mutually exclusive with shouldAnimate.

    spring?: {
        damping?: number;
        mass?: number;
        preset?: SpringPresetName;
        stiffness?: number;
    }

    Use a spring instead of a duration tween. Mutually exclusive with ms/easing.

    Settings

    Member Visibility

    On This Page

    Properties