@simversus/yjvis • Docs

---

@simversus/yjvis / Light

Class: Light

灯光

Extends

• Node

Constructors

new Light()

new Light(op): Light

Parameters

• op: Partial<object>

Returns

Light

Overrides

Node.constructor

Defined in

scene/Light.ts:112

Properties

angle

angle: number

聚光灯的张开角度，弧度制

Default

Math.PI / 6

Defined in

scene/Light.ts:72

---

castShadow

castShadow: boolean = false

是否产生阴影

Default

false

Defined in

scene/Light.ts:42

---

children

children: Node[] = []

子节点

Inherited from

Node.children

Defined in

scene/Node.ts:44

---

classHierarchy

classHierarchy: ClassEnum[]

Deprecated

Inherited from

Node.classHierarchy

Defined in

core/baseObject.ts:96

---

color

color: Color

光源颜色

Default

new Color(0xffffff)

Defined in

scene/Light.ts:57

---

decay

decay: number

光源随距离的衰减指数值，值越大衰减越厉害

Default

2

Defined in

scene/Light.ts:67

---

distance

distance: number

光源影响距离，<=0代表无限远，平行光影响距离永远是无限远

Default

0

Defined in

scene/Light.ts:62

---

helperModel

helperModel: LightModel

用于可视化该灯光的辅助模型

Defined in

scene/Light.ts:31

---

intensity

intensity: number

光源强度系数

Default

1

Defined in

scene/Light.ts:52

---

isHeadLight

isHeadLight: boolean

Internal

是否为“头灯”，头灯的光源方向在相机空间下总是[0,0,1]

Default

false

Defined in

scene/Light.ts:37

---

label

label: string

自定义标识

Inherited from

Node.label

Defined in

core/baseObject.ts:104

---

layerMask

layerMask: number = 0

层级

Inherited from

Node.layerMask

Defined in

scene/Node.ts:93

---

matrix

matrix: Mat4

本地矩阵

Inherited from

Node.matrix

Defined in

scene/Node.ts:53

---

onAfterRender()

onAfterRender: (node) => void

渲染后的回调

Parameters

• node: Node

Returns

void

Inherited from

Node.onAfterRender

Defined in

scene/Node.ts:89

---

onBeforeRender()

onBeforeRender: (node) => void

渲染前的回调

Parameters

• node: Node

Returns

void

Inherited from

Node.onBeforeRender

Defined in

scene/Node.ts:85

---

parent?

optional parent: Node

父节点

Inherited from

Node.parent

Defined in

scene/Node.ts:49

---

penumbra

penumbra: number

聚光灯的半影(衰减区域)比例，0~1，0代表没有半影，1代表全影

Default

1

Defined in

scene/Light.ts:77

---

position

position: Vec3

位置

Inherited from

Node.position

Defined in

scene/Node.ts:67

---

quaternion

quaternion: Quat

旋转

Inherited from

Node.quaternion

Defined in

scene/Node.ts:77

---

scaling

scaling: Vec3

缩放

Inherited from

Node.scaling

Defined in

scene/Node.ts:72

---

type

type: LightType

光源类型

Default

LightType.direct

Defined in

scene/Light.ts:47

---

up

up: Vec3

上方向

Inherited from

Node.up

Defined in

scene/Node.ts:62

---

userData

userData: any

用户自定义数据

Inherited from

Node.userData

Defined in

core/baseObject.ts:100

---

uuid

uuid: number

唯一标识符

Inherited from

Node.uuid

Defined in

core/baseObject.ts:92

---

visible

visible: boolean = true

是否可见

Inherited from

Node.visible

Defined in

scene/Node.ts:39

---

worldMatrix

worldMatrix: Mat4

世界矩阵

Inherited from

Node.worldMatrix

Defined in

scene/Node.ts:57

Accessors

mtime

get mtime(): number

Returns

number

Inherited from

Node.mtime

Defined in

core/baseObject.ts:118

---

power

get power(): number

获取流明强度值

set power(power): void

设置流明强度值

Parameters

• power: number

Returns

number

Defined in

scene/Light.ts:90

---

shadow

get shadow(): LightShadow

Internal

光源阴影

Returns

LightShadow

Defined in

scene/Light.ts:84

Methods

add()

add(...nodes): void

添加子节点

Parameters

• ...nodes: Node[]

Returns

void

Inherited from

Node.add

Defined in

