Light2D

Defined in: packages/three-flatland/src/lights/Light2D.ts:115

2D Light for use with Flatland.

Light2D is a scene graph object that can be added to Flatland and automatically collected for use in sprite lighting.

Example

// Point light (torch, lamp)
const torch = new Light2D({
  type: 'point',
  position: [100, 100],
  color: 'orange',
  intensity: 1.5,
  distance: 200,
})
flatland.add(torch)

// Directional light (sun)
const sun = new Light2D({
  type: 'directional',
  direction: [1, -1],
  color: 0xffffcc,
  intensity: 0.8,
})
flatland.add(sun)

// Ambient light (base illumination)
const ambient = new Light2D({
  type: 'ambient',
  color: 0x222233,
  intensity: 0.3,
})
flatland.add(ambient)

Extends

• Object3D 

Constructors

Constructor

new Light2D(options?): Light2D

Defined in: packages/three-flatland/src/lights/Light2D.ts:202

Parameters

options?

Light2DOptions = {}

Returns

Light2D

Overrides

Object3D.constructor

Properties

angle

angle: number

Defined in: packages/three-flatland/src/lights/Light2D.ts:151

Cone angle for spot lights (radians).

---

animations

animations: AnimationClip []

Defined in: three.js/core/Object3D:animations 

Array with object’s animation clips.

Default Value

[]

Inherited from

Object3D.animations

---

castShadow

castShadow: boolean

Defined in: three.js/core/Object3D:castShadow 

Whether the object gets rendered into shadow map.

Default Value

false

Inherited from

Object3D.castShadow

---

castsShadow

castsShadow: boolean = true

Defined in: packages/three-flatland/src/lights/Light2D.ts:176

Whether this light casts shadows. When false, the shader skips the SDF shadow trace for this light — useful for cosmetic/atmospheric lights (slime glows, ambient fills) that don’t need occlusion.

Currently only respected by DefaultLightEffect.

---

children

children: Object3D <Object3DEventMap >[]

Defined in: three.js/core/Object3D:children 

Array with object’s children.

See

THREE.Object3DGroup | Group for info on manually grouping objects.

Default Value

[]

Inherited from

Object3D.children

---

count?

optional count?: number

Defined in: three.js/renderers/common/Backend:count 

Inherited from

Object3D.count

---

customDepthMaterial?

optional customDepthMaterial?: Material <MaterialEventMap >

Defined in: three.js/core/Object3D:customDepthMaterial 

Custom depth material to be used when rendering to the depth map.

Remarks

Can only be used in context of meshes. When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight, if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

Default Value

undefined

Inherited from

Object3D.customDepthMaterial

---

customDistanceMaterial?

optional customDistanceMaterial?: Material <MaterialEventMap >

Defined in: three.js/core/Object3D:customDistanceMaterial 

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

Default Value

undefined

Inherited from

Object3D.customDistanceMaterial

---

decay

decay: number

Defined in: packages/three-flatland/src/lights/Light2D.ts:162

Decay exponent controlling attenuation curve shape. 1 = linear, 2 = quadratic (default), higher = sharper center.

---

distance

distance: number

Defined in: packages/three-flatland/src/lights/Light2D.ts:146

Maximum light distance for point/spot lights. 0 = no cutoff (infinite range). The lighting system will determine an effective max distance for culling purposes.

---

enabled

enabled: boolean = true

Defined in: packages/three-flatland/src/lights/Light2D.ts:167

Whether this light is enabled.

---

frustumCulled

frustumCulled: boolean

Defined in: three.js/core/Object3D:frustumCulled 

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object. If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

Default Value

true

Inherited from

Object3D.frustumCulled

---

id

readonly id: number

Defined in: three.js/core/Object3D:id 

Unique number for this Object3D  instance.

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, …, incrementing by one for each new object. Expects a Integer

Inherited from

Object3D.id

---

importance

importance: number = 1

