@types/three

What is @types/three?

@types/three provides TypeScript type definitions for the three.js library, which is a popular JavaScript library used to create and display animated 3D computer graphics in a web browser using WebGL.

What are @types/three's main functionalities?

Creating a Scene

This code demonstrates how to create a new scene in three.js. A scene is the container for all the objects, lights, and cameras in your 3D world.

const scene: THREE.Scene = new THREE.Scene();

Adding a Camera

This code shows how to create a perspective camera, which simulates the way the human eye sees. The parameters define the field of view, aspect ratio, near clipping plane, and far clipping plane.

const camera: THREE.PerspectiveCamera = new THREE.PerspectiveCamera(75, window.innerWidth / window.innerHeight, 0.1, 1000);

Creating a Renderer

This code demonstrates how to create a WebGL renderer, set its size, and append it to the DOM. The renderer is responsible for rendering the scene from the perspective of the camera.

const renderer: THREE.WebGLRenderer = new THREE.WebGLRenderer(); renderer.setSize(window.innerWidth, window.innerHeight); document.body.appendChild(renderer.domElement);

Adding a Mesh

This code shows how to create a simple cube mesh with a basic material and add it to the scene. A mesh is an object that takes a geometry and applies a material to it, which can then be added to the scene.

const geometry: THREE.BoxGeometry = new THREE.BoxGeometry(); const material: THREE.MeshBasicMaterial = new THREE.MeshBasicMaterial({ color: 0x00ff00 }); const cube: THREE.Mesh = new THREE.Mesh(geometry, material); scene.add(cube);

Animating the Scene

This code demonstrates how to create an animation loop that continuously renders the scene. The cube is rotated slightly on each frame, creating an animation effect.

function animate() { requestAnimationFrame(animate); cube.rotation.x += 0.01; cube.rotation.y += 0.01; renderer.render(scene, camera); } animate();

Other packages similar to @types/three

babylonjs

Babylon.js is a powerful, beautiful, simple, and open game and rendering engine packed into a friendly JavaScript framework. It provides similar functionalities to three.js but also includes a more extensive set of features for game development.

aframe

A-Frame is a web framework for building virtual reality experiences. It is built on top of three.js and provides an easy-to-use, declarative HTML-like syntax for creating 3D and VR scenes.

playcanvas

PlayCanvas is an open-source game engine that provides a comprehensive set of tools for building 3D web applications. It offers a visual development environment and is known for its performance and ease of use.

README

Installation

npm install --save @types/three

Summary

This package contains type definitions for three (https://threejs.org/).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three.

Additional Details

• Last updated: Fri, 31 Jan 2025 19:32:17 GMT
• Dependencies: @tweenjs/tween.js, @types/stats.js, @types/webxr, @webgpu/types, fflate, meshoptimizer

Credits

These definitions were written by Josh Ellis, and Nathan Bierema.