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
Parameter | Details |
---|
behaviors | Array of components with tick methods that will be run on every frame. |
camera | Active three.js camera. |
canvas | Reference to the canvas element. |
isMobile | Whether or not environment is detected to be mobile. |
object3D | THREE.Scene object. |
renderer | Active THREE.WebGLRenderer. |
renderStarted | Whether scene is rendering. |
effect | Renderer for VR created by passing active renderer into THREE.VREffect. |
systems | Instantiated systems. |
time | Global uptime of scene in seconds. |
METHODS
Name | Description |
---|
enterVR | Switch 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. |
exitVR | Switch to mono renderer and stops presenting content on the headset. |
reload | Revert the scene to its original state. |
EVENTS
Name | Description |
---|
enter-vr | User has entered VR and headset started presenting content. |
exit-vr | User has exited VR and headset stopped presenting content. |
loaded | All nodes have loaded. |
renderstart | Render loop has started. |