THREE

package THREE

Members list

Packages

package THREE.animation
package THREE.extras

Type members

Classlikes

object AlwaysDepth extends Object

Always pass.

Always pass.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object AlwaysStencilFunc extends Object

Will always return true.

Will always return true.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class AmbientLight(color: Int | String | Color, intensity: Double) extends Light

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

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

Attributes

Companion
object
Supertypes
class Light
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object AmbientLight extends Object

Companion object for AmbientLight with factory method

Companion object for AmbientLight with factory method

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class ArrayCamera(var cameras: Array[PerspectiveCamera]) extends PerspectiveCamera

Array of cameras used for multi-viewport rendering.

Array of cameras used for multi-viewport rendering.

Attributes

Supertypes
class Camera
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class ArrowHelper(var dir: Vector3, var origin: Vector3, var length: Double, var color: Double | Color | String, var headLength: Double, var headWidth: Double) extends Object3D

An 3D arrow object for visualizing directions.

An 3D arrow object for visualizing directions.

Attributes

Example
 val dir = new Vector3(1, 2, 0)
 dir.normalize()
 val origin = new Vector3(0, 0, 0)
 val length = 1.0
 val hex    = 0xffff00
 val arrowHelper = new ArrowHelper(dir, origin, length, hex)
 scene.add(arrowHelper)
Companion
object
Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object ArrowHelper extends Object

Companion object for ArrowHelper class

Companion object for ArrowHelper class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class Audio(listener: AudioListener) extends Object

Create a non-positional audio object. This uses the Web Audio API and can play audio clips that are either loaded via the AudioLoader or created dynamically.

Create a non-positional audio object. This uses the Web Audio API and can play audio clips that are either loaded via the AudioLoader or created dynamically.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Known subtypes
class AudioAnalyser(audio: Audio, fftSize: UndefOr[Int]) extends Object

Create a frequency analyser for audio sources. This uses the Web Audio API's AnalyserNode to provide frequency and time domain data for visualization.

Create a frequency analyser for audio sources. This uses the Web Audio API's AnalyserNode to provide frequency and time domain data for visualization.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
trait AudioBuffer extends Object

Audio buffer interface for loaded audio data.

Audio buffer interface for loaded audio data.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class AudioListener extends Object

The AudioListener represents a virtual listener of the audio sources in a scene. It is similar to a camera in the visual scene - it has a position and orientation in 3D space, and defines from where the audio is heard.

The AudioListener represents a virtual listener of the audio sources in a scene. It is similar to a camera in the visual scene - it has a position and orientation in 3D space, and defines from where the audio is heard.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class AudioLoader(loadingManager: UndefOr[LoadingManager]) extends Object

Class for loading an audio file.

Class for loading an audio file.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class AxesHelper(var size: Double) extends LineSegments

An axis object to visualize the 3 axes in a simple way. The X axis is red. The Y axis is green. The Z axis is blue.

An axis object to visualize the 3 axes in a simple way. The X axis is red. The Y axis is green. The Z axis is blue.

Attributes

Example
 val axesHelper = new AxesHelper(5)
 scene.add(axesHelper)
Companion
object
Supertypes
class LineSegments
class Line
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object AxesHelper extends Object

Companion object for AxesHelper class

Companion object for AxesHelper class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
AxesHelper.type
object BasicShadowMap extends Object

Gives unfiltered shadow maps - fastest, but lowest quality.

Gives unfiltered shadow maps - fastest, but lowest quality.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class BloomPass(strength: Double, kernelSize: Double, sigma: Double, resolution: Double) extends EffectPass

Bloom pass that adds a bloom/glow effect to bright areas

Bloom pass that adds a bloom/glow effect to bright areas

Attributes

Companion
object
Supertypes
class EffectPass
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object BloomPass

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
BloomPass.type
class BokehPass(scene: Scene, camera: Camera, params: BokehPassParameters) extends EffectPass

BokehPass applies a depth of field effect using a bokeh shader

BokehPass applies a depth of field effect using a bokeh shader

Attributes

Companion
object
Supertypes
class EffectPass
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object BokehPass

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
BokehPass.type
trait BokehPassParameters extends Object

Parameters for BokehPass configuration

Parameters for BokehPass configuration

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
class Bone extends Object3D

A bone which is part of a Skeleton. The skeleton in turn is used by the SkinnedMesh.

A bone which is part of a Skeleton. The skeleton in turn is used by the SkinnedMesh.

Example:

val root  = new Bone()
val child = new Bone()

root.add(child)
child.position.y = 5

Attributes

Companion
object
Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object Bone extends Object

Companion object for Bone with factory method.

Companion object for Bone with factory method.

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
Bone.type
class Box2(val min: UndefOr[Vector2], val max: UndefOr[Vector2]) extends Object

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

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

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class Box3(val min: UndefOr[Vector3], val max: UndefOr[Vector3]) extends Object

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

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

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class Box3Helper(var box: Box3, var color: Double | Color | String) extends LineSegments

A helper object to visualize an instance of [[Box3]].

A helper object to visualize an instance of [[Box3]].

Attributes

Example
 val box = new Box3()
 box.setFromCenterAndSize(new Vector3(1, 1, 1), new Vector3(2, 1, 3))
 val helper = new Box3Helper(box, 0xffff00)
 scene.add(helper)
Companion
object
Supertypes
class LineSegments
class Line
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object Box3Helper extends Object

Companion object for Box3Helper class

Companion object for Box3Helper class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
Box3Helper.type
class BoxGeometry(width: Double, height: Double, depth: Double, widthSegments: Int, heightSegments: Int, depthSegments: Int) extends BufferGeometry

Class for generating rectangular cuboid geometries.

Class for generating rectangular cuboid geometries.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class BoxHelper(var obj: Object3D, var color: Double | Color | String) extends LineSegments

