Zephyr3d

Appearance

Documentation / scene / PunctualLight

Class: PunctualLight ​

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

Base class for any kind of puncual light

Extends ​

Extended by ​

Constructors ​

Constructor ​

new PunctualLight(scene, type): PunctualLight

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

Creates an instance of punctual light

Parameters ​

scene ​

Scene

The scene to which the punctual light belongs

type ​

number

The light type

Returns ​

PunctualLight

Overrides ​

BaseLight.constructor

Properties ​

BBOXDRAW_INHERITED ​

readonly static BBOXDRAW_INHERITED: -1 = -1

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

Bounding-box draw mode inherited from nearest graph ancestor.

Inherited from ​

BaseLight.BBOXDRAW_INHERITED

BBOXDRAW_DISABLED ​

readonly static BBOXDRAW_DISABLED: 0 = 0

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

Disable bounding-box visualization.

Inherited from ​

BaseLight.BBOXDRAW_DISABLED

BBOXDRAW_LOCAL ​

readonly static BBOXDRAW_LOCAL: 1 = 1

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

Draw local-space bounding box.

Inherited from ​

BaseLight.BBOXDRAW_LOCAL

BBOXDRAW_WORLD ​

readonly static BBOXDRAW_WORLD: 2 = 2

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

Draw world-space bounding box.

Inherited from ​

BaseLight.BBOXDRAW_WORLD

Accessors ​

disposed ​

Get Signature ​

get disposed(): boolean

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

Returns ​

boolean

Inherited from ​

BaseLight.disposed

lightType ​

Get Signature ​

get lightType(): number

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

Gets the light type

Returns ​

number

Inherited from ​

BaseLight.lightType

intensity ​

Get Signature ​

get intensity(): number

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

Intensity of the light

Returns ​

number

Set Signature ​

set intensity(val): void

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

Parameters ​
val ​

number

Returns ​

void

Inherited from ​

BaseLight.intensity

positionAndRange ​

Get Signature ​

get positionAndRange(): Immutable<Vector4>

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

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 ​

BaseLight.positionAndRange

directionAndCutoff ​

Get Signature ​

get directionAndCutoff(): Vector4

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

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 ​

BaseLight.directionAndCutoff

diffuseAndIntensity ​

Get Signature ​

get diffuseAndIntensity(): Vector4

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

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 ​

BaseLight.diffuseAndIntensity

extraParams ​

Get Signature ​

get extraParams(): Vector4

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

Extra parameters of the light

Remarks ​

Custom data for advanced light types.

Returns ​

Vector4

Inherited from ​

BaseLight.extraParams

viewMatrix ​

Get Signature ​

get viewMatrix(): Immutable<Matrix4x4>

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

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 ​

BaseLight.viewMatrix

color ​

Get Signature ​

get color(): Vector4

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

Color of the light

Returns ​

Vector4

Set Signature ​

set color(color): void

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

Parameters ​
color ​

Vector4

Returns ​

void

castShadow ​

Get Signature ​

get castShadow(): boolean

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

Whether this light casts shadows

Returns ​

boolean

Set Signature ​

set castShadow(b): void

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

Parameters ​
b ​

boolean

Returns ​

void

shadow ​

Get Signature ​

get shadow(): ShadowMapper

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

The shadow mapper for this light

Returns ​

ShadowMapper

placeToOctree ​

Get Signature ​

get placeToOctree(): boolean

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

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:315

Parameters ​
val ​

boolean

Returns ​

void

Inherited from ​

BaseLight.placeToOctree

runtimeId ​

Get Signature ​

get runtimeId(): number

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

Node's runtime unique identifier

Returns ​

number

Inherited from ​

PerspectiveCamera.runtimeId

persistentId ​

Get Signature ​

get persistentId(): string

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

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:338

Parameters ​
id ​

string

Returns ​

void

Inherited from ​

BaseLight.persistentId

prefabId ​

Get Signature ​

get prefabId(): string

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

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:350

Parameters ​
id ​

string

Returns ​

void

Inherited from ​

BaseLight.prefabId

jointTypeT ​

Get Signature ​

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

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

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:369

Parameters ​
val ​

"none" | "animated" | "static"

Returns ​

void

Inherited from ​

BaseLight.jointTypeT

jointTypeS ​

Get Signature ​

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

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

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:381

Parameters ​
val ​

