@drecom/scene-graph-mediator-rt

This module converts both scene graph schema and runtime object each other. Each of converters should know runtime object schema, this module provides [pixi.js](https://github.com/pixijs/pixi.js) importer/exporter by default.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@drecom/scene-graph-mediator-rt
Minified + gzip package size for @drecom/scene-graph-mediator-rt in KB

Readme

scene-graph-mediator-rt

This module converts both scene graph schema and runtime object each other. Each of converters should know runtime object schema, this module provides pixi.js importer/exporter by default.

The schema definition of scene graph is based on @drecom/scene-graph-schema .

Usage

For most simple example;

const importer = new SceneGraph.Importers.Pixi();
importer.import(scenegraphJson, (root) => stage.addChild(root));

Building custom import pipeline;

const importer = new SceneGraph.Importers.Pixi();

// create asset list to download
const assets = importer.createAssetMap(scenegraphJson);

// load if any asset is required
if (assets.size > 0) {
  assets.forEach((asset) => PIXI.loader.add(asset));
  PIXI.loader.load(() => importer.restoreScene(app.stage, schema));
} else {
  importer.restoreScene(app.stage, schema);
}

See example directory for working example.

Remarks

To shrink runtime code volume, importer/exporter for each runtime may separated from this repository in the future.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.