Defined in: packages/three-flatland/src/lights/Light2D.ts:183

Multiplicative bias applied to this light’s tile-ranking score during Forward+ tile assignment. See Light2DOptions.importance for full semantics. Default 1.0 — neutral.

---

intensity

intensity: number

Defined in: packages/three-flatland/src/lights/Light2D.ts:134

Light intensity.

---

isObject3D

readonly isObject3D: true

Defined in: three.js/core/Object3D:isObject3D 

Flag to check if a given object is of type Object3D .

Remarks

This is a constant value

Default Value

true

Inherited from

Object3D.isObject3D

---

layers

layers: Layers 

Defined in: three.js/core/Object3D:layers 

The layer membership of the object.

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use. This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

Default Value

new THREE.Layers()

Inherited from

Object3D.layers

---

lightType

lightType: Light2DType

Defined in: packages/three-flatland/src/lights/Light2D.ts:124

Light type.

---

matrix

matrix: Matrix4 

Defined in: three.js/core/Object3D:matrix 

The local transform matrix.

Default Value

new THREE.Matrix4()

Inherited from

Object3D.matrix

---

matrixAutoUpdate

matrixAutoUpdate: boolean

Defined in: three.js/core/Object3D:matrixAutoUpdate 

When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property.

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

Inherited from

Object3D.matrixAutoUpdate

---

matrixWorld

matrixWorld: Matrix4 

Defined in: three.js/core/Object3D:matrixWorld 

The global transform of the object.

Remarks

If the Object3D  has no parent, then it’s identical to the local transform THREE.Object3D.matrix | .matrix.

Default Value

new THREE.Matrix4()

Inherited from

Object3D.matrixWorld

---

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

Defined in: three.js/core/Object3D:matrixWorldAutoUpdate 

If set, then the renderer checks every frame if the object and its children need matrix updates. When it isn’t, then you have to maintain all matrices in the object and its children yourself.

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

Inherited from

Object3D.matrixWorldAutoUpdate

---

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

Defined in: three.js/core/Object3D:matrixWorldNeedsUpdate 

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

Default Value

false

Inherited from

Object3D.matrixWorldNeedsUpdate

---

modelViewMatrix

readonly modelViewMatrix: Matrix4 

Defined in: three.js/core/Object3D:modelViewMatrix 

Default Value

new THREE.Matrix4()

Inherited from

Object3D.modelViewMatrix

---

name

name: string

Defined in: three.js/core/Object3D:name 

Optional name of the object

Remarks

(doesn’t need to be unique).

Default Value

""

Inherited from

Object3D.name

---

normalMatrix

readonly normalMatrix: Matrix3 

Defined in: three.js/core/Object3D:normalMatrix 

Default Value

new THREE.Matrix3()

Inherited from

Object3D.normalMatrix

---

occlusionTest?

optional occlusionTest?: boolean

Defined in: three.js/renderers/common/Backend:occlusionTest 

Inherited from

Object3D.occlusionTest

---

parent

parent: Object3D <Object3DEventMap > | null

Defined in: three.js/core/Object3D:parent 

Object’s parent in the scene graph .

Remarks

An object can have at most one parent.

Default Value

null

Inherited from

Object3D.parent

---

penumbra

penumbra: number

Defined in: packages/three-flatland/src/lights/Light2D.ts:156

Penumbra for spot lights (0-1).

---

pivot

pivot: Vector3  | null

Defined in: three.js/core/Object3D:pivot 

The pivot point for rotation and scale transformations. When set, rotation and scale are applied around this point instead of the object’s origin.

Default

null

Inherited from

Object3D.pivot

---

position

readonly position: Vector3 

Defined in: three.js/core/Object3D:position 

Object’s local position.

Default Value

new THREE.Vector3() - that is (0, 0, 0).

Inherited from

Object3D.position

---

quaternion

readonly quaternion: Quaternion 

