BIM.works SDKs - v3.0.0-beta.168
    Preparing search index...

    Interface PlacementTool

    The move/rotate tool while it runs (Viewer3d.startObjectTransform; ActiveTool.measurement for "move" and "rotate"): what the mode bar shows and switches. The members marked Viewer3D-Next are absent in Viewer3D

    interface PlacementTool {
        canEach?: boolean;
        canRedo?: boolean;
        canUndo?: boolean;
        canUseObjectFrame?: boolean;
        change: {
            moveMm: number[];
            rotate: { angleDeg: number; axis: number[] } | null;
        };
        each?: boolean;
        fillings?: boolean;
        frameKind?: "object"
        | "world";
        hint?: string;
        mode: "rotate" | "move";
        openingsAlong?: boolean;
        readout?: { meta: string; value: string };
        snapStep: number;
        stepLabel?: string;
        stepSnapping: boolean;
        surfaces?: boolean;
        title?: string;
        redo?(): boolean;
        setEach?(on: boolean): boolean;
        setFrame?(kind: "object" | "world"): void;
        setOpeningsAlong?(on: boolean): void;
        setStepSnapping?(on: boolean): void;
        setSurfaces?(on: boolean): void;
        undo?(): boolean;
    }
    Index

    Properties

    canEach?: boolean

    Whether the objects can turn each in place: 2 to 48 objects of the models (Viewer3D-Next)

    canRedo?: boolean
    canUndo?: boolean

    Steps back and forward, as Ctrl+Z and Ctrl+Y (Viewer3D-Next)

    canUseObjectFrame?: boolean

    Whether the objects have axes of their own: they stand upright (their heading), or are tilted, such as a roof pitch (their box's three axes, Z the normal of a plate) (Viewer3D-Next)

    change: {
        moveMm: number[];
        rotate: { angleDeg: number; axis: number[] } | null;
    }

    The accumulated change so far, render frame

    each?: boolean

    Whether every turn turns each object about its own pivot instead of all about one (Viewer3D-Next)

    fillings?: boolean

    Doors or windows are among the objects (Viewer3D-Next)

    frameKind?: "object" | "world"

    The axes of the arrows, the locks and typed x/y: the objects' own or the world's (Viewer3D-Next)

    hint?: string

    What to do now, for the mode bar (Viewer3D-Next)

    mode: "rotate" | "move"
    openingsAlong?: boolean

    Whether their openings go along; off, they move in them (Viewer3D-Next)

    readout?: { meta: string; value: string }

    The change as text: "Δ 600 mm · ↻ 90°", and what snaps (Viewer3D-Next)

    snapStep: number

    The step snapping moves in: mm for a move, degrees for a turn

    stepLabel?: string

    "100 mm" or "15°" (Viewer3D-Next)

    stepSnapping: boolean

    Whether lengths go in zoom-aware steps and turns in 15° (Viewer3D: the Shift steps)

    surfaces?: boolean

    On surfaces: a floor drag puts the objects on the face under the cursor (Viewer3D-Next)

    title?: string

    "Move · 3 objects" (Viewer3D-Next)

    Methods

    • Returns boolean

    • Each in place on or off; false when it cannot (not enough room to draw each object on its own) (Viewer3D-Next)

      Parameters

      • on: boolean

      Returns boolean

    • Parameters

      • kind: "object" | "world"

      Returns void

    • Parameters

      • on: boolean

      Returns void

    • Switch the steps (Viewer3D-Next)

      Parameters

      • on: boolean

      Returns void

    • Parameters

      • on: boolean

      Returns void

    • Returns boolean