Scene

Scene 

Provides global scene functionality like raycasting.

Kind: global class

• Scene
  • .activeViews ⇒ Array.<ViewComponent>
  • .clearColor
  • .colorClearEnabled
  • .rayCast(o, d, group)
  • .addObject(parent) ⇒ Object
  • .addObjects(count, parent, componentCountHint) ⇒ Array.<Object>
  • .reserveObjects(objectCount, componentCountPerType)
  • .load(filename)
  • .append(filename, options) ⇒ Promise.<Object> | Promise.<Object>
  • ._unmarshallGltfExtensions(data) ⇒ Object
  • .reset()

.activeViews ⇒ Array.<ViewComponent> 

Kind: instance property of Scene
Returns: Array.<ViewComponent> - currently active view components

.clearColor 

Set the background clear color

Kind: instance property of Scene
0.8.5+

.colorClearEnabled 

Set whether to clear the color framebuffer before drawing.

This function is useful if an external framework (e.g. an AR tracking framework) is responsible for drawing a camera frame before Wonderland Engine draws the scene on top of it.

Kind: instance property of Scene
0.9.4+

.rayCast (o, d, group) 

Cast a ray through the scene and find intersecting objects.

The resulting ray hit will contain up to 4 closest ray hits, sorted by increasing distance.

Kind: instance method of Scene
Note: The returned RayHit object is owned by the Scene instance and will be reused with the next rayCast call.

.addObject (parent) ⇒ Object 

Add object to the scene

Kind: instance method of Scene
Returns: Object - newly created object

.addObjects (count, parent, componentCountHint) ⇒ Array.<Object> 

Batch-add objects to the scene

Will provide better performance for adding multiple objects (e.g. > 16) than calling addObject repeatedly in a loop.

By providing upfront information of how many objects will be required, the engine is able to batch-allocate the required memory rather than convervatively grow the memory in small steps.

Experimental: This API might change in upcoming versions.

Kind: instance method of Scene
Returns: Array.<Object> - newly created objects

.reserveObjects (objectCount, componentCountPerType) 

Pre-allocate memory for a given amount of objects and components

Will provide better performance for adding objects later with addObject and addObjects

By providing upfront information of how many objects will be required, the engine is able to batch-allocate the required memory rather than convervatively grow the memory in small steps.

Experimental: This API might change in upcoming versions.

Kind: instance method of Scene
0.8.10+

.load (filename) 

Load a scene file (.bin)

Will replace the currently active scene with the one loaded from given file. It is assumed that JavaScript components required by the new scene were registered in advance.

Kind: instance method of Scene

.append (filename, options) ⇒ Promise.<Object> | Promise.<Object> 

Load an external 3D file (.gltf, .glb)

Loads and parses the gltf file and its images and appends the result to scene.

Kind: instance method of Scene
Returns: Promise.<Object> | Promise.<Object> - Root of the loaded scene

Example

1
2
3
4
5
6
7

WL.scene.append(filename).then(root => {
       // root contains the loaded scene
   });

In case the `loadGltfExtensions` option is set to true, the response
will be an object containing both the root of the loaded scene and
any glTF extensions found on nodes, meshes and the root of the file.

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

WL.scene.append(filename, { loadGltfExtensions: true }).then(({root, extensions}) => {
       // root contains the loaded scene

       // extensions.root contains any extensions at the root of glTF document
       const rootExtensions = extensions.root;

       // extensions.mesh and extensions.node contain extensions indexed by Object id
       const childObject = root.children[0];
       const meshExtensions = root.meshExtensions[childObject.objectId];
       const nodeExtensions = root.nodeExtensions[childObject.objectId];

       // extensions.idMapping contains a mapping from glTF node index to Object id
   });

._unmarshallGltfExtensions (data) ⇒ Object 

Unmarshalls the GltfExtensions from an Uint32Array

Kind: instance method of Scene

.reset () 

Reset the scene

This method deletes all used and allocated objects, and components.

Kind: instance method of Scene