"none" | "animated" | "static"

Returns ​

void

Inherited from ​

BaseLight.jointTypeS

jointTypeR ​

Get Signature ​

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

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

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:393

Parameters ​
val ​

"none" | "animated" | "static"

Returns ​

void

Inherited from ​

BaseLight.jointTypeR

metaData ​

Get Signature ​

get metaData(): Metadata

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

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:405

Parameters ​
val ​

Metadata

Returns ​

void

Inherited from ​

BaseLight.metaData

script ​

Get Signature ​

get script(): string

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

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:417

Parameters ​
fileName ​

string

Returns ​

void

Inherited from ​

BaseLight.script

scriptConfig ​

Get Signature ​

get scriptConfig(): object | unknown[]

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

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:433

Parameters ​
value ​

object | unknown[]

Returns ​

void

Inherited from ​

BaseLight.scriptConfig

scripts ​

Get Signature ​

get scripts(): ScriptAttachment[]

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

All script attachments on this node.

Returns ​

ScriptAttachment[]

Set Signature ​

set scripts(value): void

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

Parameters ​
value ​

ScriptAttachment[]

Returns ​

void

Inherited from ​

BaseLight.scripts

scriptConfigs ​

Get Signature ​

get scriptConfigs(): unknown[]

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

Script configs for all script attachments.

Returns ​

unknown[]

Set Signature ​

set scriptConfigs(value): void

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

Parameters ​
value ​

unknown[]

Returns ​

void

Inherited from ​

BaseLight.scriptConfigs

name ​

Get Signature ​

get name(): string

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

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:477

Parameters ​
val ​

string

Returns ​

void

Inherited from ​

BaseLight.name

scene ​

Get Signature ​

get scene(): Scene

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

The owning scene.

Returns ​

Scene

Inherited from ​

PerspectiveCamera.scene

attached ​

Get Signature ​

get attached(): boolean

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

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

Returns ​

boolean

Inherited from ​

PerspectiveCamera.attached

sealed ​

Get Signature ​

get sealed(): boolean

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

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:504

Parameters ​
val ​

boolean

Returns ​

void

Inherited from ​

BaseLight.sealed

animationSet ​

Get Signature ​

get animationSet(): AnimationSet

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

Lazily created animation set for this node.

Remarks ​

Accessing this schedules the node for update in the scene.

Returns ​

AnimationSet

Inherited from ​

PerspectiveCamera.animationSet

sharedModel ​

Get Signature ​

get sharedModel(): SharedModel

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

Shared model reference for instancing/streaming systems.

Returns ​

SharedModel

Set Signature ​

set sharedModel(model): void

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

Parameters ​
model ​

SharedModel

Returns ​

void

Inherited from ​

BaseLight.sharedModel

morphTargetGroups ​

Get Signature ​

get morphTargetGroups(): SceneMorphTargetGroup[]

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

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:533

Parameters ​
groups ​

SceneMorphTargetGroup[]

Returns ​

void

Inherited from ​

BaseLight.morphTargetGroups

clipTestEnabled ​

Get Signature ​

get clipTestEnabled(): boolean

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

Clip mode

Returns ​

boolean

Set Signature ​

set clipTestEnabled(val): void

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

Parameters ​
val ​

boolean

Returns ​

void

Inherited from ​

BaseLight.clipTestEnabled

hidden ​

Get Signature ​

get hidden(): boolean

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

Computed value of show state

Returns ​

boolean

Inherited from ​

PerspectiveCamera.hidden

showState ​

Get Signature ​

get showState(): SceneNodeVisible

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

Show state

Returns ​

SceneNodeVisible

Set Signature ​

set showState(val): void

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

Parameters ​
val ​

SceneNodeVisible

Returns ​

void

Inherited from ​

BaseLight.showState

pickable ​

Get Signature ​

get pickable(): boolean

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

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:813

Parameters ​
val ​

boolean

Returns ​

void

Inherited from ​

BaseLight.pickable

gpuPickable ​

Get Signature ​

get gpuPickable(): boolean

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

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:820

Parameters ​
val ​

boolean

Returns ​

void

Inherited from ​

BaseLight.gpuPickable

computedBoundingBoxDrawMode ​

Get Signature ​

get computedBoundingBoxDrawMode(): number

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

Computed value for bounding box draw mode

Returns ​

number

Inherited from ​

