@simversus/yjvis • Docs

---

@simversus/yjvis / ControlBase

Class: abstract ControlBase

控制器基类

Extends

• Node

Extended by

• TransformControl
• CameraControlBase
• ClippingGizmo

Constructors

new ControlBase()

new ControlBase(scene): ControlBase

Parameters

• scene: Scene

Returns

ControlBase

Overrides

Node.constructor

Defined in

control/controlBase.ts:50

Properties

_interractorUbinds

protected _interractorUbinds: Function[]

Defined in

control/controlBase.ts:22

---

_isDragging

protected _isDragging: boolean

是否在拖动

Defined in

control/controlBase.ts:21

---

_originCameraControlEnabled

protected _originCameraControlEnabled: boolean

相机控制器的初始启用状态

Defined in

control/controlBase.ts:17

---

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

---

enabled

enabled: boolean = true

是否启用

Defined in

control/controlBase.ts:13

---

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

---

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

---

scene

scene: Scene

Defined in

control/controlBase.ts:50

---

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

_canUpdate

get protected _canUpdate(): boolean

Returns

boolean

Defined in

control/controlBase.ts:46

---

camera

get protected camera(): Camera

Returns

Camera

Defined in

control/controlBase.ts:40

---

interactor

get protected interactor(): Interactor

Returns

Interactor

Defined in

control/controlBase.ts:43

---

mtime

get mtime(): number

Returns

number

Inherited from

Node.mtime

Defined in

core/baseObject.ts:118

---

object

get object(): Node

控制的对象

set object(node): void

设置控制对象

Parameters

• node: Node

Returns

Node

Defined in

control/controlBase.ts:30

Methods

_addHandlers()

abstract protected _addHandlers(): void

Internal

添加事件监听

Returns

void

Defined in

control/controlBase.ts:65

---

_onFrame()

abstract protected _onFrame(): void

Internal

每一帧的回调

Returns

void

Defined in

control/controlBase.ts:71

---

_removeHandlers()

protected _removeHandlers(): void

Returns

void

Defined in

control/controlBase.ts:73

---

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

---

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

control/controlBase.ts:56

---

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

延指定轴移动

Parameters

• axis: Vec3

• distance: number

Returns

ControlBase

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