Class AmbientLight

Creates a new ambient light that can be added to the scene, for example:

const a = new AmbientLight();
a.ambientIntensity = new Vector3(0.3, 0.3, 0.3);
this.scene.add(a);

Hierarchy

Light
- AmbientLight

Constructors

constructor

new AmbientLight(intensity?: Vector3 | Color): AmbientLight
Parameters
- intensity: Vector3 | Color = ...
Returns AmbientLight
Overrides Light.constructor
- Defined in src/lights/AmbientLight.ts:15

Properties

`Protected` _localBoundingBox

_localBoundingBox: BoundingBox3

Bounding box in this transform's local coordinate space

`Protected` _localBoundingSphere

_localBoundingSphere: BoundingSphere

Bounding circle in this transform's local coordinate space

`Protected` _position

_position: Vector3

The position of this node as a Vector3.

`Protected` _rotation

_rotation: Quaternion

The rotation of this transform represented as a quaternion.

`Protected` _scale

_scale: Vector3

The scale of this node as a Vector3.

`Protected` _worldBoundingBox

_worldBoundingBox: BoundingBox3

Bounding box in the world coordinate space

`Protected` _worldBoundingSphere

_worldBoundingSphere: BoundingSphere

Bounding box in the world coordinate space

ambientIntensity

ambientIntensity: Vector3

boundingBox

boundingBox: BoundingBox3

The bounding box in vertex coordinate space

boundingSphere

boundingSphere: BoundingSphere

The bounding sphere in vertex coordinate space

children

children: Node3[]

diffuseIntensity

diffuseIntensity: Vector3

localBoundsDirty

localBoundsDirty: boolean

`Protected` localMatrixDirty

localMatrixDirty: boolean

`Protected` localMatrixNegScale

localMatrixNegScale: boolean

`Protected` localMatrixUpdated

localMatrixUpdated: boolean

`Protected` localToParentMatrix

localToParentMatrix: Matrix4

The local transformation matrix of this node.

localToWorldMatrix

localToWorldMatrix: Matrix4

The world transformation matrix of this node.

parent

parent: null | Node3

The parent transform of this transform. Null if this transform has no parent.

specularIntensity

specularIntensity: Vector3

`Protected` `Readonly` type

type: LightType

visible

visible: boolean

Whether this transform is currently visible in the scene.

worldBoundsDirty

worldBoundsDirty: boolean

`Protected` worldMatrixDirty

worldMatrixDirty: boolean

Accessors

localBoundingBox

get localBoundingBox(): BoundingBox3
Returns BoundingBox3
Inherited from Light.localBoundingBox
- Defined in src/core/Node3.ts:214
set localBoundingBox(value: BoundingBox3): void
Parameters
- value: BoundingBox3
Returns void
Inherited from Light.localBoundingBox
- Defined in src/core/Node3.ts:224

localBoundingSphere

get localBoundingSphere(): BoundingSphere
Returns BoundingSphere
Inherited from Light.localBoundingSphere
- Defined in src/core/Node3.ts:229
set localBoundingSphere(value: BoundingSphere): void
Parameters
- value: BoundingSphere
Returns void
Inherited from Light.localBoundingSphere
- Defined in src/core/Node3.ts:239

position

get position(): Vector3
Returns Vector3
Inherited from Light.position
- Defined in src/core/Node3.ts:144
set position(value: Vector3): void
Parameters
- value: Vector3
Returns void
Inherited from Light.position
- Defined in src/core/Node3.ts:155

rotation

get rotation(): Quaternion
Returns Quaternion
Inherited from Light.rotation
- Defined in src/core/Node3.ts:161
set rotation(value: Quaternion): void
Parameters
- value: Quaternion
Returns void
Inherited from Light.rotation
- Defined in src/core/Node3.ts:172

scale

get scale(): Vector3
Returns Vector3
Inherited from Light.scale
- Defined in src/core/Node3.ts:178
set scale(value: Vector3): void
Parameters
- value: Vector3
Returns void
Inherited from Light.scale
- Defined in src/core/Node3.ts:189

worldBoundingBox

get worldBoundingBox(): BoundingBox3
Returns BoundingBox3
Inherited from Light.worldBoundingBox
- Defined in src/core/Node3.ts:244
set worldBoundingBox(value: BoundingBox3): void
Parameters
- value: BoundingBox3
Returns void
Inherited from Light.worldBoundingBox
- Defined in src/core/Node3.ts:254

worldBoundingSphere

get worldBoundingSphere(): BoundingSphere
Returns BoundingSphere
Inherited from Light.worldBoundingSphere
- Defined in src/core/Node3.ts:259
set worldBoundingSphere(value: BoundingSphere): void
Parameters
- value: BoundingSphere
Returns void
Inherited from Light.worldBoundingSphere
- Defined in src/core/Node3.ts:269

Methods

add

add(child: Node3): void
Adds a child Node3 to the current Node3
Parameters
- child: Node3
  
  The Node3 to be added
Returns void
Inherited from Light.add
- Defined in src/core/Node3.ts:333

composeLocalMatrix

composeLocalMatrix(): void
Returns void
Inherited from Light.composeLocalMatrix
- Defined in src/core/Node3.ts:414

decomposeLocalMatrix

decomposeLocalMatrix(): void
Returns void
Inherited from Light.decomposeLocalMatrix
- Defined in src/core/Node3.ts:424

draw

draw(parent: Node3, camera: Camera, lightManager: LightManager): void
Draws this transform and all its children in the scene graph.
Parameters
- parent: Node3
  
  The parent transform of this transform.
