Class: AmbientLight

Constructor

new AmbientLight(coloropt, intensityopt)

Parameters:

Name	Type	Attributes	Default	Description
`color`	number	<optional>	0xffffff
`intensity`	number	<optional>	1

Extends

Light

Members

castShadow :boolean

Whether the object gets rendered into shadow map.

Type:

boolean

Overrides: Light#castShadow
Default Value: false

children :Array.<Object3D>

Object's parent in the scene graph. An object can have at most one parent.

Type:

Array.<Object3D>

Overrides: Light#children

color :Color3

Color of the light.

Type:

Color3

Overrides: Light#color
Default Value: Color3(0xffffff)

euler :Euler

Object's local rotation as an Euler, in radians.

Type:

Euler

Overrides: Light#euler
Default Value: Euler(0, 0, 0)

frustumCulled :boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object. Otherwise the object gets rendered every frame even if it isn't visible.

Type:

boolean

Overrides: Light#frustumCulled
Default Value: true

groupMask :number

Group mask of the light, indicating which lighting group the light belongs to. Default is 1 (binary 0001), meaning the light belongs to lighting group 0. For example, to make the light effective in both lighting group 0 and lighting group 1, set groupMask to 3 (binary 0011). Used in conjunction with Material#lightingGroup.

Type:

number

Overrides: Light#groupMask
Default Value: 1

(readonly) id :number

Unique number for this object instance.

Type:

number

Overrides: Light#id

intensity :number

The light's intensity, or strength.

Type:

number

Overrides: Light#intensity
Default Value: 1

(readonly) isAmbientLight :boolean

Type:

boolean

Default Value: true

(readonly) isLight :boolean

Type:

boolean

Overrides: Light#isLight
Default Value: true

matrix :Matrix4

The local transform matrix.

Type:

Matrix4

Overrides: Light#matrix

matrixAutoUpdate :boolean

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

Type:

boolean

Overrides: Light#matrixAutoUpdate
Default Value: true

matrixNeedsUpdate :boolean

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

Type:

boolean

Overrides: Light#matrixNeedsUpdate
Default Value: true

name :string

Optional name of the object (doesn't need to be unique).

Type:

string

Overrides: Light#name
Default Value: ""

parent :Object3D

Object's parent in the scene graph. An object can have at most one parent.

Type:

Object3D

Overrides: Light#parent

position :Vector3

A Vector3 representing the object's local position.

Type:

Vector3

Overrides: Light#position
Default Value: Vector3(0, 0, 0)

quaternion :Quaternion

Object's local rotation as a Quaternion.

Type:

Quaternion

Overrides: Light#quaternion
Default Value: Quaternion(0, 0, 0, 1)

receiveShadow :boolean

Whether the material receives shadows.

Type:

boolean

Overrides: Light#receiveShadow
Default Value: false

renderLayer :number

Render layer of this object. RenderQueue will dispatch all renderable objects to the corresponding RenderQueueLayer according to object.renderLayer.

Type:

number

Overrides: Light#renderLayer
Default Value: 0

renderOrder :number

This value allows the default rendering order of scene graph objects to be overridden although opaque and transparent objects remain sorted independently. Sorting is from lowest to highest renderOrder.

Type:

number

Overrides: Light#renderOrder
Default Value: 0

renderable :boolean

Whether it can be collected into the Render Queue.

Type:

boolean

Overrides: Light#renderable
Default Value: true

scale :Vector3

The object's local scale.

Type:

Vector3

Overrides: Light#scale
Default Value: Vector3(1, 1, 1)

shadowType :SHADOW_TYPE

Defines shadow map type. Note: In webgl1 or Scene#disableShadowSampler is true, soft shadow types will fallback to POISSON_SOFT without warning. Note: Point light only support POISSON_SOFT for now.

Type:

SHADOW_TYPE

Overrides: Light#shadowType
Default Value: SHADOW_TYPE.PCF3_SOFT

userData :object

An object that can be used to store custom data about the Object3D. It should not hold references to functions as these will not be cloned.

Type:

object

Overrides: Light#userData
Default Value: {}

uuid :string

UUID of this object instance. This gets automatically assigned, so this shouldn't be edited.

Type:

string

Overrides: Light#uuid

visible :boolean

Object gets rendered if true.

Type:

boolean

Overrides: Light#visible
Default Value: true

worldMatrix :Matrix4

The global transform of the object. If the Object3D has no parent, then it's identical to the local transform Object3D#matrix.

Type:

Matrix4

Overrides: Light#worldMatrix

worldMatrixNeedsUpdate :boolean

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

Type:

boolean

Overrides: Light#worldMatrixNeedsUpdate
Default Value: true

Methods

add(object)

Add object as child of this object.

Parameters:

Name	Type	Description
`object`	Object3D

Overrides: Light#add

clone(recursiveopt) → {Object3D}

Returns a clone of this object and optionally all descendants.

Parameters:

Name	Type	Attributes	Default	Description
`recursive`	function	<optional>	true	if true, descendants of the object are also cloned.

Overrides: Light#clone

Returns:

Type:: Object3D

copy(source) → {Light}

Copies properties from the source light into this one.

Parameters:

Name	Type	Description
`source`	Light	The source light.

Overrides: Light#copy

Returns:

This light.

Type:: Light

getObjectByName(name) → {Object3D}

Searches through the object's children and returns the first with a matching name. 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.

Parameters:

Name	Type	Description
`name`	string	String to match to the children's Object3D#name property.

Overrides: Light#getObjectByName

Returns:

Type:: Object3D

getObjectByProperty(name, value) → {Object3D}

Searches through the object's children and returns the first with a property that matches the value given.

Parameters:

Name	Type	Description
`name`	string	the property name to search for.
`value`	number	value of the given property.

Overrides: Light#getObjectByProperty

Returns:

Type:: Object3D

getWorldDirection(optionalTargetopt) → {Vector3}

Returns a vector representing the direction of object's positive z-axis in world space. This call must be after Object3D#updateMatrix.

Parameters:

Name	Type	Attributes	Description
`optionalTarget`	Vector3	<optional>	— the result will be copied into this Vector3.

Overrides: Light#getWorldDirection

Returns:

the result.

Type:: Vector3

lookAt(target, up)

Set light direction, this func will set quaternion of this light.

Parameters:

Name	Type	Description
`target`	Vector3	The target that the light look at.
`up`	Vector3	The up direction of the light.

Overrides: Light#lookAt

onAfterRender()

An optional callback that is executed immediately after the Object3D is rendered.

Overrides: Light#onAfterRender

onBeforeRender()

An optional callback that is executed immediately before the Object3D is rendered.

Overrides: Light#onBeforeRender

(abstract) raycast(ray, intersects)

Method to get intersections between a casted ray and this object.

Parameters:

Name	Type	Description
`ray`	Ray	The Ray instance.
`intersects`	Array	output intersects array.

Overrides: Light#raycast

remove(object)

Remove object as child of this object.

Parameters:

Name	Type	Description
`object`	Object3D

Overrides: Light#remove

traverse(callback)

Executes the callback on this object and all descendants.

Parameters:

Name	Type	Description
`callback`	function	A function with as first argument an object3D object.

Overrides: Light#traverse

updateMatrix(force)

Update the local transform.

Parameters:

Name	Type	Description
`force`	boolean

Overrides: Light#updateMatrix