85 lines
2.6 KiB
Markdown
85 lines
2.6 KiB
Markdown
|
three.js
|
||
|
|
========
|
||
|
|
|
||
|
|
[![Latest NPM release][npm-badge]][npm-badge-url]
|
||
|
|
[![License][license-badge]][license-badge-url]
|
||
|
|
[![Dependencies][dependencies-badge]][dependencies-badge-url]
|
||
|
|
[![Dev Dependencies][devDependencies-badge]][devDependencies-badge-url]
|
||
|
|
|
||
|
|
#### JavaScript 3D library ####
|
||
|
|
|
||
|
|
The aim of the project is to create an easy to use, lightweight, 3D library. The library provides <canvas>, <svg>, CSS3D and WebGL renderers.
|
||
|
|
|
||
|
|
[Examples](http://threejs.org/examples/) —
|
||
|
|
[Documentation](http://threejs.org/docs/) —
|
||
|
|
[Wiki](https://github.com/mrdoob/three.js/wiki) —
|
||
|
|
[Migrating](https://github.com/mrdoob/three.js/wiki/Migration-Guide) —
|
||
|
|
[Help](http://stackoverflow.com/questions/tagged/three.js)
|
||
|
|
|
||
|
|
### Usage ###
|
||
|
|
|
||
|
|
Download the [minified library](http://threejs.org/build/three.min.js) and include it in your html.
|
||
|
|
Alternatively see [how to build the library yourself](https://github.com/mrdoob/three.js/wiki/Build-instructions).
|
||
|
|
|
||
|
|
```html
|
||
|
|
<script src="js/three.min.js"></script>
|
||
|
|
```
|
||
|
|
|
||
|
|
This code creates a scene, a camera, and a geometric cube, and it adds the cube to the scene. It then creates a `WebGL` renderer for the scene and camera, and it adds that viewport to the document.body element. Finally it animates the cube within the scene for the camera.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var scene, camera, renderer;
|
||
|
|
var geometry, material, mesh;
|
||
|
|
|
||
|
|
init();
|
||
|
|
animate();
|
||
|
|
|
||
|
|
function init() {
|
||
|
|
|
||
|
|
scene = new THREE.Scene();
|
||
|
|
|
||
|
|
camera = new THREE.PerspectiveCamera( 75, window.innerWidth / window.innerHeight, 1, 10000 );
|
||
|
|
camera.position.z = 1000;
|
||
|
|
|
||
|
|
geometry = new THREE.BoxGeometry( 200, 200, 200 );
|
||
|
|
material = new THREE.MeshBasicMaterial( { color: 0xff0000, wireframe: true } );
|
||
|
|
|
||
|
|
mesh = new THREE.Mesh( geometry, material );
|
||
|
|
scene.add( mesh );
|
||
|
|
|
||
|
|
renderer = new THREE.WebGLRenderer();
|
||
|
|
renderer.setSize( window.innerWidth, window.innerHeight );
|
||
|
|
|
||
|
|
document.body.appendChild( renderer.domElement );
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
function animate() {
|
||
|
|
|
||
|
|
requestAnimationFrame( animate );
|
||
|
|
|
||
|
|
mesh.rotation.x += 0.01;
|
||
|
|
mesh.rotation.y += 0.02;
|
||
|
|
|
||
|
|
renderer.render( scene, camera );
|
||
|
|
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
If everything went well you should see [this](http://jsfiddle.net/hfj7gm6t/).
|
||
|
|
|
||
|
|
### Change log ###
|
||
|
|
|
||
|
|
[releases](https://github.com/mrdoob/three.js/releases)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
[npm-badge]: https://img.shields.io/npm/v/three.svg
|
||
|
|
[npm-badge-url]: https://www.npmjs.com/package/three
|
||
|
|
[license-badge]: https://img.shields.io/npm/l/three.svg
|
||
|
|
[license-badge-url]: ./LICENSE
|
||
|
|
[dependencies-badge]: https://img.shields.io/david/mrdoob/three.js.svg
|
||
|
|
[dependencies-badge-url]: https://david-dm.org/mrdoob/three.js
|
||
|
|
[devDependencies-badge]: https://img.shields.io/david/dev/mrdoob/three.js.svg
|
||
|
|
[devDependencies-badge-url]: https://david-dm.org/mrdoob/three.js#info=devDependencies
|