Documentation / scene / PointLight

Class: PointLight

Defined in: libs/scene/src/scene/light.ts:556

Point light

Extends

• PunctualLight

Constructors

Constructor

new PointLight(scene): PointLight

Defined in: libs/scene/src/scene/light.ts:571

Creates an instance of point light

Parameters

scene

Scene

The scene to which the light belongs

Returns

PointLight

Overrides

PunctualLight.constructor

Properties

BBOXDRAW_INHERITED

readonly static BBOXDRAW_INHERITED: -1 = -1

Defined in: libs/scene/src/scene/scene_node.ts:168

Bounding-box draw mode inherited from nearest graph ancestor.

Inherited from

PunctualLight.BBOXDRAW_INHERITED

---

BBOXDRAW_DISABLED

readonly static BBOXDRAW_DISABLED: 0 = 0

Defined in: libs/scene/src/scene/scene_node.ts:170

Disable bounding-box visualization.

Inherited from

PunctualLight.BBOXDRAW_DISABLED

---

BBOXDRAW_LOCAL

readonly static BBOXDRAW_LOCAL: 1 = 1

Defined in: libs/scene/src/scene/scene_node.ts:172

Draw local-space bounding box.

Inherited from

PunctualLight.BBOXDRAW_LOCAL

---

BBOXDRAW_WORLD

readonly static BBOXDRAW_WORLD: 2 = 2

Defined in: libs/scene/src/scene/scene_node.ts:174

Draw world-space bounding box.

Inherited from

PunctualLight.BBOXDRAW_WORLD

Accessors

disposed

Get Signature

get disposed(): boolean

Defined in: libs/base/dist/index.d.ts:6107

Returns

boolean

Inherited from

PunctualLight.disposed

---

lightType

Get Signature

get lightType(): number

Defined in: libs/scene/src/scene/light.ts:58

Gets the light type

Returns

number

Inherited from

PunctualLight.lightType

---

intensity

Get Signature

get intensity(): number

Defined in: libs/scene/src/scene/light.ts:62

Intensity of the light

Returns

number

Set Signature

set intensity(val): void

Defined in: libs/scene/src/scene/light.ts:65

Parameters

val

number

Returns

void

Inherited from

PunctualLight.intensity

---

positionAndRange

Get Signature

get positionAndRange(): Immutable<Vector4>

Defined in: libs/scene/src/scene/light.ts:75

Position and range of the light

Remarks

Gets the position in world space of the light. Light range is encoded into the W component.

Returns

Immutable<Vector4>

Inherited from

PunctualLight.positionAndRange

---

directionAndCutoff

Get Signature

get directionAndCutoff(): Vector4

Defined in: libs/scene/src/scene/light.ts:88

Direction and cutoff of the light

Remarks

Gets the direction in world space of the light Light cutoff (for spot light only) is encoded into the W component.

Returns

Vector4

Inherited from

PunctualLight.directionAndCutoff

---

diffuseAndIntensity

Get Signature

get diffuseAndIntensity(): Vector4

Defined in: libs/scene/src/scene/light.ts:101

Color and intensity of the light

Remarks

Gets the color of the light. Light intensity is encoded into the W component.

Returns

Vector4

Inherited from

PunctualLight.diffuseAndIntensity

---

extraParams

Get Signature

get extraParams(): Vector4

Defined in: libs/scene/src/scene/light.ts:113

Extra parameters of the light

Remarks

Custom data for advanced light types.

Returns

Vector4

Inherited from

PunctualLight.extraParams

---

viewMatrix

Get Signature

get viewMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/scene/light.ts:126

View matrix of the light

Remarks

The view matrix of the light is used to transform a point from the world space to the light space.

Returns

Immutable<Matrix4x4>

Inherited from

PunctualLight.viewMatrix

---

color

Get Signature

get color(): Vector4

Defined in: libs/scene/src/scene/light.ts:220

Color of the light

Returns

Vector4

Set Signature

set color(color): void

Defined in: libs/scene/src/scene/light.ts:224

Parameters

color

Vector4

Returns

void

Inherited from

PunctualLight.color

---

castShadow

Get Signature

get castShadow(): boolean

Defined in: libs/scene/src/scene/light.ts:239

Whether this light casts shadows

Returns

boolean

Set Signature

set castShadow(b): void

Defined in: libs/scene/src/scene/light.ts:243

Parameters

b

boolean

Returns

void

Inherited from

PunctualLight.castShadow

---

shadow

Get Signature

get shadow(): ShadowMapper

Defined in: libs/scene/src/scene/light.ts:262

The shadow mapper for this light

Returns

ShadowMapper

Inherited from

PunctualLight.shadow

---

range

Get Signature

get range(): number

Defined in: libs/scene/src/scene/light.ts:581

The range of the light

Returns

number

Set Signature

set range(val): void

Defined in: libs/scene/src/scene/light.ts:584

Parameters

val

number

Returns

void

---

diffuseScale

Get Signature

get diffuseScale(): number

Defined in: libs/scene/src/scene/light.ts:588

Diffuse scale of the point light

Returns

number

Set Signature

set diffuseScale(val): void

Defined in: libs/scene/src/scene/light.ts:591

Parameters

val

number

Returns

void

---

specularScale

Get Signature

get specularScale(): number

Defined in: libs/scene/src/scene/light.ts:595

Specular scale of the point light

Returns

number

Set Signature

set specularScale(val): void

Defined in: libs/scene/src/scene/light.ts:598

Parameters

val

number

Returns

void

---

sourceRadius

Get Signature

get sourceRadius(): number

Defined in: libs/scene/src/scene/light.ts:602

Source radius of the point light

Returns

number

Set Signature

set sourceRadius(val): void