scene/Node.ts:276

---

changed()

changed(): void

标记对象为已修改

Returns

void

Inherited from

Node.changed

Defined in

core/baseObject.ts:128

---

getLightInfo()

getLightInfo(): LightInfo

Internal

获取光源信息

Returns

LightInfo

Defined in

scene/Light.ts:124

---

getRootNode()

getRootNode(): Node

Internal

获取根节点

Returns

Node

Inherited from

Node.getRootNode

Defined in

scene/Node.ts:303

---

getRotation()

getRotation(): Number3

获取旋转信息

Returns

Number3

Inherited from

Node.getRotation

Defined in

scene/Node.ts:132

---

getWorldDirection()

getWorldDirection(): Vec3

获取世界空间下的朝向

Returns

Vec3

Overrides

Node.getWorldDirection

Defined in

scene/Light.ts:146

---

is()

is(t): boolean

Parameters

• t: ClassEnum

Returns

boolean

Inherited from

Node.is

Defined in

core/baseObject.ts:122

---

lookAt()

lookAt(target): void

看向某个点

Parameters

• target: Vec3 = ...

Returns

void

Inherited from

Node.lookAt

Defined in

scene/Node.ts:208

---

lookTo()

lookTo(direction): void

看向某个方向

Parameters

• direction: Vec3

Returns

void

Inherited from

Node.lookTo

Defined in

scene/Node.ts:220

---

release()

release(): void

销毁该对象

Returns

void

Inherited from

Node.release

Defined in

core/baseObject.ts:134

---

remove()

remove(...nodes): void

移除子节点

Parameters

• ...nodes: Node[]

Returns

void

Inherited from

Node.remove

Defined in

scene/Node.ts:290

---

rotate()

rotate(__namedParameters): void

绕自身坐标系xyz轴旋转指定弧度

Parameters

• __namedParameters

• __namedParameters.dx?: number

• __namedParameters.dy?: number

• __namedParameters.dz?: number

Returns

void

Inherited from

Node.rotate

Defined in

scene/Node.ts:189

---

rotateOnAxis()

rotateOnAxis(axis, radian): void

绕指定轴旋转

Parameters

• axis: Vec3

• radian: number

Returns

void

Inherited from

Node.rotateOnAxis

Defined in

scene/Node.ts:173

---

rotateOnWorldAxis()

rotateOnWorldAxis(axis, radian): void

绕世界坐标系指定轴旋转

Parameters

• axis: Vec3

• radian: number

Returns

void

Inherited from

Node.rotateOnWorldAxis

Defined in

scene/Node.ts:181

---

scale()

scale(__namedParameters): void

缩放节点

Parameters

• __namedParameters

• __namedParameters.dx?: number

• __namedParameters.dy?: number

• __namedParameters.dz?: number

Returns

void

Inherited from

Node.scale

Defined in

scene/Node.ts:198

---

setMatrix()

setMatrix(m): void

设置模型的矩阵

Parameters

• m: Mat4

Returns

void

Inherited from

Node.setMatrix

Defined in

scene/Node.ts:114

---

setRotation()

setRotation(x, y, z): void

设置旋转

Parameters

• x: number

• y: number = x

• z: number = x

Returns

void

Inherited from

Node.setRotation

Defined in

scene/Node.ts:142

---

translate()

translate(param0): void

延xyz轴移动

Parameters

• param0

• param0.dx?: number

• param0.dy?: number

• param0.dz?: number

Returns

void

Inherited from

Node.translate

Defined in

scene/Node.ts:162

---

translateOnAxis()

translateOnAxis(axis, distance): Light

延指定轴移动

Parameters

• axis: Vec3

• distance: number

Returns

Light

Inherited from

Node.translateOnAxis

Defined in

scene/Node.ts:152

---

traverse()

traverse(cb): void

遍历执行

Parameters

• cb

Returns

void

Inherited from

Node.traverse

Defined in

scene/Node.ts:123

---

updateMatrix()

updateMatrix(): void

更新本地矩阵

Returns

void

Inherited from

Node.updateMatrix

Defined in

scene/Node.ts:228

---

updateWorldMatrix()

updateWorldMatrix(updateParant, updateChildren): void

更新世界矩阵

Parameters

• updateParant: boolean = false

• updateChildren: boolean = true

Returns

void

Inherited from

Node.updateWorldMatrix

Defined in

scene/Node.ts:245