ThreeScalaJS
0.0.7
DocsAPI
Generated with
Copyright (c) 2022-2025, Olivier NOUGUIER
Copyright (c) 2022-2025, Olivier NOUGUIER
ThreeScalaJS/THREE/SpotLightHelper

SpotLightHelper

THREE.SpotLightHelper
See theSpotLightHelper companion object
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.

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
Graph
Supertypes
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def dispose(): Unit

Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Attributes

def update(): Unit

Updates the helper to match the position and direction of the light being visualized.

Updates the helper to match the position and direction of the light being visualized.

Attributes

Inherited methods

def add(obj: Object3D*): this.type

Attributes

Inherited from:
Object3D
def applyMatrix4(matrix: Matrix4): Unit

Attributes

Inherited from:
Object3D
def applyQuaternion(q: Quaternion): this.type

Attributes

Inherited from:
Object3D
def attach(obj: Object3D): this.type

Attributes

Inherited from:
Object3D
def clear(): this.type

Attributes

Inherited from:
Object3D
def copy(source: Object3D, recursive: Boolean): this.type

Attributes

Inherited from:
Object3D
def getObjectById(id: Int): UndefOr[Object3D]

Attributes

Inherited from:
Object3D
def getObjectByName(name: String): UndefOr[Object3D]

Attributes

Inherited from:
Object3D
def getObjectByProperty(name: String, value: Any): UndefOr[Object3D]

Attributes

Inherited from:
Object3D
def getWorldDirection(target: Vector3): Vector3

Attributes

Inherited from:
Object3D
def getWorldPosition(target: Vector3): Vector3

Attributes

Inherited from:
Object3D
def getWorldQuaternion(target: Quaternion): Quaternion

Attributes

Inherited from:
Object3D
def getWorldScale(target: Vector3): Vector3

Attributes

Inherited from:
Object3D
def hasOwnProperty(v: String): Boolean

Attributes

Inherited from:
Object
def isPrototypeOf(v: Object): Boolean

Attributes

Inherited from:
Object
def jsClone(recursive: Boolean): this.type

Attributes

Inherited from:
Object3D
def localToWorld(vector: Vector3): Vector3

Attributes

Inherited from:
Object3D
def lookAt(x: Any, y: UndefOr[Double], z: UndefOr[Double]): Unit

Attributes

Inherited from:
Object3D
def propertyIsEnumerable(v: String): Boolean

Attributes

Inherited from:
Object
def raycast(raycaster: Object, intersects: Array[Object]): Unit

Attributes

Inherited from:
Object3D
def remove(ob: Object3D*): this.type

Attributes

Inherited from:
Object3D
def rotateOnAxis(axis: Vector3, angle: Double): this.type

Attributes

Inherited from:
Object3D
def rotateOnWorldAxis(axis: Vector3, angle: Double): this.type

Attributes

Inherited from:
Object3D
def rotateX(angle: Double): this.type

Attributes

Inherited from:
Object3D
def rotateY(angle: Double): this.type

Attributes

Inherited from:
Object3D
def rotateZ(angle: Double): this.type

Attributes

Inherited from:
Object3D
def setRotationFromAxisAngle(axis: Vector3, angle: Double): Unit

Attributes

Inherited from:
Object3D
def setRotationFromEuler(euler: Euler): Unit

Attributes

Inherited from:
Object3D
def setRotationFromMatrix(m: Matrix4): Unit

Attributes

Inherited from:
Object3D
def setRotationFromQuaternion(q: Quaternion): Unit

Attributes

Inherited from:
Object3D
def toLocaleString(): String

Attributes

Inherited from:
Object
def translateOnAxis(axis: Vector3, distance: Double): this.type

Attributes

Inherited from:
Object3D
def translateX(distance: Double): this.type

Attributes

Inherited from:
Object3D
def translateY(distance: Double): this.type

Attributes

Inherited from:
Object3D
def translateZ(distance: Double): this.type

Attributes

Inherited from:
Object3D
def traverse(callback: Function1[Object3D, Unit]): Unit

Attributes

Inherited from:
Object3D
def traverseAncestors(callback: Function1[Object3D, Unit]): Unit

Attributes

Inherited from:
Object3D
def traverseVisible(callback: Function1[Object3D, Unit]): Unit

Attributes

Inherited from:
Object3D
def updateMatrix(): Unit

Attributes

Inherited from:
Object3D
def updateMatrixWorld(force: Boolean): Unit

Attributes

Inherited from:
Object3D
def updateWorldMatrix(updateParent: Boolean, updateChildren: Boolean): Unit

Attributes

Inherited from:
Object3D
def valueOf(): Any

Attributes

Inherited from:
Object
def worldToLocal(vector: Vector3): Vector3

Attributes

Inherited from:
Object3D

Concrete fields

override val `type`: String

The type property of the helper.

The type property of the helper.

Attributes

val cone: LineSegments

Contains the cone showing the location and direction of the spot light.

Contains the cone showing the location and direction of the spot light.

Attributes

val isSpotLightHelper: Boolean

This flag can be used for type testing.

This flag can be used for type testing.

Attributes

Inherited fields

var castShadow: Boolean

Attributes

Inherited from:
Object3D
val children: Array[Object3D]

Attributes

Inherited from:
Object3D
var frustumCulled: Boolean

Attributes

Inherited from:
Object3D
val id: Int

Attributes

Inherited from:
Object3D
var layers: Object

Attributes

Inherited from:
Object3D
var matrix: Matrix4

Attributes

Inherited from:
Object3D
var matrixAutoUpdate: Boolean

Attributes

Inherited from:
Object3D
var matrixWorld: Matrix4

Attributes

Inherited from:
Object3D
var matrixWorldNeedsUpdate: Boolean

Attributes

Inherited from:
Object3D
var name: String

Attributes

Inherited from:
Object3D
var parent: UndefOr[Object3D]

Attributes

Inherited from:
Object3D
var position: Vector3

Attributes

Inherited from:
Object3D
var quaternion: Quaternion

Attributes

Inherited from:
Object3D
var receiveShadow: Boolean

Attributes

Inherited from:
Object3D
var renderOrder: Double

Attributes

Inherited from:
Object3D
var rotation: Euler

Attributes

Inherited from:
Object3D
var scale: Vector3

Attributes

Inherited from:
Object3D
var userData: Object

Attributes

Inherited from:
Object3D
val uuid: String

Attributes

Inherited from:
Object3D
var visible: Boolean

Attributes

Inherited from:
Object3D
Generated with
Copyright (c) 2022-2025, Olivier NOUGUIER
Copyright (c) 2022-2025, Olivier NOUGUIER