Type Alias NavCubeParams

NavCubeParams: {
    cameraFitFOV?: number;
    cameraFlight?: CameraFlightAnimation;
    cameraFly?: boolean;
    cameraFlyDuration?: number;
    container?: HTMLElement;
    size?: number;
    view: View;
    visible?: boolean;
    zUp?: boolean;
}

Construction parameters for NavCube.

Type declaration

  • OptionalcameraFitFOV?: number

    How much of the field-of-view the scene fills after the camera arrives at the chosen view, in degrees. Default 45.

  • OptionalcameraFlight?: CameraFlightAnimation

    Camera-flight animator used when the user clicks a region of the cube. If omitted the NavCube hard-snaps the camera (no animation).

  • OptionalcameraFly?: boolean

    If true, fly the camera on click; if false, jump. Default true (when cameraFlight is supplied).

  • OptionalcameraFlyDuration?: number

    Flight duration in seconds when cameraFly is true. Default 0.5.

  • Optionalcontainer?: HTMLElement

    Element the floating NavCube panel + pill mount into. Defaults to document.body, matching the other floating demo panels. The panel's drag position is persisted to localStorage so the layout survives reloads.

  • Optionalsize?: number

    Edge length of the cube in CSS pixels. Default 100. The surrounding panel chrome (header + padding) adds a small margin around this on the screen.

  • view: View

    The View the NavCube reflects and drives. The cube tracks the View's camera orientation and, on click, flies the camera to the canonical axis / corner / edge view.

  • Optionalvisible?: boolean

    Initial visibility. Default true.

  • OptionalzUp?: boolean

    Selects whether the world's "up" axis is +Z (default — CAD / BIM convention) or +Y (graphics convention). Determines which face of the cube is labelled "TOP" and which world direction "FRONT" looks toward. If omitted, the NavCube reads the View's scene.coordinateSystem.worldUp.

Settings

Member Visibility