Class SceneRegistry

Create a new SceneRegistry instance.

Add a new item to the scene registry.

Change to a new scene. Calling this function will load the scene data, delete all entities and graph nodes under app.root and load the scene settings and hierarchy.

Example

app.scenes.changeScene("Scene Name", function (err, entity) {
    if (!err) {
        // success
    } else {
        // error
    }
});
Copy

Find a Scene by name and return the SceneRegistryItem.

Find a scene by the URL and return the SceneRegistryItem.

Return the list of scene.

Load the scene hierarchy and scene settings. This is an internal method used by the AppBase.

Loads and stores the scene data to reduce the number of the network requests when the same scenes are loaded multiple times. Can also be used to load data before calling SceneRegistry#loadSceneHierarchy and SceneRegistry#loadSceneSettings to make scene loading quicker for the user.

Example

const sceneItem = app.scenes.find("Scene Name");
app.scenes.loadSceneData(sceneItem, function (err, sceneItem) {
    if (err) {
        // error
    }
});
Copy

Load a scene file, create and initialize the Entity hierarchy and add the hierarchy to the application root Entity.

Example

const sceneItem = app.scenes.find("Scene Name");
app.scenes.loadSceneHierarchy(sceneItem, function (err, entity) {
    if (!err) {
        const e = app.root.find("My New Entity");
    } else {
        // error
    }
});
Copy

Load a scene file and apply the scene settings to the current scene.

Example

const sceneItem = app.scenes.find("Scene Name");
app.scenes.loadSceneSettings(sceneItem, function (err) {
    if (!err) {
        // success
    } else {
        // error
    }
});
Copy

Remove an item from the scene registry.

Unloads scene data that has been loaded previously using SceneRegistry#loadSceneData.

Example

const sceneItem = app.scenes.find("Scene Name");
app.scenes.unloadSceneData(sceneItem);
Copy