aframeScene


Introduction

A scene is represented by the <a-scene> element. The scene is the global root object, and all entities are contained within the scene.

The scene inherits from the Entity class so it inherits all of its properties, its methods, the ability to attach components, and the behavior to wait for all of its child nodes (e.g., <a-assets> and <a-entity>) to load before kicking off the render loop.

Parameters

ParameterDetails
behaviorsArray of components with tick methods that will be run on every frame.
cameraActive three.js camera.
canvasReference to the canvas element.
isMobileWhether or not environment is detected to be mobile.
object3DTHREE.Scene object.
rendererActive THREE.WebGLRenderer.
renderStartedWhether scene is rendering.
effectRenderer for VR created by passing active renderer into THREE.VREffect.
systemsInstantiated systems.
timeGlobal uptime of scene in seconds.

Remarks

METHODS

NameDescription
enterVRSwitch to stereo render and push content to the headset. Needs to be called within a user-generated event handler like click. the first time a page enters VR.
exitVRSwitch to mono renderer and stops presenting content on the headset.
reloadRevert the scene to its original state.

EVENTS

NameDescription
enter-vrUser has entered VR and headset started presenting content.
exit-vrUser has exited VR and headset stopped presenting content.
loadedAll nodes have loaded.
renderstartRender loop has started.