xml3d / xml3d.js

The WebGL/JS implementation of XML3D
Other
75 stars 25 forks source link

xml3d.js

Build Status License badge Specification Documentation badge Support badge

XML3D

xml3d.js is a XML3D implementation based on WebGL and JavaScript. The aim of XML3D is to make the development of 3D-Web applications as easy as developing web pages. Every web developer who knows how to use the DOM (or jQuery) should also be able to use XML3D.

XML3D is also an evaluation platform of the W3C Community Group Declarative 3D for the Web and a FIWARE Generic Enabler.

Examples

Our small examples repository holds simple examples of individual features. Below are some more complete demos:

Usage

Download the library and include it in your html page.

<script src="http://www.xml3d.org/xml3d/script/xml3d.js"></script>

If a standard navigation mode is sufficient for your web application, you can include the camera controller that comes with xml3d.js:

<script src="http://www.xml3d.org/xml3d/script/xml3d.js"></script>
<script src="http://www.xml3d.org/xml3d/script/tools/camera.js"></script>

Testing

We have an extensive test suite and some known issues.

How to build

Dependencies

You will need node.js. Then install the grunt cli:

npm install -g grunt-cli
Clone

Clone a copy of the main xml3d.js git repo by running:

git clone git://github.com/xml3d/xml3d.git
Build

Enter the xml3d.js directory and run the build script:

cd xml3d.js && npm run build

The built version of xml3d.js will be put in the build/output/ subdirectory. Alternatively you have several grunt tasks that you can run directly (e.g. grunt min). Run grunt --help to get a list of available grunt tasks.

Documentation

We have an overview documentation in each subfolder of the project:

In addition a full specification and API description is provided, which also includes many examples and code snippets. This repository's Wiki also contains some tutorials and additional help.

Change log

5.2 - 10.05.2016

5.1 - 07.01.2016

5.0 - 16.10.2015 (Not backwards compatible!)


4.9 - 31.03.2015

4.8 - 18.12.2014

4.7 - 17.10.2014

4.6 - 15.04.2014

4.5 - 14.11.2013

4.4 - 23.04.2013

4.3 - 18.12.2012

4.2 - 14.09.2012

4.1 - 19.07.2012