Defined in: three.js/core/Object3D:quaternion 

Object’s local rotation as a THREE.Quaternion | Quaternion.

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

Inherited from

Object3D.quaternion

---

receiveShadow

receiveShadow: boolean

Defined in: three.js/core/Object3D:receiveShadow 

Whether the material receives shadows.

Default Value

false

Inherited from

Object3D.receiveShadow

---

renderOrder

renderOrder: number

Defined in: three.js/core/Object3D:renderOrder 

This value allows the default rendering order of scene graph  objects to be overridden although opaque and transparent objects remain sorted independently.

Remarks

When this property is set for an instance of Group , all descendants objects will be sorted and rendered together. Sorting is from lowest to highest renderOrder.

Default Value

0

Inherited from

Object3D.renderOrder

---

rotation

readonly rotation: Euler 

Defined in: three.js/core/Object3D:rotation 

Object’s local rotation (Euler angles ), in radians.

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

Inherited from

Object3D.rotation

---

scale

readonly scale: Vector3 

Defined in: three.js/core/Object3D:scale 

The object’s local scale.

Default Value

new THREE.Vector3( 1, 1, 1 )

Inherited from

Object3D.scale

---

static

static: boolean

Defined in: three.js/core/Object3D:static 

Whether the 3D object is supposed to be static or not. If set to true, it means the 3D object is not going to be changed after the initial renderer. This includes geometry and material settings. A static 3D object can be processed by the renderer slightly faster since certain state checks can be bypassed.

Only relevant in context of WebGPURenderer.

Default

false

Inherited from

Object3D.static

---

type

readonly type: "Light2D" = 'Light2D'

Defined in: packages/three-flatland/src/lights/Light2D.ts:119

Type identifier for Three.js.

Overrides

Object3D.type

---

up

up: Vector3 

Defined in: three.js/core/Object3D:up 

This is used by the lookAt  method, for example, to determine the orientation of the result.

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

Inherited from

Object3D.up

---

userData

userData: Record<string, any>

Defined in: three.js/core/Object3D:userData 

An object that can be used to store custom data about the Object3D .

Remarks

It should not hold references to functions as these will not be cloned.

Default

{}

Inherited from

Object3D.userData

---

uuid

uuid: string

Defined in: three.js/core/Object3D:uuid 

UUID  of this object instance.

Remarks

This gets automatically assigned and shouldn’t be edited.

Inherited from

Object3D.uuid

---

visible

visible: boolean

Defined in: three.js/core/Object3D:visible 

Object gets rendered if true.

Default Value

true

Inherited from

Object3D.visible

---

DEFAULT_MATRIX_AUTO_UPDATE

static DEFAULT_MATRIX_AUTO_UPDATE: boolean

Defined in: three.js/core/Object3D:DEFAULT_MATRIX_AUTO_UPDATE 

The default setting for matrixAutoUpdate for newly created Object3Ds.

Default Value

true

Inherited from

Object3D.DEFAULT_MATRIX_AUTO_UPDATE

---

DEFAULT_MATRIX_WORLD_AUTO_UPDATE

static DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

Defined in: three.js/core/Object3D:DEFAULT_MATRIX_WORLD_AUTO_UPDATE 

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

Default Value

true

Inherited from

Object3D.DEFAULT_MATRIX_WORLD_AUTO_UPDATE

---

DEFAULT_UP

static DEFAULT_UP: Vector3 

Defined in: three.js/core/Object3D:DEFAULT_UP 

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight, THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

Default Value

new THREE.Vector3( 0, 1, 0)

Inherited from

Object3D.DEFAULT_UP

Accessors

category

Get Signature

get category(): string | undefined

Defined in: packages/three-flatland/src/lights/Light2D.ts:242

User-facing category string. See Light2DOptions.category.

Returns

string | undefined

Set Signature

set category(value): void

Defined in: packages/three-flatland/src/lights/Light2D.ts:246

