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.

    Index

    Accessors

    camera

    Constructors

    constructor

    Methods

    addAnnotation calculateControlScale click copyView delete fullscreen getFacingDirection getFacingHeight loadAnglePreset loadBackground mousemove mouseup moveSelRect newAnglePreset occupyTransformer raycast raycastMouseCoords removeAnnotation render resize screenshot setDefaultAnglePreset setFOV setLockedAngle setNormalCamera setProjectionMode showContextMenu startSelRect stopSelRect toggleFullscreen updateAnnotations updateBackground updateToneMapping vectorToScreenPosition

    Properties

    angle annotations aspect_ratio? background camOrtho camPers canvas controls css_renderer? default_angle event_start? height id isOrtho label menu mouse node offscreen? orbit_gizmo? raycaster rclick_cooldown renderer selection side_view_target static_rclick width all selected split_screen

    Accessors

    • get camera(): PerspectiveCamera | OrthographicCamera

      Returns PerspectiveCamera | OrthographicCamera

    Constructors

    Methods

    • Parameters

      • position: any

      Returns number

    • Parameters

      • Optionalevent: PointerEvent

      Returns boolean

    • Parameters

      Returns void

    • Returns void

    • Returns this

    • Returns "east" | "west" | "south" | "north"

    • Returns "up" | "down" | "middle"

    • Parameters

      Returns this

    • Returns void

    • Parameters

      • event: MouseEvent

      Returns void

    • Parameters

      • event: MouseEvent

      Returns this

    • Parameters

      • event: MouseEvent

      Returns void

    • Opens a dialog to create and save a new angle preset

      Returns this

    • Parameters

      • Optionalevent: MouseEvent | TouchEvent

      Returns this

    • Parameters

      • event: MouseEvent
      • Optionaloptions: { edges?: boolean; vertices?: boolean }

      Returns false | RaycastResult

    • Parameters

      • x: number
      • y: number

      Returns Vector3

    • Parameters

      • key: any

      Returns void

    • Returns void

    • Set a size of the preview in pixels. With no arguments, and if the preview node is connected to the DOM, it will adjust to the size of the parent element

      Parameters

      • Optionalwidth: number
      • Optionalheight: number

      Returns this

    • Parameters

      Returns this

    • Parameters

      • fov: number

      Returns void

    • Parameters

      • Optionalangle: number

      Returns this

    • Returns this

    • Parameters

      • orthographic: boolean
      • Optionaltoggle: boolean

      Returns this

    • Parameters

      • event: MouseEvent

      Returns this

    • Parameters

      • event: PointerEvent

      Returns void

    • Parameters

      • event: any

      Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      • vector: any

      Returns { x: any; y: any }

    Properties

    angle: string

    Angle, when in a specific side view

    annotations: Record<string, PreviewAnnotation>
    aspect_ratio?: number
    background: {
        image: any;
        lock: boolean;
        name: string;
        size: number;
        x: number;
        y: number;
    }
    camOrtho: OrthographicCamera & { axis: string; backgroundHandle: any }
    camPers: PerspectiveCamera
    canvas: HTMLCanvasElement
    controls: any
    css_renderer?: CSS3DRenderer
    default_angle: AnglePreset
    event_start?: ArrayVector2
    height: number
    id: string
    isOrtho: boolean

    True if the preview is in orthographic camera mode

    label: HTMLLabelElement
    menu: Menu
    mouse: Vector2
    node: HTMLElement
    offscreen?: boolean
    orbit_gizmo?: OrbitGizmo
    raycaster: Raycaster
    rclick_cooldown: any
    renderer: WebGLRenderer
    selection: {
        activated: boolean;
        box: HTMLElement;
        click_target?: RaycastResult;
        client_x: number;
        client_y: number;
        frustum: Frustum;
        old_mesh_selection?: any;
        old_selected?: OutlinerElement[];
        old_spline_selection?: any;
        sr_move_f?: any;
        sr_stop_f?: any;
        start_x: number;
        start_y: number;
    }
    side_view_target: Vector3
    static_rclick: boolean
    width: number
    all: Preview[]

    List of all previews

    selected: Preview

    The last used preview

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

    Utility regarding split screen preview mode

    Type Declaration

    • before: any
    • enabled: boolean

      Whether the split screen is enabled

    • mode: string

      The current split screen mode

    • previews: Preview[]
    • lazyLoadPreview: function
      • lazyLoadPreview(index: number, camera_preset?: AnglePreset): Preview

        Parameters

        Returns Preview

    • setMode: function
      • setMode(mode?: SplitScreenMode): void

        Set a split screen mode

        Parameters

        Returns void

    • updateSize: function
      • updateSize(): void

        Update the size of the split screens

        Returns void

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructors
    Methods
    Properties