@simversus/yjvis • Docs

---

@simversus/yjvis / Scene

Class: Scene

场景，渲染物体的容器

Extends

• Node

Constructors

new Scene()

new Scene(_p): Scene

Parameters

• _p: SceneOption

Returns

Scene

Overrides

Node.constructor

Defined in

scene/Scene.ts:108

Properties

autoAdjustCameraClippingRange

autoAdjustCameraClippingRange: boolean = false

是否每次渲染自动调整相机剪切面

Defined in

scene/Scene.ts:106

---

background

background: Number4

背景色

Defined in

scene/Scene.ts:88

---

camera

camera: Camera

场景的主相机

Defined in

scene/Scene.ts:64

---

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

---

control?

optional control: CameraControlBase

相机控制器

Defined in

scene/Scene.ts:76

---

interactor

interactor: Interactor

用户输入事件监听器

Defined in

scene/Scene.ts:80

---

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

---

lights

lights: Light[]

灯光

Defined in

scene/Scene.ts:68

---

matrix

matrix: Mat4

本地矩阵

Inherited from

Node.matrix

Defined in

scene/Node.ts:53

---

models

models: Model[]

待渲染物体

Defined in

scene/Scene.ts:72

---

monitor

monitor: PerformanceMonitor

性能监控器

Defined in

scene/Scene.ts:84

---

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

---

onControlUpdate?

optional onControlUpdate: Function

手势控制器/窗口大小更改的回调，默认是this.render，如果想手动控制渲染的时机，将此设置为undefined

Defined in

scene/Scene.ts:102

---

parent?

optional parent: Node

父节点

Inherited from

Node.parent

Defined in

scene/Node.ts:49

---

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

---

renderOP

renderOP: RenderOP

Internal

本次渲染的参数

Defined in

scene/Scene.ts:97

---

renderer

renderer: Renderer

Internal

Defined in

scene/Scene.ts:92

---

scaling

scaling: Vec3

缩放

Inherited from

Node.scaling

Defined in

scene/Node.ts:72

---

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

Methods

add()

add(...nodes): void

添加子节点

Parameters

• ...nodes: Node[]

Returns

void

Inherited from

Node.add

Defined in

scene/Node.ts:276

---

adjustCamera()

adjustCamera(ratio): void

根据场景中的物体计算相机最佳位置

Parameters

• ratio: number = 0.5

场景中物体占比，默认0.5

Returns

void

Defined in

scene/Scene.ts:260

---

adjustCameraClippingRange()

adjustCameraClippingRange(): void

调整相机的裁剪范围

Returns

void

Defined in

scene/Scene.ts:285

---

changed()

changed(): void

标记对象为已修改

Returns

void

Inherited from

Node.changed

Defined in

core/baseObject.ts:128

---

computeVisibleBounds()

computeVisibleBounds(): Box

计算场景中可见物体的包围盒

Returns

Box

Defined in

scene/Scene.ts:223

---

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

Inherited from

Node.getWorldDirection

Defined in

scene/Node.ts:264

---

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

Overrides

Node.release

Defined in

scene/Scene.ts:145

---

remove()

remove(...nodes): void

移除子节点

Parameters

• ...nodes: Node[]

Returns

void

Inherited from

Node.remove

Defined in

scene/Node.ts:290

---

render()

render(op): Promise<unknown>

渲染场景，并返回一个promise，当绘制完成后resolved

Parameters

• op: RenderOP = {}

Returns

Promise<unknown>

Defined in

scene/Scene.ts:131

---

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): Scene

延指定轴移动

Parameters

• axis: Vec3

• distance: number

Returns

Scene

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

---

update()

update(op): void

Internal

更新矩阵，遍历场景树，调整相机剪裁面

Parameters

• op: RenderOP

Returns

void

Defined in

scene/Scene.ts:155

---

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

---

useOrbitControl()

useOrbitControl(): OribitControl

使用OrbitControl

Returns

OribitControl

Defined in

scene/Scene.ts:194

---

usePointLockerControl()

usePointLockerControl(): PointerLockControl

使用PointerLockControl

Returns

PointerLockControl

Defined in

scene/Scene.ts:214

---

useTrackBallControl()

useTrackBallControl(): TrackballControl

使用TrackballControl

Returns

TrackballControl

Defined in

scene/Scene.ts:204