Parameters

value

string | undefined

Returns

void

---

color

Get Signature

get color(): Color 

Defined in: packages/three-flatland/src/lights/Light2D.ts:257

Get light color.

Returns

Color 

Set Signature

set color(value): void

Defined in: packages/three-flatland/src/lights/Light2D.ts:264

Set light color.

Parameters

value

ColorRepresentation 

Returns

void

---

direction

Get Signature

get direction(): Vector2 

Defined in: packages/three-flatland/src/lights/Light2D.ts:275

Get light direction (for directional/spot lights).

Returns

Vector2 

Set Signature

set direction(value): void

Defined in: packages/three-flatland/src/lights/Light2D.ts:282

Set light direction (normalized automatically).

Parameters

value

[number, number] | Vector2 

Returns

void

---

position2D

Get Signature

get position2D(): Vector2 

Defined in: packages/three-flatland/src/lights/Light2D.ts:294

Get the 2D position from Object3D position.

Returns

Vector2 

Set Signature

set position2D(value): void

Defined in: packages/three-flatland/src/lights/Light2D.ts:301

Set the 2D position (updates Object3D.position.x/y).

Parameters

value

[number, number] | Vector2 

Returns

void

Methods

add()

add(…object): this

Defined in: three.js/core/Object3D:add 

Adds another Object3D  as child of this Object3D .

Parameters

object

…Object3D <Object3DEventMap >[]

Returns

this

Remarks

An arbitrary number of objects may be added Any current parent on an object passed in here will be removed, since an Object3D  can have at most one parent.

See

• attach 
• THREE.Group | Group for info on manually grouping objects.

Inherited from

Object3D.add

---

addEventListener()

addEventListener<T>(type, listener): void

Defined in: three.js/core/EventDispatcher:addEventListener 

Adds a listener to an event type.

Type Parameters

T

T extends keyof Object3DEventMap 

Parameters

type

T

The type of event to listen to.

listener

EventListener <Object3DEventMap [T], T, Light2D>

The function that gets called when the event is fired.

Returns

void

Inherited from

Object3D.addEventListener

---

applyMatrix4()

applyMatrix4(matrix): void

Defined in: three.js/core/Object3D:applyMatrix4 

Applies the matrix transform to the object and updates the object’s position, rotation and scale.

Parameters

matrix

Matrix4 

Returns

void

Inherited from

Object3D.applyMatrix4

---

applyQuaternion()

applyQuaternion(quaternion): this

Defined in: three.js/core/Object3D:applyQuaternion 

Applies the rotation represented by the quaternion to the object.

Parameters

quaternion

Quaternion 

Returns

this

Inherited from

Object3D.applyQuaternion

---

attach()

attach(object): this

Defined in: three.js/core/Object3D:attach 

Adds a Object3D  as a child of this, while maintaining the object’s world transform.

Parameters

object

Object3D 

Returns

this

Remarks

Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

See

add 

Inherited from

Object3D.attach

---

clear()

clear(): this

Defined in: three.js/core/Object3D:clear 

Removes all child objects.

Returns

this

Inherited from

Object3D.clear

---

clone()

clone(): this

Defined in: packages/three-flatland/src/lights/Light2D.ts:332

Clone this light.

Returns

this

Overrides

Object3D.clone

---

copy()

copy(object, recursive?): this

Defined in: three.js/core/Object3D:copy 

Copies the given object into this object.

Parameters

object

Object3D 

recursive?

boolean

If set to true, descendants of the object are copied next to the existing ones. If set to false, descendants are left unchanged. Default is true.

Returns

this

Remarks

Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

Inherited from

Object3D.copy

---

dispatchEvent()

dispatchEvent<T>(event): void

Defined in: three.js/core/EventDispatcher:dispatchEvent 

Fire an event type.

Type Parameters

T

T extends keyof Object3DEventMap 

Parameters

event

BaseEvent <T> & Object3DEventMap [T]