BaseLight.computedBoundingBoxDrawMode

boundingBoxDrawMode ​

Get Signature ​

get boundingBoxDrawMode(): number

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

Bounding box draw mode

Returns ​

number

Set Signature ​

set boundingBoxDrawMode(mode): void

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

Parameters ​
mode ​

number

Returns ​

void

Inherited from ​

BaseLight.boundingBoxDrawMode

parent ​

Get Signature ​

get parent(): SceneNode

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

Parent of the xform

Returns ​

SceneNode

Set Signature ​

set parent(p): void

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

Parameters ​
p ​

SceneNode

Returns ​

void

Inherited from ​

BaseLight.parent

children ​

Get Signature ​

get children(): SceneNode[]

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

Children of this xform

Returns ​

SceneNode[]

Inherited from ​

BaseLight.children

position ​

Get Signature ​

get position(): Vector3

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

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:1222

Parameters ​
val ​

Vector3

Returns ​

void

Inherited from ​

BaseLight.position

scale ​

Get Signature ​

get scale(): Vector3

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

Scaling of the xform

Returns ​

Vector3

Set Signature ​

set scale(val): void

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

Parameters ​
val ​

Vector3

Returns ​

void

Inherited from ​

BaseLight.scale

rotation ​

Get Signature ​

get rotation(): Quaternion

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

Rotation of the xform

Returns ​

Quaternion

Set Signature ​

set rotation(val): void

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

Parameters ​
val ​

Quaternion

Returns ​

void

Inherited from ​

BaseLight.rotation

localMatrix ​

Get Signature ​

get localMatrix(): Immutable<Matrix4x4>

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

Local transformation matrix of the xform

Returns ​

Immutable<Matrix4x4>

Set Signature ​

set localMatrix(matrix): void

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

Parameters ​
matrix ​

Immutable<Matrix4x4>

Returns ​

void

Inherited from ​

BaseLight.localMatrix

worldMatrix ​

Get Signature ​

get worldMatrix(): Immutable<Matrix4x4>

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

World transformation matrix of the xform

Returns ​

Immutable<Matrix4x4>

Inherited from ​

BaseLight.worldMatrix

worldMatrixDet ​

Get Signature ​

get worldMatrixDet(): number

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

The determinant of world matrix

Returns ​

number

Inherited from ​

BaseLight.worldMatrixDet

invWorldMatrix ​

Get Signature ​

get invWorldMatrix(): Immutable<Matrix4x4>

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

Inverse of the world transformation matrix of the xform

Returns ​

Immutable<Matrix4x4>

Inherited from ​

BaseLight.invWorldMatrix

Methods ​

on() ​

Call Signature ​

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

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

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 ​

BaseLight.on

Call Signature ​

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

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

IEventTarget.on

Type Parameters ​
K ​

K extends "dispose"

Parameters ​
type ​

K

listener ​

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

context? ​

unknown

Returns ​

void

Inherited from ​

BaseLight.on

once() ​

Call Signature ​

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

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

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 ​

BaseLight.once

Call Signature ​

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

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

IEventTarget.once

Type Parameters ​
K ​

K extends "dispose"

Parameters ​
type ​

K

listener ​

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

context? ​

unknown

Returns ​

void

Inherited from ​

BaseLight.once

off() ​

Call Signature ​

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

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

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 ​

BaseLight.off

Call Signature ​

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

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

IEventTarget.off

Type Parameters ​
K ​

K extends "dispose"

Parameters ​
type ​

K

listener? ​

EventListener<{ dispose: []; }>

context? ​

unknown

Returns ​

void

Inherited from ​

BaseLight.off

dispatchEvent() ​

Call Signature ​

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

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

IEventTarget.dispatchEvent

Type Parameters ​
K ​

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

Parameters ​
type ​

K

args ​

...object & object[K]

Returns ​

void

Inherited from ​

BaseLight.dispatchEvent

Call Signature ​

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

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

IEventTarget.dispatchEvent

Type Parameters ​
K ​

K extends "dispose"

Parameters ​
type ​

K

args ​

...object[K]

Returns ​

void

Inherited from ​

BaseLight.dispatchEvent

dispose() ​

dispose(): void

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

Returns ​

void

Inherited from ​

BaseLight.dispose

getName() ​

getName(): string

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

Gets the name

Returns ​

string

Inherited from ​

