Raanan Weber 94d1635459 Merge pull request #4265 from RaananW/viewer-documentation před 7 roky
..
assets 9276449e47 edge compatibility (and a small IE fix) před 7 roky
dist 9f99083f66 removing unneeded před 7 roky
src 94d1635459 Merge pull request #4265 from RaananW/viewer-documentation před 7 roky
tests 2a35aea04f tests runtime před 7 roky
README.md bb272a3545 Viewer configuration - initial před 8 roky
package.json d9dcee2c4b stability changes and bug fixes před 7 roky
tsconfig-gulp.json d1b2d1e35a referencing the right module před 7 roky
tsconfig.json 7cb6a2d4d5 tests now run on the source (!) and not on compiled js před 7 roky
webpack.config.js 0af2d45602 Added Logo & Font před 7 roky
webpack.gulp.config.js d9dcee2c4b stability changes and bug fixes před 7 roky

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.