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

    Interface UseRotateToolOptions<TNode, _TPose>

    interface UseRotateToolOptions<TNode extends { id: string }, _TPose> {
        boundsOf?: (id: string) => Bounds | null;
        getNode?: (id: string) => TNode | null;
        getSelection?: () => string[];
        handleHitRadius?: number;
        rotate?: unknown;
        rotationHandleDistance?: number;
    }

    Type Parameters

    • TNode extends { id: string }
    • _TPose
    Index

    Properties

    boundsOf? getNode? getSelection? handleHitRadius? rotate? rotationHandleDistance?

    Properties

    boundsOf?: (id: string) => Bounds | null

    World-space bounds lookup. Required for the rotation affordance hit-test in consumers that wire a boundsOf source separately from the ChromeState-driven affordance pipeline. Retained for parity with useResizeTool; the rotation affordance itself reads bounds via the dispatcher-supplied ChromeState.

    getNode?: (id: string) => TNode | null

    Node lookup — retained for parity with useSelectTool and for future ghost-render wiring. The rotation affordance does not need it directly.

    getSelection?: () => string[]

    Live selection ids — retained for parity with useResizeTool / useSelectTool option surfaces. The dispatcher-path rotateAction reads selection from its own InvocationCtx, so this tool no longer forwards selection into the rotation gesture itself.

    handleHitRadius?: number

    Square hit-radius for the rotation handle. Default: 8.

    rotate?: unknown

    Legacy useRotate options surface. Ignored now — rotation flows through rotateAction, whose option surface is configured at the action-registration level. Kept on the type for backwards-compat with consumers (notably SceneCanvas's rotateOptions) that still pass a value.

    rotationHandleDistance?: number

    Distance from top edge of bounds to rotation handle center. Default: 24.

    Settings

    Member Visibility

    On This Page

    Properties