BaseLight.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 ​

BaseLight.isGraphNode

getNode() ​

getNode(): PunctualLight

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

Returns the owning scene node (transform and hierarchy).

Returns ​

PunctualLight

Inherited from ​

BaseLight.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 ​

BaseLight.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 ​

BaseLight.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 ​

BaseLight.isBatchable

setIntensity() ​

setIntensity(val): PunctualLight

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

Sets the intensity of the light

Parameters ​

val ​

number

Intensity of the light

Returns ​

PunctualLight

self

Inherited from ​

BaseLight.setIntensity

isLight() ​

isLight(): this is BaseLight

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

Type guard: true if this node is a light.

Returns ​

this is BaseLight

Inherited from ​

BaseLight.isLight

isDirectionLight() ​

isDirectionLight(): this is DirectionalLight

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

returns true if this is a directional light

Returns ​

this is DirectionalLight

Inherited from ​

BaseLight.isDirectionLight

isPointLight() ​

isPointLight(): this is PointLight

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

returns true if this is a point light

Returns ​

this is PointLight

Inherited from ​

BaseLight.isPointLight

isSpotLight() ​

isSpotLight(): this is SpotLight

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

returns true if this is a spot light

Returns ​

this is SpotLight

Inherited from ​

BaseLight.isSpotLight

isRectLight() ​

isRectLight(): this is RectLight

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

returns true if this is a rect light

Returns ​

this is RectLight

Inherited from ​

BaseLight.isRectLight

setColor() ​

setColor(color): PunctualLight

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

Sets color of the light

Parameters ​

color ​

Vector4 | Vector3

The color to set

Returns ​

PunctualLight

self

setCastShadow() ​

setCastShadow(b): this

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

Sets whether this light casts shadows

Parameters ​

b ​

boolean

true if the light casts shadows

Returns ​

this

self

isPunctualLight() ​

isPunctualLight(): this is PunctualLight

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

true if this is a punctual light node, false otherwise

Returns ​

this is PunctualLight

Overrides ​

BaseLight.isPunctualLight

onDispose() ​

protected onDispose(): void

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

Disposes the punctual light node

Returns ​

void

Overrides ​

BaseLight.onDispose

getPrefabNode() ​

getPrefabNode(): SceneNode

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

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 ​

BaseLight.getPrefabNode

clone() ​

clone(): Promise<PunctualLight>

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

Clone this node.

Returns ​

Promise<PunctualLight>

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 ​

BaseLight.clone

hasChild() ​

hasChild(child): boolean

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

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 ​

BaseLight.hasChild

removeChildren() ​

removeChildren(): void

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

Remove all children from this node.

Returns ​

void

Inherited from ​

BaseLight.removeChildren

isParentOf() ​

isParentOf(child): boolean

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

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

Parameters ​

child ​

SceneNode

Returns ​

boolean

Inherited from ​

BaseLight.isParentOf

remove() ​

remove(): PunctualLight

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

Detach this node from its parent.

Returns ​

PunctualLight

this

Inherited from ​

BaseLight.remove

traverse() ​

traverse(v): void

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

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

Parameters ​

v ​

Visitor<SceneNode>

Visitor invoked on each node.

Returns ​

void

Inherited from ​

BaseLight.traverse

iterate() ​

iterate(callback): boolean

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

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 ​

BaseLight.iterate

iterateBottomToTop() ​

iterateBottomToTop(callback): boolean

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

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 ​

BaseLight.iterateBottomToTop

isMesh() ​

isMesh(): this is Mesh

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

Type guard: true if this node is a mesh.

Returns ​

this is Mesh

Inherited from ​

BaseLight.isMesh

isSprite() ​

isSprite(): this is Sprite

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

Type guard: true if this node is a sprite

Returns ​

this is Sprite

Inherited from ​

BaseLight.isSprite

isMSDFTextSprite() ​

isMSDFTextSprite(): this is MSDFTextSprite

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

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

Returns ​

this is MSDFTextSprite

Inherited from ​

BaseLight.isMSDFTextSprite

isMSDFText() ​

isMSDFText(): this is MSDFText

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

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

Returns ​

this is MSDFText

Inherited from ​

BaseLight.isMSDFText

isWater() ​

isWater(): this is Water

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

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

Returns ​

this is Water

Inherited from ​

BaseLight.isWater

isParticleSystem() ​