The event that gets fired.

Returns

void

Inherited from

Object3D.dispatchEvent

---

dispose()

dispose(): void

Defined in: packages/three-flatland/src/lights/Light2D.ts:354

Dispose of resources.

Returns

void

---

getObjectById()

getObjectById(id): Object3D <Object3DEventMap > | undefined

Defined in: three.js/core/Object3D:getObjectById 

Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

Parameters

id

number

Unique number of the object instance. Expects a Integer

Returns

Object3D <Object3DEventMap > | undefined

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, …, incrementing by one for each new object.

See

id

Inherited from

Object3D.getObjectById

---

getObjectByName()

getObjectByName(name): Object3D <Object3DEventMap > | undefined

Defined in: three.js/core/Object3D:getObjectByName 

Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

Parameters

name

string

String to match to the children’s Object3D.name property.

Returns

Object3D <Object3DEventMap > | undefined

Remarks

Note that for most objects the name is an empty string by default You will have to set it manually to make use of this method.

Inherited from

Object3D.getObjectByName

---

getObjectByProperty()

getObjectByProperty(name, value): Object3D <Object3DEventMap > | undefined

Defined in: three.js/core/Object3D:getObjectByProperty 

Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.

Parameters

name

string

the property name to search for.

value

any

value of the given property.

Returns

Object3D <Object3DEventMap > | undefined

Inherited from

Object3D.getObjectByProperty

---

getObjectsByProperty()

getObjectsByProperty(name, value, optionalTarget?): Object3D <Object3DEventMap >[]

Defined in: three.js/core/Object3D:getObjectsByProperty 

Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.

Parameters

name

string

The property name to search for.

value

any

Value of the given property.

optionalTarget?

Object3D <Object3DEventMap >[]

target to set the result. Otherwise a new Array is instantiated. If set, you must clear this array prior to each call (i.e., array.length = 0;).

Returns

Object3D <Object3DEventMap >[]

Inherited from

Object3D.getObjectsByProperty

---

getUniforms()

getUniforms(): Light2DUniforms

Defined in: packages/three-flatland/src/lights/Light2D.ts:312

Get uniforms for shader use.

Returns

Light2DUniforms

---

getWorldDirection()

getWorldDirection(target): Vector3 

Defined in: three.js/core/Object3D:getWorldDirection 

Returns a vector representing the direction of object’s positive z-axis in world space.

Parameters

target

Vector3 

The result will be copied into this Vector3.

Returns

Vector3 

Inherited from

Object3D.getWorldDirection

---

getWorldPosition()

getWorldPosition(target): Vector3 

Defined in: three.js/core/Object3D:getWorldPosition 

Returns a vector representing the position of the object in world space.

Parameters

target

Vector3 

The result will be copied into this Vector3.

Returns

Vector3 

Inherited from

Object3D.getWorldPosition

---

getWorldQuaternion()

getWorldQuaternion(target): Quaternion 

Defined in: three.js/core/Object3D:getWorldQuaternion 

Returns a quaternion representing the rotation of the object in world space.

Parameters

target

Quaternion 

The result will be copied into this Quaternion.

Returns

Quaternion 

Inherited from

Object3D.getWorldQuaternion

---

getWorldScale()

getWorldScale(target): Vector3 

Defined in: three.js/core/Object3D:getWorldScale 

Returns a vector of the scaling factors applied to the object for each axis in world space.

Parameters

target

Vector3 

The result will be copied into this Vector3.

Returns

Vector3 

Inherited from

Object3D.getWorldScale

---

hasEventListener()

hasEventListener<T>(type, listener): boolean

Defined in: three.js/core/EventDispatcher:hasEventListener 

Checks if listener is added to an event type.

Type Parameters

T

T extends keyof Object3DEventMap 

Parameters

type

T

The type of event to listen to.

listener

EventListener <Object3DEventMap [T], T, Light2D>