- camera: Camera
  
  The camera used to view the scene.
- lightManager: LightManager
  
  The light manager used to manage the lights in the scene.
Returns void
Inherited from Light.draw
- Defined in src/core/Node3.ts:373

getLocalToParentMatrix

getLocalToParentMatrix(): Matrix4
Returns Matrix4
Inherited from Light.getLocalToParentMatrix
- Defined in src/core/Node3.ts:195

getType

getType(): LightType
Returns LightType
Inherited from Light.getType
- Defined in src/lights/Light.ts:42

intersects

intersects(other: Node3, mode?: IntersectionMode3, space?: CoordinateSpace3): boolean
Checks for intersection between this Node3 and another

Returns
Whether or not the two objects intersect
Parameters
- other: Node3
  
  The other Node3 object
- mode: IntersectionMode3 = IntersectionMode3.BOUNDING_SPHERE
  
  The IntersectionMode3 to use for the comparison (default: BOUNDING_SPHERE)
- space: CoordinateSpace3 = CoordinateSpace3.LOCAL_SPACE
  
  The CoordinateSpace3 to use for the comparison (default: LOCAL_SPACE)
Returns boolean
Inherited from Light.intersects
- Defined in src/core/Node3.ts:458

lookAt

lookAt(target: Vector3, up?: Vector3, coordinateSpace?: CoordinateSpace3): void
Rotates this Node3 object to look at the given target with the given up vector
Parameters
- target: Vector3
  
  The Vector3 representing the target in world space
- up: Vector3 = Vector3.UP
  
  The Vector3 representing the up direction (defaults to Vector3.UP)
- coordinateSpace: CoordinateSpace3 = CoordinateSpace3.LOCAL_SPACE
Returns void
Inherited from Light.lookAt
- Defined in src/core/Node3.ts:398

remove

remove(): boolean
Removes the current Node3 from its parent Node3

Returns
true if the Node3 was successfully removed, false otherwise

Returns boolean
Inherited from Light.remove
- Defined in src/core/Node3.ts:342

removeChild

removeChild(child: Node3): null | Node3
Removes the given child Node3 from the current Node3

Returns
The removed Node3 if found, null otherwise
Parameters
- child: Node3
  
  The Node3 to be removed
Returns null | Node3
Inherited from Light.removeChild
- Defined in src/core/Node3.ts:354

setLights

setLights(lightManager: LightManager): void
Sets lights on the children of the Node3
Parameters
- lightManager: LightManager
  
  The LightManager object
Returns void
Inherited from Light.setLights
- Defined in src/lights/Light.ts:47

setLocalToParentMatrix

setLocalToParentMatrix(matrix: Matrix4, includesNegScale: boolean): void
Parameters
- matrix: Matrix4
- includesNegScale: boolean
Returns void
Inherited from Light.setLocalToParentMatrix
- Defined in src/core/Node3.ts:205

traverseSceneGraph

traverseSceneGraph(parentMatrixDirty?: boolean): void
Traverses the scene graph starting from this Node3 object and updates the world matrices of all Node3 objects in the graph.
Parameters
- parentMatrixDirty: boolean = false
Returns void
Inherited from Light.traverseSceneGraph
- Defined in src/core/Node3.ts:278

updateLocalBounds

updateLocalBounds(): void
Returns void
Inherited from Light.updateLocalBounds
- Defined in src/core/Node3.ts:432

updateWorldBounds

updateWorldBounds(): void
Returns void
Inherited from Light.updateWorldBounds
- Defined in src/core/Node3.ts:441

updateWorldMatrix

updateWorldMatrix(): void
Updates the world matrix of this Node3 by computing the multiplication of its local matrix with its parent's world matrix (if it has a parent).

Returns
void

Returns void
Inherited from Light.updateWorldMatrix
- Defined in src/core/Node3.ts:310

Class AmbientLight

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

intensity: Vector3 | Color = ...

Returns AmbientLight

Properties

Protected _localBoundingBox

Protected _localBoundingSphere

Protected _position

Protected _rotation

Protected _scale

Protected _worldBoundingBox

Protected _worldBoundingSphere

ambientIntensity

boundingBox

boundingSphere

children

diffuseIntensity

localBoundsDirty

Protected localMatrixDirty

Protected localMatrixNegScale

Protected localMatrixUpdated

Protected localToParentMatrix

localToWorldMatrix

parent

specularIntensity

Protected Readonly type

visible

worldBoundsDirty

Protected worldMatrixDirty

Accessors

localBoundingBox

Returns BoundingBox3

Parameters

value: BoundingBox3

Returns void

localBoundingSphere

Returns BoundingSphere

Parameters

value: BoundingSphere

Returns void

position

Returns Vector3

Parameters

value: Vector3

Returns void

rotation

Returns Quaternion

Parameters

value: Quaternion

Returns void

scale

Returns Vector3

Parameters

value: Vector3

Returns void

worldBoundingBox

Returns BoundingBox3

Parameters

value: BoundingBox3

Returns void

worldBoundingSphere

Returns BoundingSphere

Parameters

value: BoundingSphere

Returns void

Methods

add

Parameters

child: Node3

Returns void

composeLocalMatrix

Returns void

`Protected` _localBoundingBox

`Protected` _localBoundingSphere

`Protected` _position

`Protected` _rotation

`Protected` _scale

`Protected` _worldBoundingBox

`Protected` _worldBoundingSphere

`Protected` localMatrixDirty

`Protected` localMatrixNegScale

`Protected` localMatrixUpdated

`Protected` localToParentMatrix

`Protected` `Readonly` type

`Protected` worldMatrixDirty