THREE

This light globally illuminates all objects in the scene equally. It cannot be used to cast shadows as it does not have a direction.

Companion object for AmbientLight with factory method

Array of cameras used for multi-viewport rendering.

Represents an axis-aligned bounding box (AABB) in 2D space.

Represents an axis-aligned bounding box (AABB) in 3D space.

Class for generating rectangular cuboid geometries.

Base class for all geometries.

Abstract base class for cameras.

Creates a texture from a canvas element.

A class representing an RGB color.

A Color instance is represented by RGB components in the linear working color space, which defaults to LinearSRGBColorSpace. Inputs conventionally using SRGBColorSpace (such as hexadecimals and CSS strings) are converted to the working color space automatically.

A class that manages conversions between color spaces.

Creates 6 cameras that render to a WebGLCubeRenderTarget.

Represents a texture comprising six images - one for each side of a cube.

Class for loading a CubeTexture.

Cubic interpolant.

The cubic interpolant uses a cubic Hermite spline for interpolation. This provides a smooth interpolation between adjacent values.

A class representing cylindrical coordinates.

Cylindrical coordinates represent a position in 3D space using a distance from the origin (radius), an angle from the X axis on the XZ plane (theta), and a height above the XZ plane (y).

Creates a texture directly from raw data, width and height.

Default loading manager used by loaders if one isn't specified.

A light that gets emitted in a specific direction. This light will behave as though it is infinitely far away and the rays produced from it are all parallel. The common use case for this is to simulate daylight; the sun is far enough away that its position can be considered to be infinite.

Companion object for DirectionalLight with factory method

Discrete interpolant.

The discrete interpolant returns the sample at the position closest to the parameter.

A class for generating a dodecahedron geometry. A dodecahedron is a polyhedron with twelve pentagonal faces.

Companion object for DodecahedronGeometry with factory method.

A class representing Euler Angles.

A class representing a frustum - the volume visible to a camera.

A frustum is created by the intersection of six planes. The planes correspond to the faces of a parallelepiped (a box).

A loader for loading GLTF resources. The .gltf and .glb file extensions are supported.

The result of loading a GLTF asset.

This is almost identical to an Object3D. Its purpose is to make working with groups of objects syntactically clearer.

A group is useful for collecting objects to manipulate them as a whole, such as rotating, scaling, or setting their visibility.

Companion object for Group with factory method.

A class for generating an icosahedron geometry. An icosahedron is a regular polyhedron with 20 equilateral triangular faces, 30 edges and 12 vertices.

A special version of Mesh with instanced rendering support. Use this if you have to render a large number of objects with the same geometry and material.

Abstract base class of interpolants over parametric samples.

The parameter domain is one dimensional, typically the time or a path along a curve defined by the data.

The sample values can have any dimensionality and derived classes may apply special interpretations to the data.

This class provides the interval seek in a Template Method, deferring the actual interpolation to derived classes.

Abstract base class for lights.

A continuous line.

This is nearly the same as LineSegments; the only difference is that it is rendered using gl.LINE_STRIP instead of gl.LINES.

Companion object for Line class

A class representing a line in 3D space, defined by a start point and an end point.

A material for drawing wireframe-style geometries with solid lines.

Parameters for LineBasicMaterial.

A continuous line that connects back to the start.

This is nearly the same as Line; the only difference is that it is rendered using gl.LINE_LOOP instead of gl.LINE_STRIP, which draws a straight line to the next vertex, and connects the last vertex back to the first.

Companion object for LineLoop class

A material for drawing line segments with custom width.

A series of lines drawn between pairs of vertices.

This is nearly the same as Line; the only difference is that it is rendered using gl.LINES instead of gl.LINE_STRIP.

Companion object for LineSegments class

A series of lines drawn between pairs of vertices.

This adds functionality beyond LineSegments, like arbitrary line width and changing width to be in world units. Line2 extends this object, forming a polyline instead of individual segments.

A specialized geometry for drawing line segments.

Linear interpolant.

The linear interpolant performs a simple linear interpolation between two adjacent values.

Converts color component from linear to sRGB space

Class for managing and tracking loaded and pending data.

Abstract base class for materials.

A collection of math utility functions.

Constants and functions from MathUtils available as top-level exports

Represents a 3x3 matrix in Three.js.

The constructor and set method take arguments in row-major order, while internally they are stored in the elements array in column-major order.

Class representing triangular polygon mesh based objects.

Example:

val geometry = new BoxGeometry(1, 1, 1)
val material = new MeshBasicMaterial(js.Dynamic.literal(color = 0xffff00))
val mesh     = new Mesh(geometry, material)
scene.add(mesh)

A material for drawing geometries in a simple shaded way.

Interface that represents a mesh-like object that can be added to a scene.

A material for shiny surfaces with specular highlights.

The material uses a non-physically based Blinn-Phong model for calculating reflectance. Unlike the Lambertian model used in the MeshLambertMaterial this can simulate shiny surfaces with specular highlights (such as varnished wood).

Companion object for MeshPhongMaterial with factory method

Base class for all objects in the THREE scene graph.

A class for generating an octahedron geometry. An octahedron is a polyhedron with eight triangular faces.

Companion object for OctahedronGeometry with factory method.

Orbit controls allow the camera to orbit around a target.

Camera that uses orthographic projection.

Camera that uses perspective projection.

A class representing a plane in 3D space.

A class for displaying points.

Companion object for Points with factory method.

A material for drawing points.

Companion object for PointsMaterial with factory methods.

Parameters for PointsMaterial.

A class for generating a polyhedron geometry.

Companion object for PolyhedronGeometry with factory method.

Quaternion Linear Interpolant.

Interpolant for quaternions with spherical linear interpolation (SLERP). This interpolation ensures proper rotation interpolation.

A ray that emits from an origin in a certain direction.

This class is designed to assist with raycasting. Raycasting is used for mouse picking and more.

The intersection point of a raycaster intersection test.

Converts color component from sRGB to linear space

Scenes allow you to set up what and where is to be rendered by three.js.

A class representing a sphere in 3D space.

A class for spherical coordinates.

Spherical coordinates represent a position in 3D space using a distance from origin (radius), an angle from the y (polar) axis, and an angle around the y axis (equator).

A class for storing spherical harmonics.

Spherical harmonics are an extension of Spherical coordinates to the sphere, and are particularly useful for representing some types of directional data.

A sprite is a plane that always faces towards the camera. Sprites do not cast shadows, do not receive shadows, and do not have any depth testing.

Materials for sprites.

A special type of camera that uses two perspective cameras with stereoscopic projection. Can be used for rendering stereo effects like 3D Anaglyph or Parallax Barrier.

A class for generating a tetrahedron geometry. A tetrahedron is a polyhedron with four triangular faces.

Companion object for TetrahedronGeometry with factory method.

Base class for textures in THREE.js.

Class for loading a texture.

A class representing a triangle in 3D space.

Class representing a 4D vector.

A 4D vector is typically used for representing homogeneous coordinates or quaternions.

Creates a texture for use with a video.

The WebGL renderer displays your scenes using WebGL.