The function that gets called when the event is fired.

Returns

boolean

Inherited from

Object3D.hasEventListener

---

localToWorld()

localToWorld(vector): Vector3 

Defined in: three.js/core/Object3D:localToWorld 

Converts the vector from this object’s local space to world space.

Parameters

vector

Vector3 

A vector representing a position in this object’s local space.

Returns

Vector3 

Inherited from

Object3D.localToWorld

---

lookAt()

Call Signature

lookAt(vector): void

Defined in: three.js/core/Object3D:lookAt 

Rotates the object to face a point in world space.

Parameters

vector

Vector3 

A vector representing a position in world space to look at.

Returns

void

Remarks

This method does not support objects having non-uniformly-scaled parent(s).

Inherited from

Object3D.lookAt

Call Signature

lookAt(x, y, z): void

Defined in: three.js/core/Object3D:lookAt 

Rotates the object to face a point in world space.

Parameters

x

number

Expects a Float

y

number

Expects a Float

z

number

Expects a Float

Returns

void

Remarks

This method does not support objects having non-uniformly-scaled parent(s).

Inherited from

Object3D.lookAt

---

onAfterRender()

onAfterRender(renderer, scene, camera, geometry, material, group): void

Defined in: three.js/core/Object3D:onAfterRender 

An optional callback that is executed immediately after a 3D object is rendered.

Parameters

renderer

WebGLRenderer 

scene

Scene 

camera

Camera 

geometry

BufferGeometry 

material

Material 

group

Group 

Returns

void

Remarks

This function is called with the following parameters: renderer, scene, camera, geometry, material, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D , Group  or Bone are not renderable and thus this callback is not executed for such objects.

Inherited from

Object3D.onAfterRender

---

onAfterShadow()

onAfterShadow(renderer, scene, camera, shadowCamera, geometry, depthMaterial, group): void

Defined in: three.js/core/Object3D:onAfterShadow 

An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

Parameters

renderer

WebGLRenderer 

scene

Scene 

camera

Camera 

shadowCamera

Camera 

geometry

BufferGeometry 

depthMaterial

Material 

group

Group 

Returns

void

Remarks

This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D , Group  or Bone are not renderable and thus this callback is not executed for such objects.

Inherited from

Object3D.onAfterShadow

---

onBeforeRender()

onBeforeRender(renderer, scene, camera, geometry, material, group): void

Defined in: three.js/core/Object3D:onBeforeRender 

An optional callback that is executed immediately before a 3D object is rendered.

Parameters

renderer

WebGLRenderer 

scene

Scene 

camera

Camera 

geometry

BufferGeometry 

material

Material 

group

Group 

Returns

void

Remarks

This function is called with the following parameters: renderer, scene, camera, geometry, material, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D , Group  or Bone are not renderable and thus this callback is not executed for such objects.

Inherited from

Object3D.onBeforeRender

---

onBeforeShadow()

onBeforeShadow(renderer, scene, camera, shadowCamera, geometry, depthMaterial, group): void

Defined in: three.js/core/Object3D:onBeforeShadow 

An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

Parameters

renderer

WebGLRenderer 

scene

Scene 

camera

Camera 

shadowCamera

Camera 

geometry

BufferGeometry 

depthMaterial

Material 

group

Group 

Returns

void

Remarks

This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D , Group  or Bone are not renderable and thus this callback is not executed for such objects.

Inherited from

Object3D.onBeforeShadow

---

raycast()

raycast(raycaster, intersects): void

Defined in: three.js/core/Object3D:raycast 

Abstract (empty) method to get intersections between a casted ray and this object

Parameters

raycaster

Raycaster 

intersects

Intersection <Object3D <Object3DEventMap >>[]

Returns

void

Remarks

Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

See

THREE.Raycaster | Raycaster

Default Value

() => {}

Inherited from

Object3D.raycast

---

remove()

remove(…object): this

