Creates a new SpotLight.
Optional color: ColorRepresentationHexadecimal color of the light. Default 0xffffff (white).
Optional intensity: numberNumeric value of the light's strength/intensity. Expects a Float. Default 1.
Optional distance: numberMaximum range of the light. Default is 0 (no limit). Expects a Float.
Optional angle: numberMaximum angle of light dispersion from its direction whose upper bound is Math.PI/2.
Optional penumbra: numberPercent of the SpotLight cone that is attenuated due to penumbra. Takes values between zero and 1. Expects a Float. Default 0.
Optional decay: numberThe amount the light dims along the distance of the light. Expects a Float. Default 2.
Maximum extent of the spotlight, in radians, from its direction.
Should be no more than Math.PI/2.
Math.PI / 3
Array with object's animation clips.
[]
If set to true light will cast dynamic shadows.
Warning: This is expensive and requires tweaking to get shadows looking right. the SpotLightShadow for details.
false
Array with object's children.
THREE.Object3DGroup | Group for info on manually grouping objects.
[]
Color of the light. \
new THREE.Color(0xffffff) (white).
Optional customCustom depth material to be used when rendering to the depth map.
Can only be used in context of meshes.
undefined
Optional customSame as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.
undefined
The amount the light dims along the distance of the light. In context of physically-correct rendering the default value should not be changed.
Expects a Float
2
When Default mode — When distance is zero, light does not attenuate. When distance is non-zero, light will attenuate linearly from maximum intensity at the light's position down to zero at this distance from the light.
When legacy lighting mode is disabled — When distance is zero,
light will attenuate according to inverse-square law to infinite distance.
When distance is non-zero, light will attenuate according to inverse-square law until near the distance cutoff,
where it will then attenuate quickly and smoothly to 0. Inherently, cutoffs are not physically correct.
Expects a Float
0.0
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.
true
Readonly idUnique number for this Object3D instance.
Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
The light's intensity.
Changing the intensity will also change the light's power. When legacy lighting mode is disabled — intensity is the luminous intensity of the light measured in candela (cd).
1
Readonly isRead-only flag to check if a given object is of type HemisphereLight.
This is a constant value
true
Readonly isFlag to check if a given object is of type Object3D.
This is a constant value
true
Readonly isRead-only flag to check if a given object is of type SpotLight.
This is a constant value
true
The layer membership of the object.
The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.
new THREE.Layers()
A Texture used to modulate the color of the light. The spot light color is mixed with the RGB value of this texture, with a ratio corresponding to its alpha value. The cookie-like masking effect is reproduced using pixel values (0, 0, 0, 1-cookie_value).
Warning: SpotLight.map is disabled if SpotLight.castShadow is false.
The local transform matrix.
new THREE.Matrix4()
When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property.
DEFAULT_MATRIX_AUTO_UPDATE - that is (true).
The global transform of the object.
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_MATRIX_WORLD_AUTO_UPDATE - that is (true).
When this is set, it calculates the matrixWorld in that frame and resets this property to false.
false
Readonly modelnew THREE.Matrix4()
Optional name of the object
(doesn't need to be unique).
""
Readonly normalnew THREE.Matrix3()
Object's parent in the scene graph.
An object can have at most one parent.
null
Percent of the SpotLight cone that is attenuated due to penumbra.
Takes values between zero and 1.
0.0
Readonly positionThis is set equal to Object3D.DEFAULT_UP (0, 1, 0), so that the light shines from the top down.
{@link Object3D.DEFAULT_UP}
The light's power.
Changing the power will also change the light's intensity. When legacy lighting mode is disabled — power is the luminous power of the light measured in lumens (lm).
Readonly quaternionObject's local rotation as a Quaternion.
new THREE.Quaternion() - that is (0, 0, 0, 1).
Whether the material receives shadows.
false
This value allows the default rendering order of scene graph objects to be overridden although opaque and transparent objects remain sorted independently.
When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
0
Readonly rotationObject's local rotation (Euler angles), in radians.
new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).
Readonly scaleThe object's local scale.
new THREE.Vector3( 1, 1, 1 )
A SpotLightShadow used to calculate shadows for this light.
new THREE.SpotLightShadow()
Note: For the target's position to be changed to anything other than the default, it must be added to the scene using
scene.add( light.target );
This is so that the target's matrixWorld gets automatically updated each frame. It is also possible to set the target to be another object in the scene (anything with a position property), like so:
const targetObject = new THREE.Object3D();
scene.add(targetObject);
light.target = targetObject;
The SpotLight will now track the target object.
new THREE.Object3D() The default position of the target is (0, 0, 0).
Readonly typeA Read-only string to check if this object type.
Sub-classes will update this value.
SpotLight
This is used by the lookAt method, for example, to determine the orientation of the result.
Object3D.DEFAULT_UP - that is (0, 1, 0).
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.
{}
UUID of this object instance.
This gets automatically assigned and shouldn't be edited.
Object gets rendered if true.
true
Static DEFAULT_The default setting for matrixAutoUpdate for newly created Object3Ds.
true
Static DEFAULT_The default setting for matrixWorldAutoUpdate for newly created Object3Ds.
true
Static DEFAULT_The default up direction for objects, also used as the default position for DirectionalLight, HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).
new THREE.Vector3( 0, 1, 0)
Rest ...object: Object3D<Object3DEventMap>[]Adds a listener to an event type.
The type of event to listen to.
The function that gets called when the event is fired.
Applies the matrix transform to the object and updates the object's position, rotation and scale.
Applies the rotation represented by the quaternion to the object.
Adds a Object3D as a child of this, while maintaining the object's world transform.
Copies value of all the properties from the source to this instance.
Optional recursive: booleanFire an event type.
The event that gets fired.
Searches through an object and its children, starting with the object itself, and returns the first with a matching id.
Unique number of the object instance. Expects a Integer
Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
id
Searches through an object and its children, starting with the object itself, and returns the first with a matching name.
String to match to the children's Object3D.name property.
Note that for most objects the name is an empty string by default
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
the property name to search for.
value of the given property.
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
The property name to search for.
Value of the given property.
Optional 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 a quaternion representing the rotation of the object in world space.
The result will be copied into this Quaternion.
Checks if listener is added to an event type.
The type of event to listen to.
The function that gets called when the event is fired.
Rotates the object to face a point in world space.
A vector representing a position in world space to look at.
This method does not support objects having non-uniformly-scaled parent(s).
Rotates the object to face a point in world space.
Expects a Float
Expects a Float
Expects a Float
This method does not support objects having non-uniformly-scaled parent(s).
An optional callback that is executed immediately after a 3D object is rendered.
This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
An optional callback that is executed immediately after a 3D object is rendered to a shadow map.
This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group.
An optional callback that is executed immediately before a 3D object is rendered.
This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
An optional callback that is executed immediately before a 3D object is rendered to a shadow map.
This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group.
Abstract (empty) method to get intersections between a casted ray and this object
Rest ...object: Object3D<Object3DEventMap>[]An arbitrary number of objects may be removed.
Group for info on manually grouping objects.
Removes a listener from an event type.
The type of the listener that gets removed.
The listener function that gets removed.
Rotate an object along an axis in object space.
A normalized vector in object space.
The angle in radians. Expects a Float
The axis is assumed to be normalized.
Rotate an object along an axis in world space.
A normalized vector in world space.
The angle in radians. Expects a Float
The axis is assumed to be normalized
Calls setFromAxisAngle(axis, angle) on the .quaternion.
A normalized vector in object space.
Angle in radians. Expects a Float
Calls setFromEuler(euler) on the .quaternion.
Euler angle specifying rotation amount.
Calls setFromRotationMatrix(m) on the .quaternion.
Rotate the quaternion by the rotation component of the matrix.
Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).
Copy the given Quaternion into .quaternion.
Normalized Quaternion.
Convert the object to three.js JSON Object/Scene format.
Optional meta: { Object containing metadata such as materials, textures or images for the object.
Translate an object by distance along an axis in object space
A normalized vector in object space.
The distance to translate. Expects a Float
The axis is assumed to be normalized.
Executes the callback on this object and all descendants.
A function with as first argument an Object3D object.
Note: Modifying the scene graph inside the callback is discouraged.
Executes the callback on all ancestors.
A function with as first argument an Object3D object.
Note: Modifying the scene graph inside the callback is discouraged.
Like traverse, but the callback will only be executed for visible objects
A function with as first argument an Object3D object.
Descendants of invisible objects are not traversed.
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.
Optional force: booleanA 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.
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.
Example
See