Blockbench Reference Docs
    Preparing search index...

    Class Preview

    Previews are 3D viewports, that can either be used as a viewport for the user, or as an offscreen view to record media.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    angle annotations background camera camOrtho camPers canvas controls height id isOrtho mouse node plugin? raycaster renderer split_screen width all selected split_screen

    Methods

    delete getFacingDirection getFacingHeight loadAnglePreset loadBackground newAnglePreset occupyTransformer raycast render setFOV setLockedAngle setProjectionMode showContextMenu

    Constructors

    Properties

    angle: number

    Angle, when in a specific side view

    annotations: any
    background: {
        image: any;
        lock: boolean;
        name: string;
        size: number;
        x: number;
        y: number;
    }
    camera: PerspectiveCamera | OrthographicCamera
    camOrtho: OrthographicCamera
    camPers: PerspectiveCamera
    canvas: HTMLCanvasElement
    controls: any
    height: number
    id: string
    isOrtho: boolean

    True if the preview is in orthographic camera mode

    mouse: Vector2
    node: HTMLElement
    plugin?: string

    The ID of the plugin that created the object

    raycaster: Raycaster
    renderer: WebGLRenderer
    split_screen: {
        before: null;
        enabled: boolean;
        lazyLoadPreview: () => void;
        mode: string;
        previews: Preview[];
        setMode(mode: string): void;
        updateSize(): void;
    }
    width: number
    all: Preview[]

    List of all previews

    selected: Preview

    The last used preview

    split_screen: {
        enabled: boolean;
        mode: SplitScreenMode;
        previews: Preview[];
        lazyLoadPreview(index: number, camera_preset: any): Preview;
        setMode(mode?: SplitScreenMode): any;
        updateSize(): any;
    }

    Utility regarding split screen preview mode

    Type Declaration

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods