Class Viewer

This is the entry point into the application.
Create an instance to set up the viewer on your canvas.

const canvas = document.getElementById('babylon-canvas');
const viewer = Viewer(canvas, viewerSettings, defaultSceneSettings);

Use "manager" sub classes for interacting with the Babylon.js engine. (e.g. modelManager for loading models into the scene)

Hierarchy

  • Viewer

Constructors

constructor

Properties

canvas version

Accessors

cameraManager debugManager engine eventManager gltfExportManager materialManager modelManager parameterManager scene viewerSettings

Methods

calculateBoundingInfo destroy pauseRendering resumeRendering getAllViewerModules

Constructors

constructor

Properties

Readonly canvas

canvas: HTMLCanvasElement

Static Readonly version

version: string = buildInfo.version

Accessors

cameraManager

debugManager

engine

eventManager

gltfExportManager

materialManager

modelManager

parameterManager

scene

viewerSettings

Methods

calculateBoundingInfo

  • Calculates size of the current scene.
    Only takes meshes into considerations that:

    • are visible
    • are not excluded by "excludeGeometry" parameter
    • do not have a material of type "BackgroundMaterial"
    • do not have an infinite distance (like sky boxes)

    Parameters

    Returns BoundingInfo

destroy

  • Destroys this viewer instance and disposes Babylon.js engine and all scene content

    Returns void

pauseRendering

  • Pause rendering can be usefull when doing internal scene processings that should not be visible to the user, e.g. cloning meshes for gltf export

    Returns void

resumeRendering

Static getAllViewerModules

Settings

Member Visibility

Theme

Generated using TypeDoc