isParticleSystem(): this is ParticleSystem

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

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

Returns ​

this is ParticleSystem

Inherited from ​

BaseLight.isParticleSystem

isBatchGroup() ​

isBatchGroup(): this is BatchGroup

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

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

Returns ​

this is BatchGroup

Inherited from ​

BaseLight.isBatchGroup

isClipmapTerrain() ​

isClipmapTerrain(): this is ClipmapTerrain

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

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

Returns ​

this is ClipmapTerrain

Inherited from ​

BaseLight.isClipmapTerrain

isCamera() ​

isCamera(): this is Camera

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

true if this is a camera node, false otherwise

Returns ​

this is Camera

Inherited from ​

BaseLight.isCamera

computeBoundingVolume() ​

computeBoundingVolume(): BoundingVolume

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

Computes the bounding volume of the node

Returns ​

BoundingVolume

The output bounding volume

Inherited from ​

BaseLight.computeBoundingVolume

getBoundingVolume() ​

getBoundingVolume(): BoundingVolume

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

Gets the bounding volume of the node

Returns ​

BoundingVolume

The bounding volume of the node

Inherited from ​

BaseLight.getBoundingVolume

setBoundingVolume() ​

setBoundingVolume(bv): void

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

Sets the bounding volume of the node

Parameters ​

bv ​

BoundingVolume

The bounding volume to set

Returns ​

void

Inherited from ​

BaseLight.setBoundingVolume

getWorldBoundingVolume() ​

getWorldBoundingVolume(): BoundingVolume

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

Gets the world space bounding volume of the node

Returns ​

BoundingVolume

The world space bounding volume of the node

Inherited from ​

BaseLight.getWorldBoundingVolume

computeWorldBoundingVolume() ​

computeWorldBoundingVolume(localBV): BoundingVolume

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

Computes the world space bounding volume of the node

Parameters ​

localBV ​

BoundingVolume

Returns ​

BoundingVolume

The output bounding volume

Inherited from ​

BaseLight.computeWorldBoundingVolume

invalidateBoundingVolume() ​

invalidateBoundingVolume(): void

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

Force the bounding volume to be recalculated

Returns ​

void

Inherited from ​

BaseLight.invalidateBoundingVolume

invalidateWorldBoundingVolume() ​

invalidateWorldBoundingVolume(transformChanged): void

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

Force the world space bounding volume to be recalculated

Parameters ​

transformChanged ​

boolean

Returns ​

void

Inherited from ​

BaseLight.invalidateWorldBoundingVolume

findNodeById() ​

findNodeById<T>(id): T

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

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 ​

BaseLight.findNodeById

findSkeletonById() ​

findSkeletonById(id): SkinBinding

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

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 ​

BaseLight.findSkeletonById

findSkinBindingById() ​

findSkinBindingById(id): SkinBinding

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

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 ​

BaseLight.findSkinBindingById

findSkeletonRigById() ​

findSkeletonRigById(id): SkeletonRig

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

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 ​

BaseLight.findSkeletonRigById

findNodeByName() ​

findNodeByName<T>(name): T

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

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 ​

BaseLight.findNodeByName

getSerializedMorphTargetGroups() ​

getSerializedMorphTargetGroups(): SerializedMorphTargetGroup[]

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

Returns serialized morph target groups for this node.

Returns ​

SerializedMorphTargetGroup[]

Inherited from ​

BaseLight.getSerializedMorphTargetGroups

setSerializedMorphTargetGroups() ​

setSerializedMorphTargetGroups(groups): void

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

Restores serialized morph target groups for this node.

Parameters ​

groups ​

SerializedMorphTargetGroup[]

Returns ​

void

Inherited from ​

BaseLight.setSerializedMorphTargetGroups

invalidateTransform() ​

invalidateTransform(invalidateLocal?): void

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

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 ​

BaseLight.invalidateTransform

setMorphTargetWeight() ​

setMorphTargetWeight(name, weight): void

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

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 ​

BaseLight.setMorphTargetWeight

setMorphTargetGroupWeight() ​

setMorphTargetGroupWeight(name, weight): void

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

Set morph target group weight for the model instance.

Parameters ​

name ​

string

Morph target group name

weight ​

number

Group weight

Returns ​

void

Inherited from ​

BaseLight.setMorphTargetGroupWeight

getMorphTargetGroupWeight() ​