Defined in: three.js/core/Object3D:remove 

Removes a Object3D  as child of this Object3D .

Parameters

object

…Object3D <Object3DEventMap >[]

Returns

this

Remarks

An arbitrary number of objects may be removed.

See

THREE.Group | Group for info on manually grouping objects.

Inherited from

Object3D.remove

---

removeEventListener()

removeEventListener<T>(type, listener): void

Defined in: three.js/core/EventDispatcher:removeEventListener 

Removes a listener from an event type.

Type Parameters

T

T extends keyof Object3DEventMap 

Parameters

type

T

The type of the listener that gets removed.

listener

EventListener <Object3DEventMap [T], T, Light2D>

The listener function that gets removed.

Returns

void

Inherited from

Object3D.removeEventListener

---

removeFromParent()

removeFromParent(): this

Defined in: three.js/core/Object3D:removeFromParent 

Removes this object from its current parent.

Returns

this

Inherited from

Object3D.removeFromParent

---

rotateOnAxis()

rotateOnAxis(axis, angle): this

Defined in: three.js/core/Object3D:rotateOnAxis 

Rotate an object along an axis in object space.

Parameters

axis

Vector3 

A normalized vector in object space.

angle

number

The angle in radians. Expects a Float

Returns

this

Remarks

The axis is assumed to be normalized.

Inherited from

Object3D.rotateOnAxis

---

rotateOnWorldAxis()

rotateOnWorldAxis(axis, angle): this

Defined in: three.js/core/Object3D:rotateOnWorldAxis 

Rotate an object along an axis in world space.

Parameters

axis

Vector3 

A normalized vector in world space.

angle

number

The angle in radians. Expects a Float

Returns

this

Remarks

The axis is assumed to be normalized Method Assumes no rotated parent.

Inherited from

Object3D.rotateOnWorldAxis

---

rotateX()

rotateX(angle): this

Defined in: three.js/core/Object3D:rotateX 

Rotates the object around x axis in local space.

Parameters

angle

number

Returns

this

Inherited from

Object3D.rotateX

---

rotateY()

rotateY(angle): this

Defined in: three.js/core/Object3D:rotateY 

Rotates the object around y axis in local space.

Parameters

angle

number

Returns

this

Inherited from

Object3D.rotateY

---

rotateZ()

rotateZ(angle): this

Defined in: three.js/core/Object3D:rotateZ 

Rotates the object around z axis in local space.

Parameters

angle

number

Returns

this

Inherited from

Object3D.rotateZ

---

setRotationFromAxisAngle()

setRotationFromAxisAngle(axis, angle): void

Defined in: three.js/core/Object3D:setRotationFromAxisAngle 

Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

Parameters

axis

Vector3 

A normalized vector in object space.

angle

number

Angle in radians. Expects a Float

Returns

void

Inherited from

Object3D.setRotationFromAxisAngle

---

setRotationFromEuler()

setRotationFromEuler(euler): void

Defined in: three.js/core/Object3D:setRotationFromEuler 

Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

Parameters

euler

Euler 

Euler angle specifying rotation amount.

Returns

void

Inherited from

Object3D.setRotationFromEuler

---

setRotationFromMatrix()

setRotationFromMatrix(m): void

Defined in: three.js/core/Object3D:setRotationFromMatrix 

Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

Parameters

m

Matrix4 

Rotate the quaternion by the rotation component of the matrix.

Returns

void

Remarks

Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

Inherited from

Object3D.setRotationFromMatrix

---

setRotationFromQuaternion()

setRotationFromQuaternion(q): void

Defined in: three.js/core/Object3D:setRotationFromQuaternion 

Copy the given THREE.Quaternion | Quaternion into .quaternion.

Parameters

q

Quaternion 

Normalized Quaternion.

Returns

void

Inherited from

Object3D.setRotationFromQuaternion

---

toJSON()

toJSON(meta?): Object3DJSON 

