three-component-ts
v0.0.3
Published
Simplifies using three.js with TypeScript
Downloads
4
Maintainers
wayneparrottReadme
three-component-ts
Simplifies creation of a three.js scene and its rendering logic when using TypeScript. If you like developing with TypeScript and three.js, e.g., Angular, React or a webapp packaged with webpack, this class will create and configure a scene with a camera, light, renderer and control.
Customize scene component creation by overriding and extending any of the following ThreeComponent methods:
createScene()
createCamera()
createLight()
createRenderer()
createControls()Note: your subclass of ThreeComponent must provide a populateScene() method that customizes the scene to your purposes.
Install
Install three.js library and three-component-ts.
npm install three
npm install three-component-tsAs of version 0.103.0 of three you no longer need to install @types/three.
Create Your Own Three component
Creating your own ThreeComponent involves:
- creating a TypeScript subclass of ThreeComponent
- implement the abstract method populateScene()
- call initThree(canvasElementOrDomContainerOrNoParam?) to create the three.js scene and renderer
- call startRenderer() to start the rendering loop
- optionally override the animate() method with your own custom scene animation details
Following is an example rotating box implementation:
import { ThreeComponent, AxesHelper, BoxGeometry, Mesh, MeshBasicMaterial } from 'three-component-ts';
export class RotatingBox extends ThreeComponent {
cube: Mesh;
constructor() {
initThree(); // when no canvas or html parent element is provided
// a canvas element is created and appended to <body>
startRenderer(); //begin display of the scene & any animation you've implemented, see animate()
}
populateScene() {
this.scene.add(new THREE.AxesHelper(200));
const geometry = new BoxGeometry(1, 1, 1);
const material = new MeshBasicMaterial({ color: 0x00ff00 });
this.cube = new Mesh(geometry, material);
this.scene.add(this.cube);
}
animate(): void {
this.cube.rotation.x += 0.01;
this.cube.rotation.y += 0.01;
this.controls.update();
}
}