getMorphTargetGroupWeight(name): number

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

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 ​

BaseLight.getMorphTargetGroupWeight

collectMorphTargetNames() ​

collectMorphTargetNames(): string[]

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

Collect all morph target names from meshes in the subtree.

Returns ​

string[]

Array of unique morph target names

Inherited from ​

BaseLight.collectMorphTargetNames

collectMorphTargetGroupNames() ​

collectMorphTargetGroupNames(): string[]

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

Collect all model-level morph target group names.

Returns ​

string[]

Array of morph target group names

Inherited from ​

BaseLight.collectMorphTargetGroupNames

onPostClone() ​

protected onPostClone(): void | Promise<void>

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

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

Returns ​

void | Promise<void>

Inherited from ​

BaseLight.onPostClone

_onAttached() ​

protected _onAttached(): void

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

Get called when this node is attached to scene

Returns ​

void

Inherited from ​

BaseLight._onAttached

_onDetached() ​

protected _onDetached(): void

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

Get called when this node is detached from scene

Returns ​

void

Inherited from ​

BaseLight._onDetached

worldToThis() ​

Call Signature ​

worldToThis(v, result?): Vector3

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

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 ​

BaseLight.worldToThis

Call Signature ​

worldToThis(v, result?): Vector4

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

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 ​

BaseLight.worldToThis

otherToThis() ​

Call Signature ​

otherToThis(other, v, result?): Vector3

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

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 ​

BaseLight.otherToThis

Call Signature ​

otherToThis(other, v, result?): Vector4

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

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 ​

BaseLight.otherToThis

thisToWorld() ​

Call Signature ​

thisToWorld(v, result?): Vector3

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

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 ​

BaseLight.thisToWorld

Call Signature ​

thisToWorld(v, result?): Vector4

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

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 ​

BaseLight.thisToWorld

thisToOther() ​

Call Signature ​

thisToOther(other, v, result?): Vector3

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

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 ​

BaseLight.thisToOther

Call Signature ​

thisToOther(other, v, result?): Vector4

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

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 ​

BaseLight.thisToOther

getWorldPosition() ​

getWorldPosition(outPos?): Vector3

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

Gets the position of the xform in world space

Parameters ​

outPos? ​

Vector3

Returns ​

Vector3

position of the xform in world space

Inherited from ​

BaseLight.getWorldPosition

moveBy() ​

moveBy(delta): PunctualLight

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

Moves the xform by an offset vector

Parameters ​

delta ​

Vector3

The offset vector

Returns ​

PunctualLight

self

Inherited from ​

BaseLight.moveBy

scaleBy() ​

scaleBy(factor): PunctualLight

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

Scales the xform by a given scale factor

Parameters ​

factor ​

Vector3

The scale factor

Returns ​

PunctualLight

self

Inherited from ​

BaseLight.scaleBy

setLocalTransform() ​

setLocalTransform(matrix): PunctualLight

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

Sets the local transform matrix of the xform

Parameters ​

matrix ​

Matrix4x4

The transform matrix to set

Returns ​

PunctualLight

self

Inherited from ​

BaseLight.setLocalTransform

calculateLocalTransform() ​

calculateLocalTransform(outMatrix): void

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

Calculate local transform matrix

Parameters ​

outMatrix ​

Matrix4x4

Matrix object that holds the result of calculation

Returns ​

void

Inherited from ​

BaseLight.calculateLocalTransform

calculateWorldTransform() ​

calculateWorldTransform(outMatrix): void

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

Calculate world transform matrix

Parameters ​

outMatrix ​

Matrix4x4

Matrix object that holds the result of calculation

Returns ​

void

Inherited from ​

BaseLight.calculateWorldTransform

lookAt() ​

lookAt(eye, target, up): PunctualLight

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

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 ​

PunctualLight

self

Inherited from ​

BaseLight.lookAt

update() ​

update(frameId, elapsedInSeconds, deltaInSeconds): void

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

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 ​

BaseLight.update

updatePerCamera() ​

updatePerCamera(_camera, _elapsedInSeconds, _deltaInSeconds): void

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

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 ​

BaseLight.updatePerCamera

reparent() ​

reparent(p?): PunctualLight

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

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 ​

PunctualLight

self

Inherited from ​

BaseLight.reparent

Released under the MIT License.

Copyright © Zephyr3d