Defined in: libs/scene/src/scene/light.ts:605

Parameters

val

number

Returns

void

---

luminousIntensity

Get Signature

get luminousIntensity(): number

Defined in: libs/scene/src/scene/light.ts:609

Physical luminous intensity in candela.

Returns

number

Set Signature

set luminousIntensity(val): void

Defined in: libs/scene/src/scene/light.ts:612

Parameters

val

number

Returns

void

---

luminousPower

Get Signature

get luminousPower(): number

Defined in: libs/scene/src/scene/light.ts:628

One-sided luminous flux in lumen.

Remarks

Derived from luminousIntensity with Filament's point-light conversion, Φ = 4π·I.

Returns

number

Set Signature

set luminousPower(val): void

Defined in: libs/scene/src/scene/light.ts:631

Parameters

val

number

Returns

void

---

placeToOctree

Get Signature

get placeToOctree(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:317

Whether the node should be inserted into the scene's spatial structure.

Remarks

Toggling this hints the scene to (re)place the node in octree/acceleration structures.

Returns

boolean

Set Signature

set placeToOctree(val): void

Defined in: libs/scene/src/scene/scene_node.ts:320

Parameters

val

boolean

Returns

void

Inherited from

PunctualLight.placeToOctree

---

runtimeId

Get Signature

get runtimeId(): number

Defined in: libs/scene/src/scene/scene_node.ts:331

Node's runtime unique identifier

Returns

number

Inherited from

PunctualLight.runtimeId

---

persistentId

Get Signature

get persistentId(): string

Defined in: libs/scene/src/scene/scene_node.ts:340

Node's persistent identifier.

Remarks

Changing this affects serialization and registry lookup; ensure uniqueness.

Returns

string

Set Signature

set persistentId(id): void

Defined in: libs/scene/src/scene/scene_node.ts:343

Parameters

id

string

Returns

void

Inherited from

PunctualLight.persistentId

---

prefabId

Get Signature

get prefabId(): string

Defined in: libs/scene/src/scene/scene_node.ts:352

If not empty, this node was loaded from a prefab

Remarks

Internal used for serialization

Returns

string

Set Signature

set prefabId(id): void

Defined in: libs/scene/src/scene/scene_node.ts:355

Parameters

id

string

Returns

void

Inherited from

PunctualLight.prefabId

---

jointTypeT

Get Signature

get jointTypeT(): "none" | "animated" | "static"

Defined in: libs/scene/src/scene/scene_node.ts:371

Translation type if this is a joint node of any skeleton

Remarks

Internal used for serialization

Returns

"none" | "animated" | "static"

Set Signature

set jointTypeT(val): void

Defined in: libs/scene/src/scene/scene_node.ts:374

Parameters

val

"none" | "animated" | "static"

Returns

void

Inherited from

PunctualLight.jointTypeT

---

jointTypeS

Get Signature

get jointTypeS(): "none" | "animated" | "static"

Defined in: libs/scene/src/scene/scene_node.ts:383

Scale type if this is a joint node of any skeleton

Remarks

Internal used for serialization

Returns

"none" | "animated" | "static"

Set Signature

set jointTypeS(val): void

Defined in: libs/scene/src/scene/scene_node.ts:386

Parameters

val

"none" | "animated" | "static"

Returns

void

Inherited from

PunctualLight.jointTypeS

---

jointTypeR

Get Signature

get jointTypeR(): "none" | "animated" | "static"

Defined in: libs/scene/src/scene/scene_node.ts:395

Rotation type if this is a joint node of any skeleton

Remarks

Internal used for serialization

Returns

"none" | "animated" | "static"

Set Signature

set jointTypeR(val): void

Defined in: libs/scene/src/scene/scene_node.ts:398

Parameters

val

"none" | "animated" | "static"

Returns

void

Inherited from

PunctualLight.jointTypeR

---

metaData

Get Signature

get metaData(): Metadata

Defined in: libs/scene/src/scene/scene_node.ts:407

Arbitrary metadata associated with this node.

Remarks

Stored and transported with the node; format is application-defined.

Returns

Metadata

Set Signature

set metaData(val): void

Defined in: libs/scene/src/scene/scene_node.ts:410

Parameters

val

Metadata

Returns

void

Inherited from

PunctualLight.metaData

---

script

Get Signature

get script(): string

Defined in: libs/scene/src/scene/scene_node.ts:419

Attached script filename or identifier (engine-specific).

Remarks

Integrates with the engine’s scripting system if available.

Returns

string

Set Signature

set script(fileName): void

Defined in: libs/scene/src/scene/scene_node.ts:422

Parameters

fileName

string

Returns

void

Inherited from

PunctualLight.script

---

scriptConfig

Get Signature

get scriptConfig(): object | unknown[]

Defined in: libs/scene/src/scene/scene_node.ts:435

Script component configuration payload used by editor/runtime script components.

Returns

object | unknown[]

Set Signature

set scriptConfig(value): void

Defined in: libs/scene/src/scene/scene_node.ts:438

Parameters

value

object | unknown[]

Returns

void

Inherited from

PunctualLight.scriptConfig

---

scripts

Get Signature

get scripts(): ScriptAttachment[]

Defined in: libs/scene/src/scene/scene_node.ts:452

All script attachments on this node.

Returns

ScriptAttachment[]

Set Signature

set scripts(value): void

Defined in: libs/scene/src/scene/scene_node.ts:455

Parameters

value

ScriptAttachment[]

Returns

void

Inherited from

PunctualLight.scripts

---

scriptConfigs

Get Signature

get scriptConfigs(): unknown[]

Defined in: libs/scene/src/scene/scene_node.ts:461

Script configs for all script attachments.

Returns

unknown[]

Set Signature

set scriptConfigs(value): void

Defined in: libs/scene/src/scene/scene_node.ts:464

Parameters

value

unknown[]

Returns

void

Inherited from

PunctualLight.scriptConfigs

---

gpuClothComponents

Get Signature

get gpuClothComponents(): GPUClothComponent[]

Defined in: libs/scene/src/scene/scene_node.ts:477

GPU cloth simulations owned by this node.

Returns

GPUClothComponent[]

Set Signature

set gpuClothComponents(value): void

Defined in: libs/scene/src/scene/scene_node.ts:480

Parameters

value

GPUClothComponent[]

Returns

void

Inherited from

PunctualLight.gpuClothComponents

---

name

Get Signature

get name(): string

Defined in: libs/scene/src/scene/scene_node.ts:516

Display name of the node (for UI/debugging).

Returns

string

Set Signature

set name(val): void

Defined in: libs/scene/src/scene/scene_node.ts:519

Parameters

val

string

Returns

void

Inherited from

PunctualLight.name

---

scene

Get Signature

get scene(): Scene

Defined in: libs/scene/src/scene/scene_node.ts:523

The owning scene.

Returns

Scene

Inherited from

PunctualLight.scene

---

attached

Get Signature

get attached(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:529

Whether this node is currently attached under the scene's root.

Returns

boolean

Inherited from

PunctualLight.attached

---

sealed

Get Signature

get sealed(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:543

If true, the node is logically sealed; some operations (like cloning as child) may be restricted by engine policies.

Returns

boolean

Set Signature

set sealed(val): void

Defined in: libs/scene/src/scene/scene_node.ts:546

Parameters

val

boolean

Returns

void

Inherited from

PunctualLight.sealed

---

animationSet

Get Signature

get animationSet(): AnimationSet

Defined in: libs/scene/src/scene/scene_node.ts:555

Lazily created animation set for this node.

Remarks

Accessing this schedules the node for update in the scene.

Returns

AnimationSet

Inherited from

PunctualLight.animationSet

---

sharedModel

Get Signature

get sharedModel(): SharedModel

Defined in: libs/scene/src/scene/scene_node.ts:565

Shared model reference for instancing/streaming systems.

Returns

SharedModel

Set Signature

set sharedModel(model): void

Defined in: libs/scene/src/scene/scene_node.ts:568

Parameters

model

SharedModel

Returns

void

Inherited from

PunctualLight.sharedModel

---

morphTargetGroups

Get Signature

get morphTargetGroups(): SceneMorphTargetGroup[]

Defined in: libs/scene/src/scene/scene_node.ts:572

Runtime morph target groups bound to this model instance.

Returns

SceneMorphTargetGroup[]

Set Signature

set morphTargetGroups(groups): void

Defined in: libs/scene/src/scene/scene_node.ts:575

Parameters

groups

SceneMorphTargetGroup[]

Returns

void

Inherited from

PunctualLight.morphTargetGroups

---

clipTestEnabled

Get Signature

get clipTestEnabled(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:820

Clip mode

Returns

boolean

Set Signature

set clipTestEnabled(val): void

Defined in: libs/scene/src/scene/scene_node.ts:823

Parameters

val

boolean

Returns

void

Inherited from

PunctualLight.clipTestEnabled

---

hidden

Get Signature

get hidden(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:827

Computed value of show state

Returns

boolean

Inherited from

PunctualLight.hidden

---

showState

Get Signature

get showState(): SceneNodeVisible

Defined in: libs/scene/src/scene/scene_node.ts:835

Show state

Returns

SceneNodeVisible

Set Signature

set showState(val): void

Defined in: libs/scene/src/scene/scene_node.ts:838

Parameters

val

SceneNodeVisible

Returns

void

Inherited from

PunctualLight.showState

---

pickable

Get Signature

get pickable(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:856

Whether this node is enabled for CPU picking

Returns

boolean

Set Signature

set pickable(val): void

Defined in: libs/scene/src/scene/scene_node.ts:859

Parameters

val

boolean

Returns

void

Inherited from

PunctualLight.pickable

---

gpuPickable

Get Signature

get gpuPickable(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:863

Whether this node is enabled for GPU picking

Returns

boolean

Set Signature

set gpuPickable(val): void

Defined in: libs/scene/src/scene/scene_node.ts:866

Parameters

val

boolean

Returns

void

Inherited from

PunctualLight.gpuPickable

---

computedBoundingBoxDrawMode

Get Signature

get computedBoundingBoxDrawMode(): number

Defined in: libs/scene/src/scene/scene_node.ts:948

Computed value for bounding box draw mode

Returns

number

Inherited from

PunctualLight.computedBoundingBoxDrawMode

---

boundingBoxDrawMode

Get Signature

get boundingBoxDrawMode(): number

Defined in: libs/scene/src/scene/scene_node.ts:959

Bounding box draw mode

Returns

number

Set Signature

set boundingBoxDrawMode(mode): void

Defined in: libs/scene/src/scene/scene_node.ts:962

Parameters

mode

number

Returns

void

Inherited from

PunctualLight.boundingBoxDrawMode

---

parent

Get Signature

get parent(): SceneNode

Defined in: libs/scene/src/scene/scene_node.ts:1262

Parent of the xform

Returns

SceneNode

Set Signature

set parent(p): void

Defined in: libs/scene/src/scene/scene_node.ts:1265

Parameters

p

SceneNode

Returns

void

Inherited from

PunctualLight.parent

---

children

Get Signature

get children(): SceneNode[]

Defined in: libs/scene/src/scene/scene_node.ts:1271

Children of this xform

Returns

SceneNode[]

Inherited from

PunctualLight.children

---

position

Get Signature

get position(): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1277

Position of the xform relative to it's parent

Returns

Vector3

Set Signature

set position(val): void

Defined in: libs/scene/src/scene/scene_node.ts:1280

Parameters

val

Vector3

Returns

void

Inherited from

PunctualLight.position

---

scale

Get Signature

get scale(): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1286

Scaling of the xform

Returns

Vector3

Set Signature

set scale(val): void

Defined in: libs/scene/src/scene/scene_node.ts:1289

Parameters

val

Vector3

Returns

void

Inherited from

PunctualLight.scale

---

rotation

Get Signature

get rotation(): Quaternion

Defined in: libs/scene/src/scene/scene_node.ts:1295

Rotation of the xform

Returns

Quaternion

Set Signature

set rotation(val): void

Defined in: libs/scene/src/scene/scene_node.ts:1298

Parameters

val

Quaternion

Returns

void

Inherited from

PunctualLight.rotation

---

localMatrix

Get Signature

get localMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/scene/scene_node.ts:1404

Local transformation matrix of the xform

Returns

Immutable<Matrix4x4>

Set Signature

set localMatrix(matrix): void

Defined in: libs/scene/src/scene/scene_node.ts:1411

Parameters

matrix

Immutable<Matrix4x4>

Returns

void

Inherited from

PunctualLight.localMatrix

---

worldMatrix

Get Signature

get worldMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/scene/scene_node.ts:1415

World transformation matrix of the xform

Returns

Immutable<Matrix4x4>

Inherited from

PunctualLight.worldMatrix

---

worldMatrixDet

Get Signature

get worldMatrixDet(): number

Defined in: libs/scene/src/scene/scene_node.ts:1420

The determinant of world matrix

Returns

number

Inherited from

PunctualLight.worldMatrixDet

---

invWorldMatrix

Get Signature

get invWorldMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/scene/scene_node.ts:1425

Inverse of the world transformation matrix of the xform

Returns

Immutable<Matrix4x4>

Inherited from

PunctualLight.invWorldMatrix

Methods

on()

Call Signature

on<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:671

IEventTarget.on

Type Parameters

K

K extends "dispose" | "nodeattached" | "noderemoved" | "visiblechanged" | "transformchanged" | "bvchanged"

Parameters

type

K

listener

EventListener<object & object, K>

context?

unknown

Returns

void

Inherited from

PunctualLight.on

Call Signature

on<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:630

IEventTarget.on

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener

EventListener<{ dispose: []; }, K>

context?

unknown

Returns

void

Inherited from

PunctualLight.on

---

once()

Call Signature

once<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:675

IEventTarget.once

Type Parameters

K

K extends "dispose" | "nodeattached" | "noderemoved" | "visiblechanged" | "transformchanged" | "bvchanged"

Parameters

type

K

listener

EventListener<object & object, K>

context?

unknown

Returns

void

Inherited from

PunctualLight.once

Call Signature

once<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:634

IEventTarget.once

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener

EventListener<{ dispose: []; }, K>

context?

unknown

Returns

void

Inherited from

PunctualLight.once

---

off()

Call Signature

off<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:679

IEventTarget.off

Type Parameters

K

K extends "dispose" | "nodeattached" | "noderemoved" | "visiblechanged" | "transformchanged" | "bvchanged"

Parameters

type

K

listener

EventListener<object & object, K>

context?

unknown

Returns

void

Inherited from

PunctualLight.off

Call Signature

off<K>(type, listener?, context?): void

Defined in: libs/base/dist/index.d.ts:638

IEventTarget.off

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener?

EventListener<{ dispose: []; }>

context?

unknown

Returns

void

Inherited from

PunctualLight.off

---

dispatchEvent()

Call Signature

dispatchEvent<K>(type, ...args): void

Defined in: libs/base/dist/index.d.ts:683

IEventTarget.dispatchEvent

Type Parameters

K

K extends "dispose" | "nodeattached" | "noderemoved" | "visiblechanged" | "transformchanged" | "bvchanged"

Parameters

type

K

args

...object & object[K]

Returns

void

Inherited from

PunctualLight.dispatchEvent

Call Signature

dispatchEvent<K>(type, ...args): void

Defined in: libs/base/dist/index.d.ts:642

IEventTarget.dispatchEvent

Type Parameters

K

K extends "dispose"

Parameters

type

K

args

...object[K]

Returns

void

Inherited from

PunctualLight.dispatchEvent

---

dispose()

dispose(): void

Defined in: libs/base/dist/index.d.ts:6108

Returns

void

Inherited from

PunctualLight.dispose

---

getName()

getName(): string

Defined in: libs/scene/src/scene/graph_node.ts:36

Gets the name

Returns

string

Inherited from

PunctualLight.getName

---

isGraphNode()

isGraphNode(): this is GraphNode

Defined in: libs/scene/src/scene/graph_node.ts:43

Type guard: true if this node is a graph node.

Returns

this is GraphNode

Inherited from

PunctualLight.isGraphNode

---

getNode()

getNode(): PointLight

Defined in: libs/scene/src/scene/graph_node.ts:49

Returns the owning scene node (transform and hierarchy).

Returns

PointLight

Inherited from

PunctualLight.getNode

---

getBoneMatrices()

getBoneMatrices(): Texture2D<unknown>

Defined in: libs/scene/src/scene/graph_node.ts:55

Returns the texture containing bone matrices for skinned meshes.

Returns

Texture2D<unknown>

Inherited from

PunctualLight.getBoneMatrices

---

getSortDistance()

getSortDistance(camera): number

Defined in: libs/scene/src/scene/graph_node.ts:61

Computes the distance used for sorting (e.g., transparent draw order).

Parameters

camera

Camera

Camera from which to compute distance (usually camera -> object).

Returns

number

Inherited from

PunctualLight.getSortDistance

---

isBatchable()

isBatchable(): this is BatchDrawable

Defined in: libs/scene/src/scene/graph_node.ts:72

Returns true if the object supports instanced rendering.

When true, the object should also implement the BatchDrawable methods.

Returns

this is BatchDrawable

Inherited from

PunctualLight.isBatchable

---

setIntensity()

setIntensity(val): PointLight

Defined in: libs/scene/src/scene/light.ts:134

Sets the intensity of the light

Parameters

val

number

Intensity of the light

Returns

PointLight

self

Inherited from

PunctualLight.setIntensity

---

isLight()

isLight(): this is BaseLight

Defined in: libs/scene/src/scene/light.ts:149

Type guard: true if this node is a light.

Returns

this is BaseLight

Inherited from

PunctualLight.isLight

---

isDirectionLight()

isDirectionLight(): this is DirectionalLight

Defined in: libs/scene/src/scene/light.ts:157

returns true if this is a directional light

Returns

this is DirectionalLight

Inherited from

PunctualLight.isDirectionLight

---

isSpotLight()

isSpotLight(): this is SpotLight

Defined in: libs/scene/src/scene/light.ts:165

returns true if this is a spot light

Returns

this is SpotLight

Inherited from

PunctualLight.isSpotLight

---

isRectLight()

isRectLight(): this is RectLight

Defined in: libs/scene/src/scene/light.ts:169

returns true if this is a rect light

Returns

this is RectLight

Inherited from

PunctualLight.isRectLight

---

setColor()

setColor(color): PointLight

Defined in: libs/scene/src/scene/light.ts:232

Sets color of the light

Parameters

color

Vector4 | Vector3

The color to set

Returns

PointLight

self

Inherited from

PunctualLight.setColor

---

setCastShadow()

setCastShadow(b): this

Defined in: libs/scene/src/scene/light.ts:251

Sets whether this light casts shadows

Parameters

b

boolean

true if the light casts shadows

Returns

this

self

Inherited from

PunctualLight.setCastShadow

---

isPunctualLight()

isPunctualLight(): this is PunctualLight

Defined in: libs/scene/src/scene/light.ts:270

true if this is a punctual light node, false otherwise

Returns

this is PunctualLight

Inherited from

PunctualLight.isPunctualLight

---

onDispose()

protected onDispose(): void

Defined in: libs/scene/src/scene/light.ts:279

Disposes the punctual light node

Returns

void

Inherited from

PunctualLight.onDispose

---

setRange()

setRange(val): PointLight

Defined in: libs/scene/src/scene/light.ts:639

Sets the range of the light

Parameters

val

number

The value to set

Returns

PointLight

self

---

setDiffuseScale()

setDiffuseScale(val): PointLight

Defined in: libs/scene/src/scene/light.ts:653

Sets the diffuse scale of the light

Parameters

val

number

The value to set

Returns

PointLight

self

---

setSpecularScale()

setSpecularScale(val): PointLight

Defined in: libs/scene/src/scene/light.ts:666

Sets the specular scale of the light

Parameters

val

number

The value to set

Returns

PointLight

self

---

setSourceRadius()

setSourceRadius(val): PointLight

Defined in: libs/scene/src/scene/light.ts:679

Sets the source radius of the light

Parameters

val

number

The value to set

Returns

PointLight

self

---

isPointLight()

isPointLight(): this is PointLight

Defined in: libs/scene/src/scene/light.ts:691

returns true if this is a point light

Returns

this is PointLight

Overrides

PunctualLight.isPointLight

---

getPrefabNode()

getPrefabNode(): SceneNode

Defined in: libs/scene/src/scene/scene_node.ts:362

Get prefab node this node belongs to, or null if this node does not belongs to any prefab

Returns

SceneNode

prefab node this node belongs to

Inherited from

PunctualLight.getPrefabNode

---

addGPUClothComponent()

addGPUClothComponent(component): GPUClothComponent

Defined in: libs/scene/src/scene/scene_node.ts:501

Adds a GPU cloth component to this node.

Parameters

component

GPUClothComponent

Returns

GPUClothComponent

Inherited from

PunctualLight.addGPUClothComponent

---

removeGPUClothComponent()

removeGPUClothComponent(component): boolean

Defined in: libs/scene/src/scene/scene_node.ts:506

Removes and disposes a GPU cloth component from this node.

Parameters

component

GPUClothComponent

Returns

boolean

Inherited from

PunctualLight.removeGPUClothComponent

---

clone()

clone(): Promise<PointLight>

Defined in: libs/scene/src/scene/scene_node.ts:589

Clone this node.

Returns

Promise<PointLight>

New node instance

Remarks

If a shared model exists, it may create an instanced node. The clone is attached under the same parent; children are cloned based on method and recursive.

Inherited from

PunctualLight.clone

---

hasChild()

hasChild(child): boolean

Defined in: libs/scene/src/scene/scene_node.ts:619

Whether the given node is a direct child of this node.

Parameters

child

SceneNode

The node to be checked

Returns

boolean

true if the given node is a direct child of this node, false otherwise

Inherited from

PunctualLight.hasChild

---

removeChildren()

removeChildren(): void

Defined in: libs/scene/src/scene/scene_node.ts:625

Remove all children from this node.

Returns

void

Inherited from

PunctualLight.removeChildren

---

isParentOf()

isParentOf(child): boolean

Defined in: libs/scene/src/scene/scene_node.ts:633

Whether this node is an ancestor (direct or indirect) of the given node.

Parameters

child

SceneNode

Returns

boolean

Inherited from

PunctualLight.isParentOf

---

remove()

remove(): PointLight

Defined in: libs/scene/src/scene/scene_node.ts:644

Detach this node from its parent.

Returns

PointLight

this

Inherited from

PunctualLight.remove

---

traverse()

traverse(v): void

Defined in: libs/scene/src/scene/scene_node.ts:653

Depth-first traversal of this node's subtree (pre-order).

Parameters

v

Visitor<SceneNode>

Visitor invoked on each node.

Returns

void

Inherited from

PunctualLight.traverse

---

iterate()

iterate(callback): boolean

Defined in: libs/scene/src/scene/scene_node.ts:667

Iterate self and descendants in pre-order.

Warning: Do not remove children during this iteration. To allow removal, use iterateBottomToTop.

Parameters

callback

NodeIterateFunc

Called for each node; if returns true, iteration stops.

Returns

boolean

If returns true, the iteration will immediately stop.

Inherited from

PunctualLight.iterate

---

iterateBottomToTop()

iterateBottomToTop(callback): boolean

Defined in: libs/scene/src/scene/scene_node.ts:686

Iterate self and descendants in reverse post-order (bottom-to-top).

Child nodes can be safely removed during this iteration.

Parameters

callback

NodeIterateFunc

Called for each node; if returns true, iteration stops.

Returns

boolean

If returns true, the iteration will immediately stop.

Inherited from

PunctualLight.iterateBottomToTop

---

isMesh()

isMesh(): this is Mesh

Defined in: libs/scene/src/scene/scene_node.ts:707

Type guard: true if this node is a mesh.

Returns

this is Mesh

Inherited from

PunctualLight.isMesh

---

isSprite()

isSprite(): this is Sprite

Defined in: libs/scene/src/scene/scene_node.ts:711

Type guard: true if this node is a sprite

Returns

this is Sprite

Inherited from

PunctualLight.isSprite

---

isMSDFTextSprite()

isMSDFTextSprite(): this is MSDFTextSprite

Defined in: libs/scene/src/scene/scene_node.ts:715

Type guard: true if this node is a MSDF text sprite

Returns

this is MSDFTextSprite

Inherited from

PunctualLight.isMSDFTextSprite

---

isMSDFText()

isMSDFText(): this is MSDFText

Defined in: libs/scene/src/scene/scene_node.ts:719

Type guard: true if this node is a MSDF text sprite

Returns

this is MSDFText

Inherited from

PunctualLight.isMSDFText

---

isWater()

isWater(): this is Water

Defined in: libs/scene/src/scene/scene_node.ts:723

Type guard: true if this node is a water node.

Returns

this is Water

Inherited from

PunctualLight.isWater

---

isHair()

isHair(): this is HairNode

Defined in: libs/scene/src/scene/scene_node.ts:727

Type guard: true if this node is a hair node.

Returns

this is HairNode

Inherited from

PunctualLight.isHair

---

isParticleSystem()

isParticleSystem(): this is ParticleSystem

Defined in: libs/scene/src/scene/scene_node.ts:731

Type guard: true if this node is a particle system.

Returns

this is ParticleSystem

Inherited from

PunctualLight.isParticleSystem

---

isBatchGroup()

isBatchGroup(): this is BatchGroup

Defined in: libs/scene/src/scene/scene_node.ts:735

Type guard: true if this node is a batch group.

Returns

this is BatchGroup

Inherited from

PunctualLight.isBatchGroup

---

isClipmapTerrain()

isClipmapTerrain(): this is ClipmapTerrain

Defined in: libs/scene/src/scene/scene_node.ts:739

Type guard: true if this node is a clipmap terrain.

Returns

this is ClipmapTerrain

Inherited from

PunctualLight.isClipmapTerrain

---

isCamera()

isCamera(): this is Camera

Defined in: libs/scene/src/scene/scene_node.ts:743

true if this is a camera node, false otherwise

Returns

this is Camera

Inherited from

PunctualLight.isCamera

---

getBoundingVolume()

getBoundingVolume(): BoundingVolume

Defined in: libs/scene/src/scene/scene_node.ts:761

Gets the bounding volume of the node

Returns

BoundingVolume

The bounding volume of the node

Inherited from

PunctualLight.getBoundingVolume

---

setBoundingVolume()

setBoundingVolume(bv): void

Defined in: libs/scene/src/scene/scene_node.ts:772

Sets the bounding volume of the node

Parameters

bv

BoundingVolume

The bounding volume to set

Returns

void

Inherited from

PunctualLight.setBoundingVolume

---

getWorldBoundingVolume()

getWorldBoundingVolume(): BoundingVolume

Defined in: libs/scene/src/scene/scene_node.ts:783

Gets the world space bounding volume of the node

Returns

BoundingVolume

The world space bounding volume of the node

Inherited from

PunctualLight.getWorldBoundingVolume

---

computeWorldBoundingVolume()

computeWorldBoundingVolume(localBV): BoundingVolume

Defined in: libs/scene/src/scene/scene_node.ts:793

Computes the world space bounding volume of the node

Parameters

localBV

BoundingVolume

Returns

BoundingVolume

The output bounding volume

Inherited from

PunctualLight.computeWorldBoundingVolume

---

invalidateBoundingVolume()

invalidateBoundingVolume(): void

Defined in: libs/scene/src/scene/scene_node.ts:799

Force the bounding volume to be recalculated

Returns

void

Inherited from

PunctualLight.invalidateBoundingVolume

---

invalidateWorldBoundingVolume()

invalidateWorldBoundingVolume(transformChanged): void

Defined in: libs/scene/src/scene/scene_node.ts:804

Force the world space bounding volume to be recalculated

Parameters

transformChanged

boolean

Returns

void

Inherited from

PunctualLight.invalidateWorldBoundingVolume

---

findNodeById()

findNodeById<T>(id): T

Defined in: libs/scene/src/scene/scene_node.ts:876

Finds a scene node by its persistent ID.

Type Parameters

T

T extends SceneNode

Expected node type.

Parameters

id

string

Persistent identifier to match against SceneNode.persistentId.

Returns

T

The first matching node, or null if not found.

Inherited from

PunctualLight.findNodeById

---

findSkeletonById()

findSkeletonById(id): SkinBinding

Defined in: libs/scene/src/scene/scene_node.ts:891

Finds a skeleton object by its persistent ID.

Parameters

id

string

Persistent identifier to match against Skeleton.persistentId.

Returns

SkinBinding

The first matchign node, or null if not found.

Inherited from

PunctualLight.findSkeletonById

---

findSkinBindingById()

findSkinBindingById(id): SkinBinding

Defined in: libs/scene/src/scene/scene_node.ts:899

Finds a skin binding by its persistent ID.

Parameters

id

string

Persistent identifier to match against SkinBinding.persistentId.

Returns

SkinBinding

The first matching binding, or null if not found.

Inherited from

PunctualLight.findSkinBindingById

---

findSkeletonRigById()

findSkeletonRigById(id): SkeletonRig

Defined in: libs/scene/src/scene/scene_node.ts:914

Finds a shared skeleton rig by its persistent ID.

Parameters

id

string

Persistent identifier to match against SkeletonRig.persistentId.

Returns

SkeletonRig

The first matching rig, or null if not found.

Inherited from

PunctualLight.findSkeletonRigById

---

findNodeByName()

findNodeByName<T>(name): T

Defined in: libs/scene/src/scene/scene_node.ts:936

Finds a scene node by name.

If multiple nodes share the same name, returns the first match encountered during traversal.

Type Parameters

T

T extends SceneNode

Expected node type.

Parameters

name

string

Node name to match.

Returns

T

The first matching node, or null if not found.

Remarks

Names are not guaranteed unique. Prefer IDs for stable references.

Inherited from

PunctualLight.findNodeByName

---

getSerializedMorphTargetGroups()

getSerializedMorphTargetGroups(): SerializedMorphTargetGroup[]

Defined in: libs/scene/src/scene/scene_node.ts:1019

Returns serialized morph target groups for this node.

Returns

SerializedMorphTargetGroup[]

Inherited from

PunctualLight.getSerializedMorphTargetGroups

---

setSerializedMorphTargetGroups()

setSerializedMorphTargetGroups(groups): void

Defined in: libs/scene/src/scene/scene_node.ts:1037

Restores serialized morph target groups for this node.

Parameters

groups

SerializedMorphTargetGroup[]

Returns

void

Inherited from

PunctualLight.setSerializedMorphTargetGroups

---

invalidateTransform()

invalidateTransform(invalidateLocal?): void

Defined in: libs/scene/src/scene/scene_node.ts:1073

Force transform update and notify descendants.

Parameters

invalidateLocal?

boolean = true

If true, also invalidate local matrix; otherwise only invalidate world matrix.

Returns

void

Inherited from

PunctualLight.invalidateTransform

---

setMorphTargetWeight()

setMorphTargetWeight(name, weight): void

Defined in: libs/scene/src/scene/scene_node.ts:1081

Set morph target weight by name for all meshes in the subtree.

Parameters

name

string

Morph target name

weight

number

Morph target weight

Returns

void

Inherited from

PunctualLight.setMorphTargetWeight

---

setMorphTargetGroupWeight()

setMorphTargetGroupWeight(name, weight): void

Defined in: libs/scene/src/scene/scene_node.ts:1097

Set morph target group weight for the model instance.

Parameters

name

string

Morph target group name

weight

number

Group weight

Returns

void

Inherited from

PunctualLight.setMorphTargetGroupWeight

---

getMorphTargetGroupWeight()

getMorphTargetGroupWeight(name): number

Defined in: libs/scene/src/scene/scene_node.ts:1119

Get morph target group weight.

Parameters

name

string

Morph target group name

Returns

number

The group weight, or 0 if no group was found

Inherited from

PunctualLight.getMorphTargetGroupWeight

---

collectMorphTargetNames()

collectMorphTargetNames(): string[]

Defined in: libs/scene/src/scene/scene_node.ts:1127

Collect all morph target names from meshes in the subtree.

Returns

string[]

Array of unique morph target names

Inherited from

PunctualLight.collectMorphTargetNames

---

collectMorphTargetGroupNames()

collectMorphTargetGroupNames(): string[]

Defined in: libs/scene/src/scene/scene_node.ts:1143

Collect all model-level morph target group names.

Returns

string[]

Array of morph target group names

Inherited from

PunctualLight.collectMorphTargetGroupNames

---

onPostClone()

protected onPostClone(): void | Promise<void>

Defined in: libs/scene/src/scene/scene_node.ts:1152

Get called when the node was just created by cloning from other node

Returns

void | Promise<void>

Inherited from

PunctualLight.onPostClone

---

_onAttached()

protected _onAttached(): void

Defined in: libs/scene/src/scene/scene_node.ts:1226

Get called when this node is attached to scene

Returns

void

Inherited from

PunctualLight._onAttached

---

_onDetached()

protected _onDetached(): void

Defined in: libs/scene/src/scene/scene_node.ts:1230

Get called when this node is detached from scene

Returns

void

Inherited from

PunctualLight._onDetached

---

worldToThis()

Call Signature

worldToThis(v, result?): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1307

Transform world coordinate to local space

Parameters

v

Vector3

point or vector in world space

result?

Vector3

The output result

Returns

Vector3

The transformed local space coordinate

Inherited from

PunctualLight.worldToThis

Call Signature

worldToThis(v, result?): Vector4

Defined in: libs/scene/src/scene/scene_node.ts:1308

Transform world coordinate to local space

Parameters

v

Vector4

point or vector in world space

result?

Vector4

The output result

Returns

Vector4

The transformed local space coordinate

Inherited from

PunctualLight.worldToThis

---

otherToThis()

Call Signature

otherToThis(other, v, result?): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1327

Transform coordinate in other coordinate space to local space

Parameters

other

SceneNode

The other coordinate space

v

Vector3

point or vector in other coordinate space

result?

Vector3

The output result

Returns

Vector3

The transformed local space coordinate

Inherited from

PunctualLight.otherToThis

Call Signature

otherToThis(other, v, result?): Vector4

Defined in: libs/scene/src/scene/scene_node.ts:1328

Transform coordinate in other coordinate space to local space

Parameters

other

SceneNode

The other coordinate space

v

Vector4

point or vector in other coordinate space

result?

Vector4

The output result

Returns

Vector4

The transformed local space coordinate

Inherited from

PunctualLight.otherToThis

---

thisToWorld()

Call Signature

thisToWorld(v, result?): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1338

Transform local coordinate to world space

Parameters

v

Vector3

point or vector in local space

result?

Vector3

The output result

Returns

Vector3

The transformed world space coordinate

Inherited from

PunctualLight.thisToWorld

Call Signature

thisToWorld(v, result?): Vector4

Defined in: libs/scene/src/scene/scene_node.ts:1339

Transform local coordinate to world space

Parameters

v

Vector4

point or vector in local space

result?

Vector4

The output result

Returns

Vector4

The transformed world space coordinate

Inherited from

PunctualLight.thisToWorld

---

thisToOther()

Call Signature

thisToOther(other, v, result?): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1358

Transform local space coordinate to other coordinate space

Parameters

other

SceneNode

The other coordinate space

v

Vector3

point or vector in localspace

result?

Vector3

The output result

Returns

Vector3

The transformed coordinate in other coordinate space

Inherited from

PunctualLight.thisToOther

Call Signature

thisToOther(other, v, result?): Vector4

Defined in: libs/scene/src/scene/scene_node.ts:1359

Transform local space coordinate to other coordinate space

Parameters

other

SceneNode

The other coordinate space

v

Vector4

point or vector in localspace

result?

Vector4

The output result

Returns

Vector4

The transformed coordinate in other coordinate space

Inherited from

PunctualLight.thisToOther

---

getWorldPosition()

getWorldPosition(outPos?): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1367

Gets the position of the xform in world space

Parameters

outPos?

Vector3

Returns

Vector3

position of the xform in world space

Inherited from

PunctualLight.getWorldPosition

---

moveBy()

moveBy(delta): PointLight

Defined in: libs/scene/src/scene/scene_node.ts:1378

Moves the xform by an offset vector

Parameters

delta

Vector3

The offset vector

Returns

PointLight

self

Inherited from

PunctualLight.moveBy

---

scaleBy()

scaleBy(factor): PointLight

Defined in: libs/scene/src/scene/scene_node.ts:1387

Scales the xform by a given scale factor

Parameters

factor

Vector3

The scale factor

Returns

PointLight

self

Inherited from

PunctualLight.scaleBy

---

setLocalTransform()

setLocalTransform(matrix): PointLight

Defined in: libs/scene/src/scene/scene_node.ts:1396

Sets the local transform matrix of the xform

Parameters

matrix

Matrix4x4

The transform matrix to set

Returns

PointLight

self

Inherited from

PunctualLight.setLocalTransform

---

calculateLocalTransform()

calculateLocalTransform(outMatrix): void

Defined in: libs/scene/src/scene/scene_node.ts:1433

Calculate local transform matrix

Parameters

outMatrix

Matrix4x4

Matrix object that holds the result of calculation

Returns

void

Inherited from

PunctualLight.calculateLocalTransform

---

calculateWorldTransform()

calculateWorldTransform(outMatrix): void

Defined in: libs/scene/src/scene/scene_node.ts:1440

Calculate world transform matrix

Parameters

outMatrix

Matrix4x4

Matrix object that holds the result of calculation

Returns

void

Inherited from

PunctualLight.calculateWorldTransform

---

lookAt()

lookAt(eye, target, up): PointLight

Defined in: libs/scene/src/scene/scene_node.ts:1454

Sets the local tranformation matrix by a look-at matrix

Parameters

eye

Vector3

The eye position used to make the look-at matrix

target

Vector3

The target position used to make the look-at matrix

up

Vector3

The up vector used to make the look-at matrix

Returns

PointLight

self

Inherited from

PunctualLight.lookAt

---

update()

update(frameId, elapsedInSeconds, deltaInSeconds): void

Defined in: libs/scene/src/scene/scene_node.ts:1464

Update node state once per-frame

Parameters

frameId

number

Current frame id

elapsedInSeconds

number

Elapsed time from game start in seconds

deltaInSeconds

number

Elapsed time since previous frame in seconds

Returns

void

Inherited from

PunctualLight.update

---

updatePerCamera()

updatePerCamera(_camera, _elapsedInSeconds, _deltaInSeconds): void

Defined in: libs/scene/src/scene/scene_node.ts:1484

Update node state once per-camera

Parameters

_camera

Camera

Updates according to which camera

_elapsedInSeconds

number

Elapsed time from game start in seconds

_deltaInSeconds

number

Elapsed time since previous frame in seconds

Returns

void

Inherited from

PunctualLight.updatePerCamera

---

reparent()

reparent(p?): PointLight

Defined in: libs/scene/src/scene/scene_node.ts:1490

Removes this node from it's parent and add this node to another parent node if required

Parameters

p?

SceneNode

The new parent node that this node should be added to or null

Returns

PointLight

self

Inherited from

PunctualLight.reparent