Helper object to graphically show the world-axis-aligned bounding box around an object. The actual bounding box is handled with [[Box3]], this is just a visual helper for debugging. It can be automatically resized with [[BoxHelper#update]] when the object it's created from is transformed. Note that the object must have a geometry for this to work, so it won't work with sprites.

Helper object to graphically show the world-axis-aligned bounding box around an object. The actual bounding box is handled with [[Box3]], this is just a visual helper for debugging. It can be automatically resized with [[BoxHelper#update]] when the object it's created from is transformed. Note that the object must have a geometry for this to work, so it won't work with sprites.

Attributes

Example
 val sphere = new SphereGeometry()
 val obj    = new Mesh(sphere, new MeshBasicMaterial(0xff0000))
 val box    = new BoxHelper(obj, 0xffff00)
 scene.add(box)
Companion
object
Supertypes
class LineSegments
class Line
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object BoxHelper extends Object

Companion object for BoxHelper class

Companion object for BoxHelper class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
BoxHelper.type
class BufferGeometry extends Object

Base class for all geometries.

Base class for all geometries.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Known subtypes
class BufferGeometryLoader(loadingManager: UndefOr[LoadingManager]) extends Object

Class for loading a buffer geometry from JSON format.

Class for loading a buffer geometry from JSON format.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
object BufferGeometryUtils extends Object

Utility functions for working with BufferGeometry objects. Provides advanced vertex manipulation and geometry processing capabilities.

Utility functions for working with BufferGeometry objects. Provides advanced vertex manipulation and geometry processing capabilities.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class Camera extends Object3D

Abstract base class for cameras.

Abstract base class for cameras.

Attributes

Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
Known subtypes
class CameraHelper(var camera: Camera) extends LineSegments

This helps with visualizing what a camera contains in its frustum. It visualizes the frustum of a camera using line segments.

This helps with visualizing what a camera contains in its frustum. It visualizes the frustum of a camera using line segments.

Based on frustum visualization in lightgl.js shadowmap example.

CameraHelper must be a child of the scene.

Attributes

Example
 val camera = new PerspectiveCamera(75, window.innerWidth / window.innerHeight, 0.1, 1000)
 val helper = new CameraHelper(camera)
 scene.add(helper)
Companion
object
Supertypes
class LineSegments
class Line
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object CameraHelper extends Object

Companion object for CameraHelper class

Companion object for CameraHelper class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class CanvasTexture(canvas: Any, mapping: UndefOr[Int], wrapS: UndefOr[Int], wrapT: UndefOr[Int], magFilter: UndefOr[Int], minFilter: UndefOr[Int], format: UndefOr[Int], tpe: UndefOr[Int], anisotropy: UndefOr[Int]) extends Texture

Creates a texture from a canvas element.

Creates a texture from a canvas element.

Attributes

Supertypes
class Texture
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class CircleGeometry(radius: Double, segments: Int, thetaStart: Double, thetaLength: Double) extends BufferGeometry

Class for generating circle geometries.

Class for generating circle geometries.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class Color(var r: UndefOr[Double | String | Color], var g: UndefOr[Double], var b: UndefOr[Double]) extends Object

A class representing an RGB color.

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.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
object Color extends Object

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
Color.type
object ColorManagement extends Object

A class that manages conversions between color spaces.

A class that manages conversions between color spaces.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class CompressedTexture(mipmaps: Array[Object], width: Int, height: Int, format: UndefOr[Int], tpe: UndefOr[Int], mapping: UndefOr[Int], wrapS: UndefOr[Int], wrapT: UndefOr[Int], magFilter: UndefOr[Int], minFilter: UndefOr[Int], anisotropy: UndefOr[Int], colorSpace: UndefOr[String]) extends Texture

Creates a texture based on data in compressed form.

Creates a texture based on data in compressed form.

These textures are usually loaded with CompressedTextureLoader.

Attributes

Supertypes
class Texture
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class ConeGeometry(radius: Double, height: Double, radialSegments: Int, heightSegments: Int, openEnded: Boolean, thetaStart: Double, thetaLength: Double) extends BufferGeometry

Class for generating cone geometries.

Class for generating cone geometries.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class CubeCamera(near: Double, far: Double, renderTarget: WebGLCubeRenderTarget) extends Object3D

Creates 6 cameras that render to a WebGLCubeRenderTarget.

Creates 6 cameras that render to a WebGLCubeRenderTarget.

Attributes

Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class CubeTexture(var images: UndefOr[Array[Any]], mapping: UndefOr[Int], wrapS: UndefOr[Int], wrapT: UndefOr[Int], magFilter: UndefOr[Int], minFilter: UndefOr[Int], format: UndefOr[Int], `type`: UndefOr[Int], anisotropy: UndefOr[Int], colorSpace: UndefOr[String]) extends Texture

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

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

Attributes

Supertypes
class Texture
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class CubeTextureLoader(loadingManager: UndefOr[LoadingManager]) extends Object

Class for loading a CubeTexture.

Class for loading a CubeTexture.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class CubicInterpolant(parameterPositions: TypedArray[_, _], sampleValues: TypedArray[_, _], sampleSize: Int, resultBuffer: UndefOr[TypedArray[_, _]]) extends Interpolant

Cubic interpolant.

Cubic interpolant.

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

Attributes

Supertypes
class Interpolant
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object CullFaceBack extends Object

Culls back faces.

Culls back faces.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object CullFaceFront extends Object

Culls front faces.

Culls front faces.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object CullFaceFrontBack extends Object

Culls both front and back faces.

Culls both front and back faces.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object CullFaceNone extends Object

Disables face culling.

Disables face culling.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class CylinderGeometry(radiusTop: Double, radiusBottom: Double, height: Double, radialSegments: Int, heightSegments: Int, openEnded: Boolean, thetaStart: Double, thetaLength: Double) extends BufferGeometry

Class for generating cylinder geometries.

Class for generating cylinder geometries.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class Cylindrical(var radius: UndefOr[Double], var theta: UndefOr[Double], var y: UndefOr[Double]) extends Object

A class representing cylindrical coordinates.

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).

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class DDSLoader(loadingManager: UndefOr[LoadingManager]) extends Object

A loader for the S3TC texture compression format (DDS files).

A loader for the S3TC texture compression format (DDS files).

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class DataTexture(data: TypedArray[_, _], width: Int, height: Int, format: UndefOr[Int], `type`: UndefOr[Int], mapping: UndefOr[Int], wrapS: UndefOr[Int], wrapT: UndefOr[Int], magFilter: UndefOr[Int], minFilter: UndefOr[Int], anisotropy: UndefOr[Int], colorSpace: UndefOr[String]) extends Texture

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

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

Attributes

Supertypes
class Texture
class Object
trait Any
class Object
trait Matchable
class Any
Show all

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

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

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
Self type
class DepthTexture(width: Double, height: Double, tpe: UndefOr[Int], mapping: UndefOr[Int], wrapS: UndefOr[Int], wrapT: UndefOr[Int], magFilter: UndefOr[Int], minFilter: UndefOr[Int], anisotropy: UndefOr[Int], format: UndefOr[Int], depth: UndefOr[Int]) extends Texture

This class can be used to automatically save the depth information of a rendering into a texture.

This class can be used to automatically save the depth information of a rendering into a texture.

Attributes

Supertypes
class Texture
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class DirectionalLight(color: Int | String | Color, intensity: Double) extends Light

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.

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.

Attributes

Companion
object
Supertypes
class Light
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object DirectionalLight extends Object

Companion object for DirectionalLight with factory method

Companion object for DirectionalLight with factory method

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class DirectionalLightHelper(var light: DirectionalLight, size: Double, color: Int | String | Color) extends Object3D

Helper object to assist with visualizing a [[DirectionalLight]]'s effect on the scene. This consists of plane and a line representing the light's position and direction.

Helper object to assist with visualizing a [[DirectionalLight]]'s effect on the scene. This consists of plane and a line representing the light's position and direction.

Attributes

Example
 val light = new DirectionalLight(0xffffff)
 scene.add(light)
 val helper = new DirectionalLightHelper(light, 5)
 scene.add(helper)
Companion
object
Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object DirectionalLightHelper extends Object

Companion object for DirectionalLightHelper class

Companion object for DirectionalLightHelper class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type

Represents the shadow configuration of directional lights.

Represents the shadow configuration of directional lights.

Attributes

Companion
object
Supertypes
class LightShadow
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object DirectionalLightShadow extends Object

Companion object for DirectionalLightShadow with factory method

Companion object for DirectionalLightShadow with factory method

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class DiscreteInterpolant(parameterPositions: TypedArray[_, _], sampleValues: TypedArray[_, _], sampleSize: Int, resultBuffer: UndefOr[TypedArray[_, _]]) extends Interpolant

Discrete interpolant.

Discrete interpolant.

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

Attributes

Supertypes
class Interpolant
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class DodecahedronGeometry(radius: Double, detail: Int) extends PolyhedronGeometry

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

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

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object DodecahedronGeometry extends Object

Companion object for DodecahedronGeometry with factory method.

Companion object for DodecahedronGeometry with factory method.

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class DotScreenPass(center: Vector2, angle: Double, scale: Double) extends EffectPass

Dot screen pass that creates halftone/dot pattern effects

Dot screen pass that creates halftone/dot pattern effects

Attributes

Companion
object
Supertypes
class EffectPass
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object DotScreenPass

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class DragControls(objects: Array[Object3D], camera: Camera, domElement: Element) extends Object

This class can be used to provide a drag'n'drop interaction.

This class can be used to provide a drag'n'drop interaction.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
object DragControls

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object DynamicCopyUsage extends Object

The contents are intended to be respecified repeatedly by reading data from the 3D API, and used many times as the source for WebGL drawing and image specification commands.

The contents are intended to be respecified repeatedly by reading data from the 3D API, and used many times as the source for WebGL drawing and image specification commands.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object DynamicDrawUsage extends Object

The contents are intended to be respecified repeatedly by the application, and used many times as the source for drawing and image specification commands.

The contents are intended to be respecified repeatedly by the application, and used many times as the source for drawing and image specification commands.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object DynamicReadUsage extends Object

The contents are intended to be respecified repeatedly by reading data from the 3D API, and queried many times by the application.

The contents are intended to be respecified repeatedly by reading data from the 3D API, and queried many times by the application.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class EffectComposer(renderer: WebGLRenderer, renderTarget: UndefOr[WebGLRenderTarget]) extends Object

The EffectComposer is a post-processing pipeline that allows you to apply multiple post-processing effects to a scene.

The EffectComposer is a post-processing pipeline that allows you to apply multiple post-processing effects to a scene.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class EffectPass extends Object

Base class for all post-processing passes

Base class for all post-processing passes

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Known subtypes
class BloomPass
class BokehPass
class FilmPass
class GlitchPass
class OutputPass
class RenderPass
class SSAOPass
class SSRPass
class ShaderPass
Show all
object EffectPass

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
EffectPass.type
object EqualDepth extends Object

Pass if the incoming value equals the depth buffer value.

Pass if the incoming value equals the depth buffer value.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
EqualDepth.type
object EqualStencilFunc extends Object

Will return true if the stencil reference value is equal to the current stencil value.

Will return true if the stencil reference value is equal to the current stencil value.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class Euler(var x: Double, var y: Double, var z: Double, var order: String) extends Object

A class representing Euler Angles.

A class representing Euler Angles.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
object Euler extends Object

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
Euler.type
class ExtrudeGeometry(shapes: Any, options: Object) extends BufferGeometry

Creates extruded geometry from a path shape.

Creates extruded geometry from a path shape.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
Known subtypes
class TextGeometry
class FileLoader(loadingManager: UndefOr[LoadingManager]) extends Object

Class for loading a file as a string or ArrayBuffer.

Class for loading a file as a string or ArrayBuffer.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class FilmPass(noiseIntensity: UndefOr[Double], scanlinesIntensity: UndefOr[Double], scanlinesCount: UndefOr[Double], grayscale: UndefOr[Boolean]) extends EffectPass

Film pass that adds film grain and scanlines effects

Film pass that adds film grain and scanlines effects

Attributes

Companion
object
Supertypes
class EffectPass
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object FilmPass

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
FilmPass.type
class FirstPersonControls(camera: Camera, domElement: UndefOr[Element]) extends Object

This class is an alternative implementation of [[FlyControls]].

This class is an alternative implementation of [[FlyControls]].

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class FlyControls(camera: Camera, domElement: UndefOr[Element]) extends Object

This class enables a navigation similar to fly modes in DCC tools like Blender. You can arbitrarily transform the camera in 3D space without any limitations (e.g. focus on a specific target).

This class enables a navigation similar to fly modes in DCC tools like Blender. You can arbitrarily transform the camera in 3D space without any limitations (e.g. focus on a specific target).

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class Fog extends Object

This class can be used to define a linear fog that grows linearly denser with the distance.

This class can be used to define a linear fog that grows linearly denser with the distance.

val scene = new Scene()
scene.fog = Fog(0xcccccc, 10, 15)

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
object Fog

Companion object for creating Fog instances

Companion object for creating Fog instances

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Fog.type
class FogExp2 extends Object

This class can be used to define an exponential squared fog, which gives a clear view near the camera and a faster than exponentially densening fog farther from the camera.

This class can be used to define an exponential squared fog, which gives a clear view near the camera and a faster than exponentially densening fog farther from the camera.

val scene = new Scene()
scene.fog = FogExp2(0xcccccc, 0.002)

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
object FogExp2

Companion object for creating FogExp2 instances

Companion object for creating FogExp2 instances

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
FogExp2.type
class FontLoader(loadingManager: UndefOr[LoadingManager]) extends Object

Class for loading a font in JSON format.

Class for loading a font in JSON format.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class FramebufferTexture(var width: UndefOr[Double], var height: UndefOr[Double]) extends Texture

This class can only be used in combination with copyFramebufferToTexture() methods of renderers. It extracts the contents of the current bound framebuffer and provides it as a texture for further usage.

This class can only be used in combination with copyFramebufferToTexture() methods of renderers. It extracts the contents of the current bound framebuffer and provides it as a texture for further usage.

Attributes

Example
 val pixelRatio  = scala.scalajs.dom.window.devicePixelRatio
 val textureSize = 128 * pixelRatio
 val frameTexture = new FramebufferTexture(textureSize, textureSize)
 // calculate start position for copying part of the frame data
 val vector = new Vector2()
 vector.x = (scala.scalajs.dom.window.innerWidth * pixelRatio / 2) - (textureSize / 2)
 vector.y = (scala.scalajs.dom.window.innerHeight * pixelRatio / 2) - (textureSize / 2)
 renderer.render(scene, camera)
 // copy part of the rendered frame into the framebuffer texture
 renderer.copyFramebufferToTexture(frameTexture, vector)
Supertypes
class Texture
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class Frustum(var planes: UndefOr[Array[Plane]]) extends Object

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

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).

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class GLTFLoader(manager: UndefOr[LoadingManager]) extends Object

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

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

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
trait GLTFResult extends Object

The result of loading a GLTF asset.

The result of loading a GLTF asset.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class GlitchPass(dtSize: UndefOr[Int], random: UndefOr[Boolean]) extends EffectPass

Glitch pass that creates digital glitch effects

Glitch pass that creates digital glitch effects

Attributes

Companion
object
Supertypes
class EffectPass
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object GlitchPass

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
GlitchPass.type
case class GlitchPassParameters(dtSize: UndefOr[Int], random: UndefOr[Boolean])

Parameters for GlitchPass configuration

Parameters for GlitchPass configuration

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GreaterDepth extends Object

Pass if the incoming value is greater than the depth buffer value.

Pass if the incoming value is greater than the depth buffer value.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object GreaterEqualDepth extends Object

Pass if the incoming value is greater than or equal to the depth buffer value.

Pass if the incoming value is greater than or equal to the depth buffer value.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object GreaterEqualStencilFunc extends Object

Will return true if the stencil reference value is greater than or equal to the current stencil value.

Will return true if the stencil reference value is greater than or equal to the current stencil value.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object GreaterStencilFunc extends Object

Will return true if the stencil reference value is greater than the current stencil value.

Will return true if the stencil reference value is greater than the current stencil value.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class GridHelper(var size: Double, var divisions: Double, var color1: Double | Color | String, var color2: Double | Color | String) extends LineSegments

The GridHelper is an object to define grids. Grids are two-dimensional arrays of lines.

The GridHelper is an object to define grids. Grids are two-dimensional arrays of lines.

Attributes

Example
 val gridHelper = new GridHelper(10, 10)
 scene.add(gridHelper)
Companion
object
Supertypes
class LineSegments
class Line
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object GridHelper extends Object

Companion object for GridHelper class

Companion object for GridHelper class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
GridHelper.type
class Group extends Object3D

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

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.

Attributes

Companion
object
Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object Group extends Object

Companion object for Group with factory method.

Companion object for Group with factory method.

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
Group.type
class HemisphereLight(skyColor: Int | String | Color, intensity: Double) extends Light

A light source positioned directly above the scene, with color fading from the sky color to the ground color.

A light source positioned directly above the scene, with color fading from the sky color to the ground color.

Attributes

Companion
object
Supertypes
class Light
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class IcosahedronGeometry(radius: Double, detail: Int) extends BufferGeometry

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

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

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class ImageBitmapLoader(loadingManager: UndefOr[LoadingManager]) extends Object

Class for loading an ImageBitmap.

Class for loading an ImageBitmap.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class InstancedMesh(geometry: UndefOr[BufferGeometry], material: UndefOr[Material | Array[Material]], val count: UndefOr[Int]) extends Mesh

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.

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.

Attributes

Supertypes
class Mesh
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class Interpolant extends Object

Abstract base class of interpolants over parametric samples.

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.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Known subtypes
object InterpolateDiscrete extends Object

Discrete interpolation mode.

Discrete interpolation mode.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object InterpolateLinear extends Object

Linear interpolation mode.

Linear interpolation mode.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object InterpolateSmooth extends Object

Smooth interpolation mode.

Smooth interpolation mode.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object InterpolationSamplingMode extends Object

Represents the different interpolation sampling modes.

Represents the different interpolation sampling modes.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object InterpolationSamplingType extends Object

Represents mouse buttons and interaction types in context of controls.

Represents mouse buttons and interaction types in context of controls.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class LOD extends Object3D

A component for providing a basic Level of Detail (LOD) mechanism.

A component for providing a basic Level of Detail (LOD) mechanism.

Every LOD level is associated with an object, and rendering can be switched between them at the distances specified. Typically you would create, say, three meshes, one for far away (low detail), one for mid range (medium detail) and one for close up (high detail).

Example:

val lod      = new LOD()
val material = MeshBasicMaterial(color = 0xffff00)

// Create spheres with 3 levels of detail and create new LOD levels for them
for (i <- 0 until 3) {
 val geometry = IcosahedronGeometry(10, 3 - i)
 val mesh     = Mesh(geometry, material)
 lod.addLevel(mesh, i * 75)
}

scene.add(lod)

Attributes

Companion
object
Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object LOD extends Object

Companion object for LOD with factory method.

Companion object for LOD with factory method.

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
LOD.type
trait LODLevel extends Object

Represents a single LOD level with its object, distance, and hysteresis settings.

Represents a single LOD level with its object, distance, and hysteresis settings.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class LatheGeometry(points: Array[Vector2], segments: Int, phiStart: Double, phiLength: Double) extends BufferGeometry

Creates meshes with axial symmetry like vases. The lathe rotates around the Y axis.

Creates meshes with axial symmetry like vases. The lathe rotates around the Y axis.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class Lensflare extends Object3D

LensFlare creates realistic lens flare effects that simulate the scattering of light through a camera lens. It consists of multiple LensFlareElement objects positioned at different distances from the light source.

LensFlare creates realistic lens flare effects that simulate the scattering of light through a camera lens. It consists of multiple LensFlareElement objects positioned at different distances from the light source.

Attributes

Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class LensflareElement(var texture: UndefOr[Texture], var size: UndefOr[Double], var distance: UndefOr[Double], var color: UndefOr[Color]) extends Object

LensFlareElement represents a single element in a lens flare effect. Each element can have its own texture, size, distance from the light source, and color.

LensFlareElement represents a single element in a lens flare effect. Each element can have its own texture, size, distance from the light source, and color.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
object LessDepth extends Object

Pass if the incoming value is less than the depth buffer value.

Pass if the incoming value is less than the depth buffer value.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
LessDepth.type
object LessEqualDepth extends Object

Pass if the incoming value is less than or equal to the depth buffer value.

Pass if the incoming value is less than or equal to the depth buffer value.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object LessEqualStencilFunc extends Object

Will return true if the stencil reference value is less than or equal to the current stencil value.

Will return true if the stencil reference value is less than or equal to the current stencil value.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object LessStencilFunc extends Object

Will return true if the stencil reference value is less than the current stencil value.

Will return true if the stencil reference value is less than the current stencil value.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class Light(var color: Int | String | Color, var intensity: Double) extends Object3D

Abstract base class for lights.

Abstract base class for lights.

Attributes

Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
Known subtypes
class AmbientLight
class PointLight
class SpotLight
Show all
class LightProbe() extends Object3D

Light probes are used for image-based lighting (IBL) in Three.js. They capture the lighting information from the environment and can be used to illuminate objects with realistic lighting based on their surroundings.

Light probes are used for image-based lighting (IBL) in Three.js. They capture the lighting information from the environment and can be used to illuminate objects with realistic lighting based on their surroundings.

Attributes

Companion
object
Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object LightProbe

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
LightProbe.type
class LightShadow(var camera: Camera) extends Object

Abstract base class for light shadow classes. These classes represent the shadow configuration for different light types.

Abstract base class for light shadow classes. These classes represent the shadow configuration for different light types.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Known subtypes
object LightShadow extends Object

Companion object for LightShadow with factory method

Companion object for LightShadow with factory method

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class Line(var geometry: BufferGeometry, var material: Any) extends Object3D

A continuous line.

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.

Attributes

Companion
object
Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
Known subtypes
class LineLoop
class LineSegments
class AxesHelper
class Box3Helper
class BoxHelper
class CameraHelper
class GridHelper
class PlaneHelper
Show all
object Line extends Object

Companion object for Line class

Companion object for Line class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
Line.type
class Line3(var start: UndefOr[Vector3], var end: UndefOr[Vector3]) extends Object

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

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

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class LineBasicMaterial(parameters: UndefOr[Object]) extends Material

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

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

Attributes

Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all
Known subtypes
class LineBasicMaterialParameters extends Object

Parameters for LineBasicMaterial.

Parameters for LineBasicMaterial.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class LineDashedMaterial(parameters: UndefOr[Object]) extends LineBasicMaterial

A material for drawing wireframe-style geometries with dashed lines. Note: You must call Line.computeLineDistances() when using LineDashedMaterial.

A material for drawing wireframe-style geometries with dashed lines. Note: You must call Line.computeLineDistances() when using LineDashedMaterial.

Attributes

Companion
object
Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Companion object for LineDashedMaterial with factory methods.

Companion object for LineDashedMaterial with factory methods.

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class LineLoop extends Line

A continuous line that connects back to the start.

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.

Attributes

Companion
object
Supertypes
class Line
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object LineLoop extends Object

Companion object for LineLoop class

Companion object for LineLoop class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
LineLoop.type
class LineMaterial(parameters: UndefOr[Dynamic]) extends Material

A material for drawing line segments with custom width.

A material for drawing line segments with custom width.

Attributes

Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class LineSegments extends Line

A series of lines drawn between pairs of vertices.

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.

Attributes

Companion
object
Supertypes
class Line
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
Known subtypes
class AxesHelper
class Box3Helper
class BoxHelper
class CameraHelper
class GridHelper
Show all
object LineSegments extends Object

Companion object for LineSegments class

Companion object for LineSegments class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class LineSegments2(geometry: UndefOr[LineSegmentsGeometry], material: UndefOr[LineMaterial]) extends Mesh

A series of lines drawn between pairs of vertices.

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.

Attributes

Supertypes
class Mesh
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all

A specialized geometry for drawing line segments.

A specialized geometry for drawing line segments.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class LinearInterpolant(parameterPositions: TypedArray[_, _], sampleValues: TypedArray[_, _], sampleSize: Int, resultBuffer: UndefOr[TypedArray[_, _]]) extends Interpolant

Linear interpolant.

Linear interpolant.

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

Attributes

Supertypes
class Interpolant
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object LinearToSRGB extends Function1[Double, Double]

Converts color component from linear to sRGB space

Converts color component from linear to sRGB space

Attributes

Supertypes
trait Function1[Double, Double]
class Function
class Object
trait Any
class Object
trait Matchable
class Any
Show all
Self type
class LoadingManager(var onLoad: UndefOr[Function0[Unit]], var onProgress: UndefOr[Function3[String, Int, Int, Unit]], var onError: UndefOr[Function1[String, Unit]]) extends Object

Class for managing and tracking loaded and pending data.

Class for managing and tracking loaded and pending data.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Known subtypes
object MOUSE extends Object

Represents mouse buttons and interaction types in context of controls.

Represents mouse buttons and interaction types in context of controls.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
MOUSE.type
class Material extends Object

Abstract base class for materials.

Abstract base class for materials.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Known subtypes
class MaterialLoader(loadingManager: UndefOr[LoadingManager]) extends Object

Class for loading a JSON format material.

Class for loading a JSON format material.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
object MathUtils extends Object

A collection of math utility functions.

A collection of math utility functions.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
MathUtils.type
object MathUtilsConstants extends Object

Constants and functions from MathUtils available as top-level exports

Constants and functions from MathUtils available as top-level exports

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object MathUtilsFunctions extends Object

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class Matrix3(n11: UndefOr[Double], n12: UndefOr[Double], n13: UndefOr[Double], n21: UndefOr[Double], n22: UndefOr[Double], n23: UndefOr[Double], n31: UndefOr[Double], n32: UndefOr[Double], n33: UndefOr[Double]) extends Object

Represents a 3x3 matrix in Three.js.

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.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class Matrix4(n11: UndefOr[Double], n12: UndefOr[Double], n13: UndefOr[Double], n14: UndefOr[Double], n21: UndefOr[Double], n22: UndefOr[Double], n23: UndefOr[Double], n24: UndefOr[Double], n31: UndefOr[Double], n32: UndefOr[Double], n33: UndefOr[Double], n34: UndefOr[Double], n41: UndefOr[Double], n42: UndefOr[Double], n43: UndefOr[Double], n44: UndefOr[Double]) extends Object

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class Mesh(var geometry: UndefOr[BufferGeometry], var material: UndefOr[Material | Array[Material]]) extends Object3D

Class representing triangular polygon mesh based objects.

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)

Attributes

Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
Known subtypes
class Reflector
class Refractor
class SkinnedMesh
class Water
Show all
class MeshBasicMaterial(parameters: UndefOr[Object]) extends Material

A material for drawing geometries in a simple shaded way.

A material for drawing geometries in a simple shaded way.

Attributes

Companion
object
Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class MeshDepthMaterial(parameters: UndefOr[Object]) extends Material

A material for rendering geometry based on depth information.

A material for rendering geometry based on depth information.

This material renders objects based on their distance from the camera, with closer objects appearing brighter and farther objects appearing darker. It's commonly used for depth-based rendering, shadow mapping, and various post-processing effects.

Attributes

Companion
object
Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Companion object for MeshDepthMaterial with factory method

Companion object for MeshDepthMaterial with factory method

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class MeshDistanceMaterial(parameters: UndefOr[Object]) extends Material

A material used internally for implementing shadow mapping with point lights.

A material used internally for implementing shadow mapping with point lights.

Can also be used to customize the shadow casting of an object by assigning an instance of MeshDistanceMaterial to [[Object3D#customDistanceMaterial]]. This approach can be used to ensure transparent parts of objects do not cast shadows.

Attributes

Companion
object
Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Companion object for MeshDistanceMaterial with factory method

Companion object for MeshDistanceMaterial with factory method

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class MeshLambertMaterial(parameters: UndefOr[Object]) extends Material

A material for non-shiny surfaces, without specular highlights.

A material for non-shiny surfaces, without specular highlights.

The material uses a Lambertian model which is perfectly matte, meaning that there are no specular highlights and the apparent brightness is the same regardless of the viewing angle.

Attributes

Companion
object
Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Companion object for MeshLambertMaterial with factory method

Companion object for MeshLambertMaterial with factory method

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class MeshMatcapMaterial(parameters: UndefOr[Object]) extends Material

A material for rendering objects using matcap (material capture) textures.

A material for rendering objects using matcap (material capture) textures.

Matcap materials use pre-rendered sphere textures that capture how a material should appear under different lighting conditions and viewing angles. This technique is commonly used for clay-like materials, metals, and stylized rendering.

Attributes

Companion
object
Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Companion object for MeshMatcapMaterial with factory method

Companion object for MeshMatcapMaterial with factory method

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class MeshNormalMaterial(parameters: UndefOr[Object]) extends Material

A material that visualizes the normals of a mesh by coloring them based on their direction.

A material that visualizes the normals of a mesh by coloring them based on their direction.

This material is commonly used for debugging purposes to visualize the surface normals of a geometry. The colors represent the direction of the normals:

  • Red: X-axis direction
  • Green: Y-axis direction
  • Blue: Z-axis direction

Attributes

Companion
object
Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Companion object for MeshNormalMaterial with factory method

Companion object for MeshNormalMaterial with factory method

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
trait MeshObject3D extends Object3D

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

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

Attributes

Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class MeshPhongMaterial(parameters: UndefOr[Object]) extends Material

A material for shiny surfaces with specular highlights.

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).

Attributes

Companion
object
Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Companion object for MeshPhongMaterial with factory method

Companion object for MeshPhongMaterial with factory method

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class MeshPhysicalMaterial(parameters: UndefOr[Object]) extends Material

An advanced physically based material, with advanced features like clearcoat, transmission, and refraction.

An advanced physically based material, with advanced features like clearcoat, transmission, and refraction.

This material extends MeshStandardMaterial with more advanced properties for realistic rendering of complex materials like glass, liquids, gemstones, and varnished surfaces.

Attributes

Companion
object
Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Companion object for MeshPhysicalMaterial with factory method

Companion object for MeshPhysicalMaterial with factory method

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class MeshStandardMaterial(parameters: UndefOr[Object]) extends Material

A standard physically based material, using Metallic-Roughness workflow.

A standard physically based material, using Metallic-Roughness workflow.

This material has a more complex shader that uses the Metallic-Roughness workflow for physically based rendering. It supports features like roughness, metalness, and clearcoat properties for realistic rendering of surfaces.

Attributes

Companion
object
Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Companion object for MeshStandardMaterial with factory method

Companion object for MeshStandardMaterial with factory method

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object NeverDepth extends Object

Never pass.

Never pass.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
NeverDepth.type
object NeverStencilFunc extends Object

Will never return true.

Will never return true.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object NotEqualDepth extends Object

Pass if the incoming value is not equal to the depth buffer value.

Pass if the incoming value is not equal to the depth buffer value.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object NotEqualStencilFunc extends Object

Will return true if the stencil reference value is not equal to the current stencil value.

Will return true if the stencil reference value is not equal to the current stencil value.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class Object3D extends Object

Base class for all objects in the THREE scene graph.

Base class for all objects in the THREE scene graph.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Known subtypes
object Object3D extends Object

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
Object3D.type
class ObjectLoader(loadingManager: UndefOr[LoadingManager]) extends Object

Class for loading a JSON resource.

Class for loading a JSON resource.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class OctahedronGeometry(radius: Double, detail: Int) extends PolyhedronGeometry

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

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

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object OctahedronGeometry extends Object

Companion object for OctahedronGeometry with factory method.

Companion object for OctahedronGeometry with factory method.

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class OrbitControls(camera: Camera, domElement: Element) extends Object

Orbit controls allow the camera to orbit around a target.

Orbit controls allow the camera to orbit around a target.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class OrthographicCamera(var left: Double, var right: Double, var top: Double, var bottom: Double, var near: Double, var far: Double) extends Camera

Camera that uses orthographic projection.

Camera that uses orthographic projection.

Attributes

Supertypes
class Camera
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class OutputPass() extends EffectPass

Output pass for tone mapping and color space conversion

Output pass for tone mapping and color space conversion

This pass is responsible for including tone mapping and color space conversion into your pass chain. In most cases, this pass should be included at the end of each pass chain. If a pass requires sRGB input (e.g. like FXAA), the pass must follow OutputPass in the pass chain.

The tone mapping and color space settings are extracted from the renderer.

Attributes

Companion
object
Supertypes
class EffectPass
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object OutputPass

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
OutputPass.type
object OutputShader extends Object

Output shader for tone mapping and color space conversion

Output shader for tone mapping and color space conversion

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object PCFShadowMap extends Object

Filters shadow maps using the Percentage-Closer Filtering (PCF) algorithm.

Filters shadow maps using the Percentage-Closer Filtering (PCF) algorithm.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object PCFSoftShadowMap extends Object

Filters shadow maps using the Percentage-Closer Filtering (PCF) algorithm with better soft shadows especially when using low-resolution shadow maps.

Filters shadow maps using the Percentage-Closer Filtering (PCF) algorithm with better soft shadows especially when using low-resolution shadow maps.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class PerspectiveCamera(var fov: Double, var aspect: Double, var near: Double, var far: Double) extends Camera

Camera that uses perspective projection.

Camera that uses perspective projection.

Attributes

Supertypes
class Camera
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
Known subtypes
class ArrayCamera
class Plane(var normal: UndefOr[Vector3], constant: UndefOr[Double]) extends Object

A class representing a plane in 3D space.

A class representing a plane in 3D space.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class PlaneGeometry(width: Double, height: Double, widthSegments: Int, heightSegments: Int) extends BufferGeometry

Class for generating plane geometries.

Class for generating plane geometries.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class PlaneHelper(var plane: Plane, var size: Double, var color: Double | Color | String) extends Line

A helper object to visualize an instance of [[Plane]].

A helper object to visualize an instance of [[Plane]].

Attributes

Example
 val plane  = new Plane(new Vector3(1, 1, 0.2), 3)
 val helper = new PlaneHelper(plane, 1, 0xffff00)
 scene.add(helper)
Companion
object
Supertypes
class Line
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object PlaneHelper extends Object

Companion object for PlaneHelper class

Companion object for PlaneHelper class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class PointLight(color: Int | String | Color, intensity: Double) extends Light

A light that gets emitted from a single point in all directions. A common use case for this is to replicate the light emitted from a bare lightbulb.

A light that gets emitted from a single point in all directions. A common use case for this is to replicate the light emitted from a bare lightbulb.

Attributes

Companion
object
Supertypes
class Light
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object PointLight

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
PointLight.type
class PointLightHelper(var light: PointLight, sphereSize: Double, color: Int | String | Color) extends Mesh

Helper object to assist with visualizing a [[PointLight]]'s position in the scene. This consists of a spherical wireframe mesh.

Helper object to assist with visualizing a [[PointLight]]'s position in the scene. This consists of a spherical wireframe mesh.

Attributes

Example
 val light = new PointLight(0xffffff, 1, 100)
 light.position.set(10, 10, 10)
 scene.add(light)
 val helper = new PointLightHelper(light, 1)
 scene.add(helper)
Companion
object
Supertypes
class Mesh
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object PointLightHelper extends Object

Companion object for PointLightHelper class

Companion object for PointLightHelper class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class PointLightShadow() extends LightShadow

Represents the shadow configuration of point lights.

Represents the shadow configuration of point lights.

Attributes

Companion
object
Supertypes
class LightShadow
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object PointLightShadow extends Object

Companion object for PointLightShadow with factory method

Companion object for PointLightShadow with factory method

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class PointerLockControls(camera: Camera, domElement: UndefOr[HTMLElement]) extends Object

PointerLockControls is a perfect choice for first person 3D games. The implementation of this class is based on the Pointer Lock API.

PointerLockControls is a perfect choice for first person 3D games. The implementation of this class is based on the Pointer Lock API.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class Points(var geometry: UndefOr[BufferGeometry], var material: UndefOr[Material | Array[Material]]) extends Object3D

A class for displaying points.

A class for displaying points.

Attributes

Companion
object
Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object Points extends Object

Companion object for Points with factory method.

Companion object for Points with factory method.

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
Points.type
class PointsMaterial(parameters: UndefOr[Object]) extends Material

A material for drawing points.

A material for drawing points.

Attributes

Companion
object
Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Companion object for PointsMaterial with factory methods.

Companion object for PointsMaterial with factory methods.

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type

Parameters for PointsMaterial.

Parameters for PointsMaterial.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
class PolarGridHelper(var radius: Double, var sectors: Double, var rings: Double, var divisions: Double, var color1: Double | Color | String, var color2: Double | Color | String) extends LineSegments

This helper is an object to define polar grids. Grids are two-dimensional arrays of lines.

This helper is an object to define polar grids. Grids are two-dimensional arrays of lines.

Attributes

Example
 val radius    = 10
 val sectors   = 16
 val rings     = 8
 val divisions = 64
 val helper = new PolarGridHelper(radius, sectors, rings, divisions)
 scene.add(helper)
Companion
object
Supertypes
class LineSegments
class Line
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object PolarGridHelper extends Object

Companion object for PolarGridHelper class

Companion object for PolarGridHelper class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class PolyhedronGeometry(vertices: Array[Double], indices: Array[Double], radius: Double, detail: Int) extends BufferGeometry

A class for generating a polyhedron geometry.

A class for generating a polyhedron geometry.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
Known subtypes
object PolyhedronGeometry extends Object

Companion object for PolyhedronGeometry with factory method.

Companion object for PolyhedronGeometry with factory method.

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class PositionalAudio(listener: AudioListener) extends Audio

Create a positional audio object. This uses the Web Audio API's PannerNode to create 3D spatial audio that changes based on the position of the listener and the audio source.

Create a positional audio object. This uses the Web Audio API's PannerNode to create 3D spatial audio that changes based on the position of the listener and the audio source.

Attributes

Supertypes
class Audio
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class Quaternion(var x: UndefOr[Double], var y: UndefOr[Double], var z: UndefOr[Double], var w: UndefOr[Double]) extends Object

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class QuaternionLinearInterpolant(parameterPositions: TypedArray[_, _], sampleValues: TypedArray[_, _], sampleSize: Int, resultBuffer: UndefOr[TypedArray[_, _]]) extends Interpolant

Quaternion Linear Interpolant.

Quaternion Linear Interpolant.

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

Attributes

Supertypes
class Interpolant
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class RawShaderMaterial(parameters: UndefOr[Object]) extends ShaderMaterial

This class works just like ShaderMaterial, except that definitions of built-in uniforms and attributes are not automatically prepended to the GLSL shader code.

This class works just like ShaderMaterial, except that definitions of built-in uniforms and attributes are not automatically prepended to the GLSL shader code.

Attributes

Companion
object
Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class Ray(var origin: UndefOr[Vector3], var direction: UndefOr[Vector3]) extends Object

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

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

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class Raycaster(var origin: UndefOr[Vector3], var direction: UndefOr[Vector3], var near: UndefOr[Double], var far: UndefOr[Double]) extends Object

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

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

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
trait RaycasterIntersection extends Object

The intersection point of a raycaster intersection test.

The intersection point of a raycaster intersection test.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class RectAreaLight(color: Int | String | Color, intensity: Double) extends Light

This class emits light uniformly across the face a rectangular plane. This light type can be used to simulate light sources such as bright windows or strip lighting.

This class emits light uniformly across the face a rectangular plane. This light type can be used to simulate light sources such as bright windows or strip lighting.

Attributes

Companion
object
Supertypes
class Light
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object RectAreaLight

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class Reflector(geometry: BufferGeometry, options: UndefOr[ReflectorOptions]) extends Mesh

Can be used to create a flat, reflective surface like a mirror.

Can be used to create a flat, reflective surface like a mirror.

Note that this class can only be used with WebGLRenderer. When using WebGPURenderer, use ReflectorNode.

Example:

val geometry = PlaneGeometry(100, 100)

val reflector = new Reflector(
 geometry,
 js.Dynamic.literal(
   clipBias = 0.003,
   textureWidth = window.innerWidth * window.devicePixelRatio,
   textureHeight = window.innerHeight * window.devicePixelRatio,
   color = 0xc1cbcb
 )
)

scene.add(reflector)

Attributes

Companion
object
Supertypes
class Mesh
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object Reflector extends Object

Companion object for Reflector with factory method.

Companion object for Reflector with factory method.

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
Reflector.type
trait ReflectorOptions extends Object

Constructor options for Reflector.

Constructor options for Reflector.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class Refractor(geometry: BufferGeometry, options: UndefOr[RefractorOptions]) extends Mesh

Can be used to create a flat, refractive surface like for special windows or water effects.

Can be used to create a flat, refractive surface like for special windows or water effects.

Note that this class can only be used with WebGLRenderer. When using WebGPURenderer, use viewportSharedTexture.

Example:

val geometry = PlaneGeometry(100, 100)

val refractor = new Refractor(
 geometry,
 js.Dynamic.literal(
   color = 0xcbcbcb,
   textureWidth = 1024,
   textureHeight = 1024
 )
)

scene.add(refractor)

Attributes

Companion
object
Supertypes
class Mesh
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object Refractor extends Object

Companion object for Refractor with factory method.

Companion object for Refractor with factory method.

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
Refractor.type
trait RefractorOptions extends Object

Constructor options for Refractor.

Constructor options for Refractor.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class RenderPass(scene: Scene, camera: Camera, overrideMaterial: UndefOr[Material], clearColor: UndefOr[Color], clearAlpha: UndefOr[Double]) extends EffectPass

Render pass that renders a scene to a render target

Render pass that renders a scene to a render target

Attributes

Companion
object
Supertypes
class EffectPass
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object RenderPass

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
RenderPass.type
class RingGeometry(innerRadius: Double, outerRadius: Double, thetaSegments: Int, phiSegments: Int, thetaStart: Double, thetaLength: Double) extends BufferGeometry

Class for generating ring geometries.

Class for generating ring geometries.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object SRGBToLinear extends Function1[Double, Double]

Converts color component from sRGB to linear space

Converts color component from sRGB to linear space

Attributes

Supertypes
trait Function1[Double, Double]
class Function
class Object
trait Any
class Object
trait Matchable
class Any
Show all
Self type
class SSAOPass(scene: Scene, camera: Camera, width: Double, height: Double, kernelSize: Double) extends EffectPass

SSAO (Screen Space Ambient Occlusion) pass for realistic ambient occlusion effects

SSAO (Screen Space Ambient Occlusion) pass for realistic ambient occlusion effects

Attributes

Companion
object
Supertypes
class EffectPass
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object SSAOPass

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
SSAOPass.type
class SSRPass(parameters: SSRPassParameters) extends EffectPass

SSR (Screen Space Reflections) pass for realistic reflections

SSR (Screen Space Reflections) pass for realistic reflections

Attributes

Companion
object
Supertypes
class EffectPass
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object SSRPass

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
SSRPass.type
trait SSRPassParameters extends Object

Parameters for SSRPass configuration

Parameters for SSRPass configuration

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
class SVGLoader(loadingManager: UndefOr[LoadingManager]) extends Object

Class for loading SVG files.

Class for loading SVG files.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
trait SVGPath extends Object

SVG path object containing path data.

SVG path object containing path data.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
trait SVGResult extends Object

SVG result object containing parsed paths.

SVG result object containing parsed paths.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class Scene extends Object3D

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

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

Attributes

Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class ShaderMaterial(parameters: UndefOr[Object]) extends Material

A material rendered with custom shaders. A shader is a small program written in GLSL that runs on the GPU. You may want to use a custom shader if you need to implement an effect not included with any of the built-in materials.

A material rendered with custom shaders. A shader is a small program written in GLSL that runs on the GPU. You may want to use a custom shader if you need to implement an effect not included with any of the built-in materials.

Attributes

Companion
object
Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all
Known subtypes

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class ShaderPass(shader: Object, textureID: UndefOr[String]) extends EffectPass

Shader pass that applies a custom shader to a texture

Shader pass that applies a custom shader to a texture

Attributes

Companion
object
Supertypes
class EffectPass
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object ShaderPass

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
ShaderPass.type
class ShadowMaterial(parameters: Object) extends Material

This material can receive shadows, but otherwise is completely transparent.

This material can receive shadows, but otherwise is completely transparent.

Attributes

Companion
object
Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Companion object for ShadowMaterial with factory method

Companion object for ShadowMaterial with factory method

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class Shape(points: Array[Vector2]) extends Object

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class ShapeGeometry(shapes: Any, curveSegments: Int) extends BufferGeometry

Class for generating shape geometries.

Class for generating shape geometries.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class Skeleton(var bones: Array[Bone], var boneInverses: Array[Matrix4]) extends Object

Class for representing the armatures in three.js. The skeleton is defined by a hierarchy of bones.

Class for representing the armatures in three.js. The skeleton is defined by a hierarchy of bones.

Example:

val bones = js.Array[Bone]()

val shoulder = new Bone()
val elbow    = new Bone()
val hand     = new Bone()

shoulder.add(elbow)
elbow.add(hand)

bones.push(shoulder, elbow, hand)

shoulder.position.y = -5
elbow.position.y = 0
hand.position.y = 5

val armSkeleton = new Skeleton(bones)

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
object Skeleton extends Object

Companion object for Skeleton with factory method.

Companion object for Skeleton with factory method.

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
Skeleton.type
class SkeletonHelper(`object`: Object3D) extends LineSegments

A helper object to assist with visualizing a Skeleton.

A helper object to assist with visualizing a Skeleton.

Attributes

Example
 val helper = new SkeletonHelper(skinnedMesh)
 scene.add(helper)
Companion
object
Supertypes
class LineSegments
class Line
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object SkeletonHelper extends Object

Companion object for SkeletonHelper class

Companion object for SkeletonHelper class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class SkinnedMesh(geo: UndefOr[BufferGeometry], mat: UndefOr[Material | Array[Material]]) extends Mesh

A mesh that has a Skeleton that can then be used to animate the vertices of the geometry with skinning/skeleton animation.

A mesh that has a Skeleton that can then be used to animate the vertices of the geometry with skinning/skeleton animation.

Next to a valid skeleton, the skinned mesh requires skin indices and weights as buffer attributes in its geometry. These attribute define which bones affect a single vertex to a certain extend.

Typically skinned meshes are not created manually but loaders like GLTFLoader or FBXLoader import respective models.

Attributes

Companion
object
Supertypes
class Mesh
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object SkinnedMesh extends Object

Companion object for SkinnedMesh with factory method.

Companion object for SkinnedMesh with factory method.

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class Sphere(var center: UndefOr[Vector3], var radius: UndefOr[Double]) extends Object

A class representing a sphere in 3D space.

A class representing a sphere in 3D space.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class SphereGeometry(radius: Double, widthSegments: Int, heightSegments: Int, phiStart: Double, phiLength: Double, thetaStart: Double, thetaLength: Double) extends BufferGeometry

Class for generating sphere geometries.

Class for generating sphere geometries.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class Spherical(var radius: UndefOr[Double], var phi: UndefOr[Double], var theta: UndefOr[Double]) extends Object

A class for spherical coordinates.

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).

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class SphericalHarmonics3 extends Object

A class for storing spherical harmonics.

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.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
object SphericalHarmonics3 extends Object

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class SpotLight(color: Int | String | Color, intensity: Double) extends Light

This light gets emitted from a single point in one direction, along a cone that increases in size the further from the light it gets.

This light gets emitted from a single point in one direction, along a cone that increases in size the further from the light it gets.

Attributes

Companion
object
Supertypes
class Light
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object SpotLight

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
SpotLight.type
class SpotLightHelper(var light: SpotLight, color: Int | String | Color) extends Object3D

Helper object to assist with visualizing a [[SpotLight]]'s effect on the scene. This consists of a cone representing the light's position and direction.

Helper object to assist with visualizing a [[SpotLight]]'s effect on the scene. This consists of a cone representing the light's position and direction.

Attributes

Example
 val light = new SpotLight(0xffffff)
 light.position.set(10, 10, 10)
 scene.add(light)
 val helper = new SpotLightHelper(light)
 scene.add(helper)
Companion
object
Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object SpotLightHelper extends Object

Companion object for SpotLightHelper class

Companion object for SpotLightHelper class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class SpotLightShadow() extends LightShadow

Represents the shadow configuration of spot lights.

Represents the shadow configuration of spot lights.

Attributes

Companion
object
Supertypes
class LightShadow
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object SpotLightShadow extends Object

Companion object for SpotLightShadow with factory method

Companion object for SpotLightShadow with factory method

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class Sprite(var material: UndefOr[SpriteMaterial]) extends Object3D

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.

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.

Attributes

Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class SpriteMaterial(parameters: UndefOr[Any]) extends Material

Materials for sprites.

Materials for sprites.

Attributes

Supertypes
class Material
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object StaticCopyUsage extends Object

The contents are intended to be specified once by reading data from the 3D API, and used many times as the source for WebGL drawing and image specification commands.

The contents are intended to be specified once by reading data from the 3D API, and used many times as the source for WebGL drawing and image specification commands.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object StaticDrawUsage extends Object

The contents are intended to be specified once by the application, and used many times as the source for drawing and image specification commands.

The contents are intended to be specified once by the application, and used many times as the source for drawing and image specification commands.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object StaticReadUsage extends Object

The contents are intended to be specified once by reading data from the 3D API, and queried many times by the application.

The contents are intended to be specified once by reading data from the 3D API, and queried many times by the application.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class StereoCamera extends Object

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 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.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
object StreamCopyUsage extends Object

The contents are intended to be specified once by reading data from the 3D API, and used at most a few times as the source for WebGL drawing and image specification commands.

The contents are intended to be specified once by reading data from the 3D API, and used at most a few times as the source for WebGL drawing and image specification commands.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object StreamDrawUsage extends Object

The contents are intended to be specified once by the application, and used at most a few times as the source for drawing and image specification commands.

The contents are intended to be specified once by the application, and used at most a few times as the source for drawing and image specification commands.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object StreamReadUsage extends Object

The contents are intended to be specified once by reading data from the 3D API, and queried at most a few times by the application

The contents are intended to be specified once by reading data from the 3D API, and queried at most a few times by the application

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
object TOUCH extends Object

Represents touch interaction types in context of controls.

Represents touch interaction types in context of controls.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
TOUCH.type
class TetrahedronGeometry(radius: Double, detail: Int) extends PolyhedronGeometry

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

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

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object TetrahedronGeometry extends Object

Companion object for TetrahedronGeometry with factory method.

Companion object for TetrahedronGeometry with factory method.

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class TextGeometry(text: String, parameters: Object) extends ExtrudeGeometry

A class for generating text as a single geometry. It is constructed by providing a string of text, and a set of parameters consisting of a loaded font and extrude settings.

A class for generating text as a single geometry. It is constructed by providing a string of text, and a set of parameters consisting of a loaded font and extrude settings.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object TextGeometry

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class Texture(var image: UndefOr[Any], var mapping: UndefOr[Int], var wrapS: UndefOr[Int], var wrapT: UndefOr[Int], var magFilter: UndefOr[Int], var minFilter: UndefOr[Int], var format: UndefOr[Int], `type`: UndefOr[Int], var anisotropy: UndefOr[Int], var colorSpace: UndefOr[String]) extends Object

Base class for textures in THREE.js.

Base class for textures in THREE.js.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Known subtypes
class TextureLoader(loadingManager: UndefOr[LoadingManager]) extends Object

Class for loading a texture.

Class for loading a texture.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
object TimestampQuery extends Object

Represents the different timestamp query types.

Represents the different timestamp query types.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class TorusGeometry(radius: Double, tube: Double, radialSegments: Int, tubularSegments: Int, arc: Double) extends BufferGeometry

Class for generating torus geometries.

Class for generating torus geometries.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class TrackballControls(camera: Camera, domElement: UndefOr[Element]) extends Object

This class is similar to [[OrbitControls]]. However, it does not maintain a constant camera up vector. That means if the camera orbits over the "north" and "south" poles, it does not flip to stay "right side up".

This class is similar to [[OrbitControls]]. However, it does not maintain a constant camera up vector. That means if the camera orbits over the "north" and "south" poles, it does not flip to stay "right side up".

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class TransformControls(camera: Camera, domElement: Element) extends Object

This class can be used to transform objects in 3D space by adapting a similar interaction model of DCC tools like Blender. Unlike other controls, it is not intended to transform the scene's camera.

This class can be used to transform objects in 3D space by adapting a similar interaction model of DCC tools like Blender. Unlike other controls, it is not intended to transform the scene's camera.

TransformControls expects that its attached 3D object is part of the scene graph.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type

The gizmo component of the TransformControls.

The gizmo component of the TransformControls.

Attributes

Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all

The plane component of the TransformControls.

The plane component of the TransformControls.

Attributes

Supertypes
class Mesh
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all

The visual representation of the TransformControls.

The visual representation of the TransformControls.

Attributes

Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class Triangle(var a: UndefOr[Vector3], var b: UndefOr[Vector3], var c: UndefOr[Vector3]) extends Object

A class representing a triangle in 3D space.

A class representing a triangle in 3D space.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
object Triangle extends Object

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
Triangle.type
class UnrealBloomPass(resolution: Vector2, strength: Double, radius: Double, threshold: Double) extends EffectPass

Unreal Bloom pass that creates realistic bloom effect with threshold and intensity controls

Unreal Bloom pass that creates realistic bloom effect with threshold and intensity controls

Attributes

Companion
object
Supertypes
class EffectPass
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object VSMShadowMap extends Object

Filters shadow maps using the Variance Shadow Map (VSM) algorithm. When using VSMShadowMap all shadow receivers will also cast shadows.

Filters shadow maps using the Variance Shadow Map (VSM) algorithm. When using VSMShadowMap all shadow receivers will also cast shadows.

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class Vector2(var x: UndefOr[Double], var y: UndefOr[Double]) extends Object

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class Vector3(var x: UndefOr[Double], var y: UndefOr[Double], var z: UndefOr[Double]) extends Object

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class Vector4(var x: UndefOr[Double], var y: UndefOr[Double], var z: UndefOr[Double], var w: UndefOr[Double]) extends Object

Class representing a 4D vector.

Class representing a 4D vector.

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

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class VertexNormalsHelper(`object`: Object3D, var size: Double, var color: Double | Color | String) extends LineSegments

Visualizes an object's vertex normals.

Visualizes an object's vertex normals.

Requires that normals have been specified in the geometry as a buffer attribute or have been calculated using BufferGeometry#computeVertexNormals.

Attributes

Example
 val geometry = new BoxGeometry(10, 10, 10, 2, 2, 2)
 val material = new MeshStandardMaterial()
 val mesh     = new Mesh(geometry, material)
 scene.add(mesh)
 val helper = new VertexNormalsHelper(mesh, 1, 0xff0000)
 scene.add(helper)
Companion
object
Supertypes
class LineSegments
class Line
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
object VertexNormalsHelper extends Object

Companion object for VertexNormalsHelper class

Companion object for VertexNormalsHelper class

Attributes

Companion
class
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Self type
class VideoTexture(video: Video, mapping: UndefOr[Int], wrapS: UndefOr[Int], wrapT: UndefOr[Int], magFilter: UndefOr[Int], minFilter: UndefOr[Int], format: UndefOr[Int], `type`: UndefOr[Int], anisotropy: UndefOr[Int]) extends Texture

Creates a texture for use with a video.

Creates a texture for use with a video.

Attributes

Supertypes
class Texture
class Object
trait Any
class Object
trait Matchable
class Any
Show all
class Water(geometry: BufferGeometry, options: UndefOr[WaterOptions]) extends Mesh

A basic flat, reflective water effect.

A basic flat, reflective water effect.

Note that this class can only be used with WebGLRenderer. When using WebGPURenderer, use WaterMesh.

Attributes

Supertypes
class Mesh
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all
trait WaterOptions extends Object

Constructor options for Water.

Constructor options for Water.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
object WaterOptions

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
class WebGL2Renderer(parameters: Object) extends WebGLRenderer

The WebGL2 renderer displays your scenes using WebGL 2.0. It extends WebGLRenderer with WebGL 2.0 specific features.

The WebGL2 renderer displays your scenes using WebGL 2.0. It extends WebGLRenderer with WebGL 2.0 specific features.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class WebGLCubeRenderTarget(size: Double, options: UndefOr[WebGLRenderTargetOptions]) extends WebGLRenderTarget

A cube render target used in context of WebGLRenderer for cube map rendering. This is useful for creating dynamic cube maps for reflections, environment mapping, etc.

A cube render target used in context of WebGLRenderer for cube map rendering. This is useful for creating dynamic cube maps for reflections, environment mapping, etc.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class WebGLMultipleRenderTargets(width: Double, height: Double, count: Double, options: UndefOr[WebGLRenderTargetOptions]) extends WebGLRenderTarget

WebGLMultipleRenderTargets provides multiple render targets functionality. This is essentially a WebGLRenderTarget with count > 1 for multiple color attachments.

WebGLMultipleRenderTargets provides multiple render targets functionality. This is essentially a WebGLRenderTarget with count > 1 for multiple color attachments.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class WebGLRenderTarget(options: UndefOr[WebGLRenderTargetOptions]) extends Object

WebGL render target for off-screen rendering

WebGL render target for off-screen rendering

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Known subtypes

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
trait WebGLRenderTargetOptions extends Object

Attributes

Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
class WebGLRenderer(parameters: UndefOr[Object]) extends Object

The WebGL renderer displays your scenes using WebGL.

The WebGL renderer displays your scenes using WebGL.

Attributes

Companion
object
Supertypes
class Object
trait Any
class Object
trait Matchable
class Any
Known subtypes
object WebGLRenderer

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type

Value members

Concrete fields

ACES Filmic tone mapping.

ACES Filmic tone mapping.

Attributes

val AddEquation: Int

A source + destination blending equation.

A source + destination blending equation.

Attributes

val AddOperation: Int

Adds the two colors.

Adds the two colors.

Attributes

Additive animation blend mode.

Additive animation blend mode.

Attributes

val AdditiveBlending: Int

Represents additive blending.

Represents additive blending.

Attributes

val AgXToneMapping: Int

AgX tone mapping.

AgX tone mapping.

Attributes

val AlphaFormat: Int

Discards the red, green and blue components and reads just the alpha component.

Discards the red, green and blue components and reads just the alpha component.

Attributes

val AlwaysCompare: Int

Always pass.

Always pass.

Attributes

val AttachedBindMode: String

The skinned mesh shares the same world space as the skeleton.

The skinned mesh shares the same world space as the skeleton.

Attributes

val BackSide: Int

Only back faces are rendered.

Only back faces are rendered.

Attributes

Basic depth packing.

Basic depth packing.

Attributes

val ByteType: Int

A byte data type for textures.

A byte data type for textures.

Attributes

Cineon tone mapping.

Cineon tone mapping.

Attributes

The last pixel of the texture stretches to the edge of the mesh.

The last pixel of the texture stretches to the edge of the mesh.

Attributes

Multiplies all colors by a constant alpha value.

Multiplies all colors by a constant alpha value.

Attributes

Multiplies all colors by a constant color.

Multiplies all colors by a constant color.

Attributes

Reflection mapping for cube textures.

Reflection mapping for cube textures.

Attributes

Refraction mapping for cube textures.

Refraction mapping for cube textures.

Attributes

Reflection mapping for PMREM textures.

Reflection mapping for PMREM textures.

Attributes

val CustomBlending: Int

Represents custom blending.

Represents custom blending.

Attributes

Custom tone mapping. Expects a custom implementation by modifying shader code of the material's fragment shader.

Custom tone mapping. Expects a custom implementation by modifying shader code of the material's fragment shader.

Attributes

Decrements the current stencil buffer value. Clamps to 0.

Decrements the current stencil buffer value. Clamps to 0.

Attributes

Decrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable unsigned value when decrementing a stencil buffer value of 0.

Decrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable unsigned value when decrementing a stencil buffer value of 0.

Attributes

val DepthFormat: Int

Reads each element as a single depth value, converts it to floating point, and clamps to the range [0,1].

Reads each element as a single depth value, converts it to floating point, and clamps to the range [0,1].

Attributes

Reads each element is a pair of depth and stencil values. The depth component of the pair is interpreted as in DepthFormat. The stencil component is interpreted based on the depth + stencil internal format.

Reads each element is a pair of depth and stencil values. The depth component of the pair is interpreted as in DepthFormat. The stencil component is interpreted based on the depth + stencil internal format.

Attributes

val DetachedBindMode: String

The skinned mesh does not share the same world space as the skeleton. This is useful when a skeleton is shared across multiple skinned meshes.

The skinned mesh does not share the same world space as the skeleton. This is useful when a skeleton is shared across multiple skinned meshes.

Attributes

val DoubleSide: Int

Both front and back faces are rendered.

Both front and back faces are rendered.

Attributes

val DstAlphaFactor: Int

Multiplies all colors by the destination alpha value.

Multiplies all colors by the destination alpha value.

Attributes

val DstColorFactor: Int

Multiplies all colors by the destination color.

Multiplies all colors by the destination color.

Attributes

val EqualCompare: Int

Pass if the incoming value equals the texture value.

Pass if the incoming value equals the texture value.

Attributes

Reflection mapping for equirectangular textures.

Reflection mapping for equirectangular textures.

Attributes

Refraction mapping for equirectangular textures.

Refraction mapping for equirectangular textures.

Attributes

val FloatType: Int

A float data type for textures.

A float data type for textures.

Attributes

val FrontSide: Int

Only front faces are rendered.

Only front faces are rendered.

Attributes

val GLSL1: String

GLSL 1 shader code.

GLSL 1 shader code.

Attributes

val GLSL3: String

GLSL 3 shader code.

GLSL 3 shader code.

Attributes

val GreaterCompare: Int

Pass if the incoming value is greater than the texture value.

Pass if the incoming value is greater than the texture value.

Attributes

Pass if the incoming value is greater than or equal to the texture value.

Pass if the incoming value is greater than or equal to the texture value.

Attributes

val HalfFloatType: Int

A half float data type for textures.

A half float data type for textures.

Attributes

Increments the current stencil buffer value. Clamps to the maximum representable unsigned value.

Increments the current stencil buffer value. Clamps to the maximum representable unsigned value.

Attributes

Increments the current stencil buffer value. Wraps stencil buffer value to zero when incrementing the maximum representable unsigned value.

Increments the current stencil buffer value. Wraps stencil buffer value to zero when incrementing the maximum representable unsigned value.

Attributes

val IntType: Int

An int data type for textures.

An int data type for textures.

Attributes

val InvertStencilOp: Int

Inverts the current stencil buffer value bitwise.

Inverts the current stencil buffer value bitwise.

Attributes

val KeepStencilOp: Int

Keeps the current value.

Keeps the current value.

Attributes

val LessCompare: Int

Pass if the incoming value is less than the texture value.

Pass if the incoming value is less than the texture value.

Attributes

val LessEqualCompare: Int

Pass if the incoming value is less than or equal to the texture value.

Pass if the incoming value is less than or equal to the texture value.

Attributes

val LinearFilter: Int

Returns the weighted average of the four texture elements that are closest to the specified texture coordinates, and can include items wrapped or repeated from other parts of a texture, depending on the values of wrapS and wrapT, and on the exact mapping.

Returns the weighted average of the four texture elements that are closest to the specified texture coordinates, and can include items wrapped or repeated from other parts of a texture, depending on the values of wrapS and wrapT, and on the exact mapping.

Attributes

Chooses the two mipmaps that most closely match the size of the pixel being textured and uses the LinearFilter criterion to produce a texture value from each mipmap. The final texture value is a weighted average of those two values.

Chooses the two mipmaps that most closely match the size of the pixel being textured and uses the LinearFilter criterion to produce a texture value from each mipmap. The final texture value is a weighted average of those two values.

Attributes

Chooses the mipmap that most closely matches the size of the pixel being textured and uses the LinearFilter criterion (a weighted average of the four texels that are closest to the center of the pixel) to produce a texture value.

Chooses the mipmap that most closely matches the size of the pixel being textured and uses the LinearFilter criterion (a weighted average of the four texels that are closest to the center of the pixel) to produce a texture value.

Attributes

val LinearSRGBColorSpace: String

Linear tone mapping.

Linear tone mapping.

Attributes

val LinearTransfer: String
val LoopOnce: Int

Loop once mode.

Loop once mode.

Attributes

val LoopPingPong: Int

Loop ping pong mode.

Loop ping pong mode.

Attributes

val LoopRepeat: Int

Loop repeat mode.

Loop repeat mode.

Attributes

val MaxEquation: Int

A blend equation that uses the maximum of source and destination.

A blend equation that uses the maximum of source and destination.

Attributes

val MinEquation: Int

A blend equation that uses the minimum of source and destination.

A blend equation that uses the minimum of source and destination.

Attributes

The texture will repeats to infinity, mirroring on each repeat.

The texture will repeats to infinity, mirroring on each repeat.

Attributes

val MixOperation: Int

Uses reflectivity to blend between the two colors.

Uses reflectivity to blend between the two colors.

Attributes

val MultiplyBlending: Int

Represents multiply blending.

Represents multiply blending.

Attributes

Multiplies the environment map color with the surface color.

Multiplies the environment map color with the surface color.

Attributes

val NearestFilter: Int

Returns the value of the texture element that is nearest (in Manhattan distance) to the specified texture coordinates.

Returns the value of the texture element that is nearest (in Manhattan distance) to the specified texture coordinates.

Attributes

Chooses the two mipmaps that most closely match the size of the pixel being textured and uses the NearestFilter criterion to produce a texture value from each mipmap. The final texture value is a weighted average of those two values.

Chooses the two mipmaps that most closely match the size of the pixel being textured and uses the NearestFilter criterion to produce a texture value from each mipmap. The final texture value is a weighted average of those two values.

Attributes

Chooses the mipmap that most closely matches the size of the pixel being textured and uses the NearestFilter criterion (the texel nearest to the center of the pixel) to produce a texture value.

Chooses the mipmap that most closely matches the size of the pixel being textured and uses the NearestFilter criterion (the texel nearest to the center of the pixel) to produce a texture value.

Attributes

Neutral tone mapping. Implementation based on the Khronos 3D Commerce Group standard tone mapping.

Neutral tone mapping. Implementation based on the Khronos 3D Commerce Group standard tone mapping.

Attributes

val NeverCompare: Int

Never pass.

Never pass.

Attributes

val NoBlending: Int

No blending is performed which effectively disables alpha transparency.

No blending is performed which effectively disables alpha transparency.

Attributes

val NoColorSpace: String
val NoToneMapping: Int

No tone mapping is applied.

No tone mapping is applied.

Attributes

Normal animation blend mode.

Normal animation blend mode.

Attributes

val NormalBlending: Int

The default blending.

The default blending.

Attributes

val NotEqualCompare: Int

Pass if the incoming value is not equal to the texture value.

Pass if the incoming value is not equal to the texture value.

Attributes

Normal information is relative to the object orientation.

Normal information is relative to the object orientation.

Attributes

val OneFactor: Int

Multiplies all colors by 1.

Multiplies all colors by 1.

Attributes

Multiplies all colors by 1 minus a constant alpha value.

Multiplies all colors by 1 minus a constant alpha value.

Attributes

Multiplies all colors by 1 minus a constant color.

Multiplies all colors by 1 minus a constant color.

Attributes

Multiplies all colors by 1 minus the destination alpha value.

Multiplies all colors by 1 minus the destination alpha value.

Attributes

Multiplies all colors by 1 minus each destination color.

Multiplies all colors by 1 minus each destination color.

Attributes

Multiplies all colors by 1 minus the source alpha value.

Multiplies all colors by 1 minus the source alpha value.

Attributes

Multiplies all colors by 1 minus each source color.

Multiplies all colors by 1 minus each source color.

Attributes

RGTC2 Red Green format.

RGTC2 Red Green format.

Attributes

val RED_RGTC1_Format: Int

RGTC1 Red format.

RGTC1 Red format.

Attributes

val REVISION: Int

The current version of three.js as a string.

The current version of three.js as a string.

Attributes

val RGBADepthPacking: Int

A depth value is packed into 32 bit RGBA.

A depth value is packed into 32 bit RGBA.

Attributes

val RGBAFormat: Int

Reads the red, green, blue and alpha components.

Reads the red, green, blue and alpha components.

Attributes

Reads the red, green, blue and alpha components. The texels are read as integers instead of floating point.

Reads the red, green, blue and alpha components. The texels are read as integers instead of floating point.

Attributes

ASTC RGBA 10x10 format.

ASTC RGBA 10x10 format.

Attributes

ASTC RGBA 10x5 format.

ASTC RGBA 10x5 format.

Attributes

ASTC RGBA 10x6 format.

ASTC RGBA 10x6 format.

Attributes

ASTC RGBA 10x8 format.

ASTC RGBA 10x8 format.

Attributes

ASTC RGBA 12x10 format.

ASTC RGBA 12x10 format.

Attributes

ASTC RGBA 12x12 format.

ASTC RGBA 12x12 format.

Attributes

ASTC RGBA 4x4 format.

ASTC RGBA 4x4 format.

Attributes

ASTC RGBA 5x4 format.

ASTC RGBA 5x4 format.

Attributes

ASTC RGBA 5x5 format.

ASTC RGBA 5x5 format.

Attributes

ASTC RGBA 6x5 format.

ASTC RGBA 6x5 format.

Attributes

ASTC RGBA 6x6 format.

ASTC RGBA 6x6 format.

Attributes

ASTC RGBA 8x5 format.

ASTC RGBA 8x5 format.

Attributes

ASTC RGBA 8x6 format.

ASTC RGBA 8x6 format.

Attributes

ASTC RGBA 8x8 format.

ASTC RGBA 8x8 format.

Attributes

val RGBA_BPTC_Format: Int

BPTC RGBA format.

BPTC RGBA format.

Attributes

ETC2 RGBA format.

ETC2 RGBA format.

Attributes

PVRTC RGBA compression in 2-bit mode. One block for each 8×4 pixels.

PVRTC RGBA compression in 2-bit mode. One block for each 8×4 pixels.

Attributes

PVRTC RGBA compression in 4-bit mode. One block for each 4×4 pixels.

PVRTC RGBA compression in 4-bit mode. One block for each 4×4 pixels.

Attributes

A DXT1-compressed image in an RGB image format with a simple on/off alpha value.

A DXT1-compressed image in an RGB image format with a simple on/off alpha value.

Attributes

A DXT3-compressed image in an RGBA image format. Compared to a 32-bit RGBA texture, it offers 4:1 compression.

A DXT3-compressed image in an RGBA image format. Compared to a 32-bit RGBA texture, it offers 4:1 compression.

Attributes

A DXT5-compressed image in an RGBA image format. It also provides a 4:1 compression, but differs to the DXT3 compression in how the alpha compression is done.

A DXT5-compressed image in an RGBA image format. It also provides a 4:1 compression, but differs to the DXT3 compression in how the alpha compression is done.

Attributes

val RGBDepthPacking: Int

A depth value is packed into 24 bit RGB.

A depth value is packed into 24 bit RGB.

Attributes

val RGBFormat: Int

Discards the alpha component and reads the red, green and blue component.

Discards the alpha component and reads the red, green and blue component.

Attributes

val RGBIntegerFormat: Int

Discards the alpha component and reads the red, green and blue component. The texels are read as integers instead of floating point.

Discards the alpha component and reads the red, green and blue component. The texels are read as integers instead of floating point.

Attributes

BPTC Signed RGB format.

BPTC Signed RGB format.

Attributes

BPTC Unsigned RGB format.

BPTC Unsigned RGB format.

Attributes

val RGB_ETC1_Format: Int

ETC1 RGB format.

ETC1 RGB format.

Attributes

val RGB_ETC2_Format: Int

ETC2 RGB format.

ETC2 RGB format.

Attributes

PVRTC RGB compression in 2-bit mode. One block for each 8×4 pixels.

PVRTC RGB compression in 2-bit mode. One block for each 8×4 pixels.

Attributes

PVRTC RGB compression in 4-bit mode. One block for each 4×4 pixels.

PVRTC RGB compression in 4-bit mode. One block for each 4×4 pixels.

Attributes

A DXT1-compressed image in an RGB image format.

A DXT1-compressed image in an RGB image format.

Attributes

val RGDepthPacking: Int

A depth value is packed into 16 bit RG.

A depth value is packed into 16 bit RG.

Attributes

val RGFormat: Int

Discards the alpha, and blue components and reads the red, and green components.

Discards the alpha, and blue components and reads the red, and green components.

Attributes

val RGIntegerFormat: Int

Discards the alpha, and blue components and reads the red, and green components. The texels are read as integers instead of floating point.

Discards the alpha, and blue components and reads the red, and green components. The texels are read as integers instead of floating point.

Attributes

val RedFormat: Int

Discards the green, blue and alpha components and reads just the red component.

Discards the green, blue and alpha components and reads just the red component.

Attributes

val RedIntegerFormat: Int

Discards the green, blue and alpha components and reads just the red component. The texels are read as integers instead of floating point.

Discards the green, blue and alpha components and reads just the red component. The texels are read as integers instead of floating point.

Attributes

Reinhard tone mapping.

Reinhard tone mapping.

Attributes

val RepeatWrapping: Int

The texture will simply repeat to infinity.

The texture will simply repeat to infinity.

Attributes

val ReplaceStencilOp: Int

Sets the stencil buffer value to the specified reference value.

Sets the stencil buffer value to the specified reference value.

Attributes

A destination - source blending equation.

A destination - source blending equation.

Attributes

RGTC2 Signed Red Green format.

RGTC2 Signed Red Green format.

Attributes

RGTC1 Signed Red format.

RGTC1 Signed Red format.

Attributes

val SRGBColorSpace: String
val SRGBTransfer: String
val ShortType: Int

A short data type for textures.

A short data type for textures.

Attributes

val SrcAlphaFactor: Int

Multiplies all colors by the source alpha value.

Multiplies all colors by the source alpha value.

Attributes

Multiplies the RGB colors by the smaller of either the source alpha value or the value of 1 minus the destination alpha value. The alpha value is multiplied by 1.

Multiplies the RGB colors by the smaller of either the source alpha value or the value of 1 minus the destination alpha value. The alpha value is multiplied by 1.

Attributes

val SrcColorFactor: Int

Multiplies all colors by the source colors.

Multiplies all colors by the source colors.

Attributes

val SubtractEquation: Int

A source - destination blending equation.

A source - destination blending equation.

Attributes

Represents subtractive blending.

Represents subtractive blending.

Attributes

Normal information is relative to the underlying surface.

Normal information is relative to the underlying surface.

Attributes

For each vertex draw a triangle from the first vertex and the last two vertices.

For each vertex draw a triangle from the first vertex and the last two vertices.

Attributes

For each vertex draw a triangle from the last three vertices.

For each vertex draw a triangle from the last three vertices.

Attributes

For every three vertices draw a single triangle.

For every three vertices draw a single triangle.

Attributes

val UVMapping: Int

Maps textures using the geometry's UV coordinates.

Maps textures using the geometry's UV coordinates.

Attributes

val UnsignedByteType: Int

An unsigned byte data type for textures.

An unsigned byte data type for textures.

Attributes

An unsigned int 10_11_11 (packed) data type for textures.

An unsigned int 10_11_11 (packed) data type for textures.

Attributes

An unsigned int 24_8 data type for textures.

An unsigned int 24_8 data type for textures.

Attributes

An unsigned int 5_9_9_9 (packed) data type for textures.

An unsigned int 5_9_9_9 (packed) data type for textures.

Attributes

val UnsignedIntType: Int

An unsigned int data type for textures.

An unsigned int data type for textures.

Attributes

An unsigned short 4_4_4_4 (packed) data type for textures.

An unsigned short 4_4_4_4 (packed) data type for textures.

Attributes

An unsigned short 5_5_5_1 (packed) data type for textures.

An unsigned short 5_5_5_1 (packed) data type for textures.

Attributes

An unsigned short data type for textures.

An unsigned short data type for textures.

Attributes

WebGL coordinate system.

WebGL coordinate system.

Attributes

WebGPU coordinate system.

WebGPU coordinate system.

Attributes

val WrapAroundEnding: Int

Wrap around ending for animations.

Wrap around ending for animations.

Attributes

Zero curvature ending for animations.

Zero curvature ending for animations.

Attributes

val ZeroFactor: Int

Multiplies all colors by 0.

Multiplies all colors by 0.

Attributes

val ZeroSlopeEnding: Int

Zero slope ending for animations.

Zero slope ending for animations.

Attributes

val ZeroStencilOp: Int

Sets the stencil buffer value to 0.

Sets the stencil buffer value to 0.

Attributes