Defined in: three.js/core/Object3D:toJSON 

Convert the object to three.js JSON Object/Scene format .

Parameters

meta?

JSONMeta 

Object containing metadata such as materials, textures or images for the object.

Returns

Object3DJSON 

Inherited from

Object3D.toJSON

---

translateOnAxis()

translateOnAxis(axis, distance): this

Defined in: three.js/core/Object3D:translateOnAxis 

Translate an object by distance along an axis in object space

Parameters

axis

Vector3 

A normalized vector in object space.

distance

number

The distance to translate. Expects a Float

Returns

this

Remarks

The axis is assumed to be normalized.

Inherited from

Object3D.translateOnAxis

---

translateX()

translateX(distance): this

Defined in: three.js/core/Object3D:translateX 

Translates object along x axis in object space by distance units.

Parameters

distance

number

Expects a Float

Returns

this

Inherited from

Object3D.translateX

---

translateY()

translateY(distance): this

Defined in: three.js/core/Object3D:translateY 

Translates object along y axis in object space by distance units.

Parameters

distance

number

Expects a Float

Returns

this

Inherited from

Object3D.translateY

---

translateZ()

translateZ(distance): this

Defined in: three.js/core/Object3D:translateZ 

Translates object along z axis in object space by distance units.

Parameters

distance

number

Expects a Float

Returns

this

Inherited from

Object3D.translateZ

---

traverse()

traverse(callback): void

Defined in: three.js/core/Object3D:traverse 

Executes the callback on this object and all descendants.

Parameters

callback

(object) => any

A function with as first argument an Object3D  object.

Returns

void

Remarks

Note: Modifying the scene graph inside the callback is discouraged.

Inherited from

Object3D.traverse

---

traverseAncestors()

traverseAncestors(callback): void

Defined in: three.js/core/Object3D:traverseAncestors 

Executes the callback on all ancestors.

Parameters

callback

(object) => any

A function with as first argument an Object3D  object.

Returns

void

Remarks

Note: Modifying the scene graph inside the callback is discouraged.

Inherited from

Object3D.traverseAncestors

---

traverseVisible()

traverseVisible(callback): void

Defined in: three.js/core/Object3D:traverseVisible 

Like traverse, but the callback will only be executed for visible objects

Parameters

callback

(object) => any

A function with as first argument an Object3D  object.

Returns

void

Remarks

Descendants of invisible objects are not traversed. Note: Modifying the scene graph inside the callback is discouraged.

Inherited from

Object3D.traverseVisible

---

updateMatrix()

updateMatrix(): void

Defined in: three.js/core/Object3D:updateMatrix 

Updates local transform.

Returns

void

Inherited from

Object3D.updateMatrix

---

updateMatrixWorld()

updateMatrixWorld(force?): void

Defined in: three.js/core/Object3D:updateMatrixWorld 

Updates the global transform of the object. And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

Parameters

force?

boolean

A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame. Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

Returns

void

Inherited from

Object3D.updateMatrixWorld

---

updateWorldMatrix()

updateWorldMatrix(updateParents?, updateChildren?, force?): void

Defined in: three.js/core/Object3D:updateWorldMatrix 

An alternative version of Object3D#updateMatrixWorld  with more control over the update of ancestor and descendant nodes.

Parameters

updateParents?

boolean

Whether ancestor nodes should be updated or not.

updateChildren?

boolean

Whether descendant nodes should be updated or not.

force?

boolean

When set to true, a recomputation of world matrices is forced even when Object3D#matrixWorldNeedsUpdate is false.

Returns

void

Inherited from

Object3D.updateWorldMatrix

---

worldToLocal()

worldToLocal(vector): Vector3 

Defined in: three.js/core/Object3D:worldToLocal 

Converts the vector from world space to this object’s local space.

Parameters

vector

Vector3 

A vector representing a position in world space.

Returns

Vector3 

Inherited from

Object3D.worldToLocal