Raanan Weber 324cbabbbe scene flags and model enabling 7 years ago
..
assets 5ab531bb9a hide animatiosn container if told to 7 years ago
dist 04770282fa demos 7 years ago
src 324cbabbbe scene flags and model enabling 7 years ago
tests 1de295ee56 fixing unit tests 7 years ago
README.md bb272a3545 Viewer configuration - initial 7 years ago
package.json b16beaced1 updating dependencies and removing unneeded code 7 years ago
tsconfig-gulp.json d1b2d1e35a referencing the right module 7 years ago
tsconfig.json 7cb6a2d4d5 tests now run on the source (!) and not on compiled js 7 years ago
webpack.config.js bf1fab8f2c allowing to debug the viewer straight from vscode 7 years ago
webpack.gulp.config.js 2456c7a62e no file references in import 7 years ago

README.md

BabylonJS Viewer

This project is a 3d model viewer using babylonjs.

Please note that this is an initial release. The API and project structure could (and probably SHOULD) be changed, so please don't rely on this yet in a productive environment.

The viewer is using the latest Babylon from npm (3.1 alpha).

This documentation is also not full. I will slowly add more and more exmplanations.

Basic usage

See basicExample.html in /dist.

Basically, all that is needed is an html tag, and the viewer.js, which includes everything needed to render a Scene:

<babylon model="https://raw.githubusercontent.com/KhronosGroup/glTF-Sample-Models/master/2.0/BoomBox/glTF/BoomBox.gltf" default-viewer="true"></babylon>
<script src="viewer.js"></script>

This will create a (default) viewer and will load the model in this URL using the gltf loader.

The babylon tag will be automatically initialized.

Configuration

Configuration can be provided using html attributes or a JSON (at the moment). A configuration Mapper can be registered to create new configuration readers.

Before I finish a full documentation, take a look at configuration.ts

Templating

The default templates are integrated in the viewer.js file. The current templates are located in /assets/templates/default/ . Those templates can be extended and registered using the configuration file.