Verge3D Manual

App

App class allows you to set up your 3D application more easily. It includes code to init WebGL renderer, load glTF scenes, auto-start animations as well as logic for basic camera controls.

Constructor

App(container, ctxSettings, preloader)

container - the id of an HTML-element or the HTML-element itself to contain the canvas.
ctxSettings - the WebGL context attributes to be passed in the 'canvas.getContext()' method.
preloader - the application's Preloader.

Properties

# .clearBkgOnLoad : Boolean

# .container : HTMLElement

# .scene : Scene

# .camera : Camera

# .clock : Clock

# .controls : null

# .mixer : AnimationMixer

# .preloader : HTMLElement

# .renderer : WebGLRenderer

# .loader : GLTFLoader

# .worldCubemapRes : Number

Methods

# .animate () : null

# .appendScene (url, loadCb, progressCb, errorCb) : null

Append the scene from the specified glTF file to the current scene. The loadCb callback will receive the loaded scene as a parameter after the loading is finished.

If there is no active scene in the application, then nothing will be appended.

# .cleanup () : null

# .disableRendering () : null

Disable graphics updates in the animation loop. The controls and the animation mixer will keep being updated and the render callbacks will keep being called.

# .dispose () : null

# .enableControls () : null

Enable controls for the main app camera. Depending on the control type specified for the camera this method will give you 'ORBIT', 'FLYING' or static camera.

# .enableRendering () : null

# .getCamera () : Camera

# .getHeight () : number

# .getWidth () : number

# .initPostprocessing () : null

# .load (url, loadOkCb, loadErrorCb, autoStart) : null

Deprecated. Use loadScene instead.

Load the glTF scene. The loadOkCb callback will receive the loaded scene as a parameter after the loading is finished.

If there already is an active scene (e.g. loaded before via the load method), then use unload first to avoid conflicts between the existed scene and the loaded one.

# .loadScene (url, loadCb, progressCb, errorCb) : null

Load the glTF scene. The loadCb callback will receive the loaded scene as a parameter after the loading is finished.

If there already is an active scene (e.g. loaded before via the loadScene method), then use unload first to avoid conflicts between the existed scene and the loaded one.

# .onResize () : null

# .render () : null

# .run () : null

# .setFrameRateDivider (divider : Integer) : null

Lowers the maximum frame by dividing it by a specified integer number. By default the engine tries to render scenes at 60 frames per second. If the divider is set to 2, for example, the FPS will be topped out to 30.

# .unload (rootObj) : null

rootObj -- (optional) an object to unload along with its children; if no object is given or the given object is the main application scene then the method performs full scene cleanup.

Unloads either a part or the whole scene depending on the parameters.