YJVis

@simversus/yjvis

@simversus/yjvis / control / ControlBase

Abstract Class: ControlBase ​

Defined in: control/controlBase.ts:9

控制器基类

Extends ​

  • Transform

Extended by ​

Constructors ​

Constructor ​

new ControlBase(interactor, object?): ControlBase

Defined in: control/controlBase.ts:82

构造函数

Parameters ​

interactor ​

Interactor

交互器实例，用于处理输入事件

object? ​

Transform

被控制的 Transform 对象 (可选)

Returns ​

ControlBase

Overrides ​

Transform.constructor

Properties ​

_camera ​

protected _camera: Camera

Defined in: control/controlBase.ts:47

关联的相机

_interractorUbinds ​

protected _interractorUbinds: Function[]

Defined in: control/controlBase.ts:34

交互器事件解绑函数列表

_isDragging ​

protected _isDragging: boolean

Defined in: control/controlBase.ts:25

是否正在拖拽中

_isDraggStart ​

protected _isDraggStart: boolean = false

Defined in: control/controlBase.ts:29

是否刚开始拖拽

_originCameraControlEnabled ​

protected _originCameraControlEnabled: boolean

Defined in: control/controlBase.ts:21

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

_visible ​

_visible: boolean = true

Defined in: core/Transform.ts:51

是否可见

Inherited from ​

Transform._visible

castShadow ​

castShadow: boolean = false

Defined in: core/Transform.ts:27

是否投射阴影

Inherited from ​

Transform.castShadow

children ​

children: Transform[] = []

Defined in: core/Transform.ts:57

子节点

Inherited from ​

Transform.children

classHierarchy ​

classHierarchy: ClassEnum[]

Defined in: core/baseObject.ts:19

继承链

Inherited from ​

Transform.classHierarchy

enabled ​

enabled: boolean = true

Defined in: control/controlBase.ts:13

是否启用控制器

id ​

readonly id: number

Defined in: core/Transform.ts:40

唯一序号

Inherited from ​

Transform.id

interactor ​

interactor: Interactor

Defined in: control/controlBase.ts:83

交互器实例，用于处理输入事件

label? ​

optional label: string

Defined in: core/baseObject.ts:27

自定义标识

Inherited from ​

Transform.label

layerMask ​

layerMask: number = 0

Defined in: core/Transform.ts:139

层级掩码，用于控制不同层级对象的可见性或交互

Inherited from ​

Transform.layerMask

matrix ​

matrix: Mat4

Defined in: core/Transform.ts:71

本地变换矩阵 (相对于父节点)

Inherited from ​

Transform.matrix

modelViewMatrix ​

modelViewMatrix: Mat4

Defined in: core/Transform.ts:82

模型视图矩阵 (ModelMatrix * ViewMatrix) 用于着色器计算

Inherited from ​

Transform.modelViewMatrix

normalMatrix ​

normalMatrix: Mat3

Defined in: core/Transform.ts:88

法线矩阵 (模型视图矩阵的逆转置矩阵的左上3x3部分) 用于变换法向量

Inherited from ​

Transform.normalMatrix

occlusionTest ​

occlusionTest: boolean = false

Defined in: core/Transform.ts:35

是否进行遮挡查询测试

Inherited from ​

Transform.occlusionTest

onAfterRender()? ​

optional onAfterRender: (node) => void

Defined in: core/Transform.ts:134

渲染后的回调

Parameters ​

node ​

Transform

Returns ​

void

Inherited from ​

Transform.onAfterRender

onBeforeRender()? ​

optional onBeforeRender: (node, scene?, camera?, geometry?, material?, group?) => void

Defined in: core/Transform.ts:122

渲染前的回调

Parameters ​

node ​

any

scene? ​

Scene

camera? ​

Camera

geometry? ​

BufferGeometry

material? ​

NodeMaterial

group? ​

any

Returns ​

void

Inherited from ​

Transform.onBeforeRender

onControlUpdate? ​

optional onControlUpdate: Function

Defined in: control/controlBase.ts:17

控制器更新时的回调函数，通常用于触发重绘

parent? ​

optional parent: Transform

Defined in: core/Transform.ts:63

父节点

Inherited from ​

Transform.parent

position ​

position: Vec3

Defined in: core/Transform.ts:100

位置

Inherited from ​

Transform.position

quaternion ​

quaternion: Quat

Defined in: core/Transform.ts:112

旋转

Inherited from ​

Transform.quaternion

receiveShadow ​

receiveShadow: boolean = false

Defined in: core/Transform.ts:31

是否接收阴影

Inherited from ​

Transform.receiveShadow

renderOrder ​

renderOrder: number = 0

Defined in: core/Transform.ts:45

渲染顺序

Inherited from ​

Transform.renderOrder

rotation ​

rotation: Euler

Defined in: core/Transform.ts:117

旋转信息的欧拉表达

Inherited from ​

Transform.rotation

scaling ​

scaling: Vec3

Defined in: core/Transform.ts:106

缩放

Inherited from ​

Transform.scaling

up ​

up: Vec3

Defined in: core/Transform.ts:94

上方向

Inherited from ​

Transform.up

userData ​

userData: object = {}

Defined in: core/baseObject.ts:23

用户自定义数据

Inherited from ​

Transform.userData

uuid ​

uuid: string

Defined in: core/baseObject.ts:15

唯一标识符

Inherited from ​

Transform.uuid

worldMatrix ​

worldMatrix: Mat4

Defined in: core/Transform.ts:76

世界变换矩阵 (相对于世界坐标系)

Inherited from ​

Transform.worldMatrix

Accessors ​

_canUpdate ​

Get Signature ​

get protected _canUpdate(): boolean

Defined in: control/controlBase.ts:73

检查是否可以更新控制器状态 通常在交互器未进行拾取操作且控制器启用时返回 true

Returns ​

boolean

camera ​

Get Signature ​

get camera(): Camera

Defined in: control/controlBase.ts:65

获取关联的相机

Returns ​

Camera

mtime ​

Get Signature ​

get mtime(): number

Defined in: core/baseObject.ts:56

获取对象的最后修改时间戳

Returns ​

number

Inherited from ​

Transform.mtime

object ​

Get Signature ​

get object(): Transform

Defined in: control/controlBase.ts:52

控制的对象

Returns ​

Transform

Set Signature ​

set object(node): void

Defined in: control/controlBase.ts:58

设置控制对象

Parameters ​
node ​

Transform

Returns ​

void

visible ​

Get Signature ​

get visible(): boolean

Defined in: core/Transform.ts:170

获取可见性状态

Returns ​

boolean

Set Signature ​

set visible(value): void

Defined in: core/Transform.ts:177

设置可见性状态

Parameters ​
value ​

boolean

Returns ​

void

Inherited from ​

Transform.visible

Methods ​

_removeHandlers() ​

protected _removeHandlers(): void

Defined in: control/controlBase.ts:128

移除所有已注册的事件处理函数

Returns ​

void

add() ​

add(...nodes): void

Defined in: core/Transform.ts:358

添加子节点 会自动将子节点从原来的父节点移除

Parameters ​

nodes ​

...Transform[]

要添加的子节点列表

Returns ​

void

Inherited from ​

Transform.add

addEventListener() ​

addEventListener(type, cb): void

Defined in: core/baseObject.ts:105

添加事件监听器

Parameters ​

type ​

string

事件类型字符串

cb ​

Function

事件触发时的回调函数

Returns ​

void

Inherited from ​

Transform.addEventListener

changed() ​

changed(): void

Defined in: core/baseObject.ts:72

标记对象为已修改 更新修改时间戳并触发所有注册的变更回调

Returns ​

void

Inherited from ​

Transform.changed

clone() ​

clone(recursive?): ControlBase

Defined in: core/Transform.ts:406

克隆当前节点

Parameters ​

recursive? ​

boolean

是否递归克隆子节点，默认为 true

Returns ​

ControlBase

克隆后的新节点

Inherited from ​

Transform.clone

copy() ​

copy(source, recursive): ControlBase

Defined in: core/Transform.ts:417

从源节点复制属性

Parameters ​

source ​

this

源节点

recursive ​

boolean = true

是否递归复制子节点，默认为 true

Returns ​

ControlBase

this

Inherited from ​

Transform.copy

dispatchEvent() ​

dispatchEvent(event): void

Defined in: core/baseObject.ts:126

分发事件 触发所有注册了该事件类型的监听器

Parameters ​

event ​

事件对象，包含 type 和可选的 data

data? ​

any

type ​

string

Returns ​

void

Inherited from ​

Transform.dispatchEvent

dispose() ​

dispose(): void

Defined in: core/baseObject.ts:80

销毁该对象 分发 dispose 事件，通知监听者对象即将被销毁

Returns ​

void

Inherited from ​

Transform.dispose

getRotation() ​

getRotation(): Number3

Defined in: core/Transform.ts:208

获取欧拉角旋转信息 (数组形式)

Returns ​

Number3

[x, y, z] 旋转角度数组

Inherited from ​

Transform.getRotation

getWorldDirection() ​

getWorldDirection(target): Vec3

Defined in: core/Transform.ts:343

获取节点在世界空间中的朝向

Parameters ​

target ​

Vec3 = ...

目标向量，用于存储结果

Returns ​

Vec3

朝向向量

Inherited from ​

Transform.getWorldDirection

is() ​

is(t): boolean

Defined in: core/baseObject.ts:65

检查对象是否属于指定的类类型

Parameters ​

t ​

ClassEnum

类类型枚举值

Returns ​

boolean

如果对象是该类型或继承自该类型，则返回 true

Inherited from ​

Transform.is

lookAt() ​

lookAt(target): void

Defined in: core/Transform.ts:291

使节点看向指定目标点 (改变朝向)

Parameters ​

target ​

Vec3 = ...

目标点坐标 (Vec3)

Returns ​

void

Inherited from ​

Transform.lookAt

lookTo() ​

lookTo(direction): void

Defined in: core/Transform.ts:304

使节点看向指定方向

Parameters ​

direction ​

Vec3

方向向量 (Vec3)

Returns ​

void

Inherited from ​

Transform.lookTo

onChanged() ​

onChanged(cb): () => void

Defined in: core/baseObject.ts:90

注册对象变更回调 当对象发生改变(调用 changed 方法)时触发

Parameters ​

cb ​

Function

回调函数

Returns ​

取消注册该回调的函数

(): void

Returns ​

void

Inherited from ​

Transform.onChanged

release() ​

release(): void

Defined in: control/controlBase.ts:108

释放控制器资源 移除事件监听器并取消帧回调注册

Returns ​

void

remove() ​

remove(...nodes): void

Defined in: core/Transform.ts:372

移除子节点

Parameters ​

nodes ​

...Transform[]

要移除的子节点列表

Returns ​

void

Inherited from ​

Transform.remove

removeEventListener() ​

removeEventListener(type, cb): void

Defined in: core/baseObject.ts:116

移除事件监听器

Parameters ​

type ​

string

事件类型字符串

cb ​

Function

要移除的回调函数

Returns ​

void

Inherited from ​

Transform.removeEventListener

rotate() ​

rotate(param0): void

Defined in: core/Transform.ts:270

绕本地坐标系的 X, Y, Z 轴旋转及从欧拉角选择

Parameters ​

param0 ​

包含 dx, dy, dz 的对象 (弧度)

dx? ​

number

dy? ​

number

dz? ​

number

Returns ​

void

Inherited from ​

Transform.rotate

rotateOnAxis() ​

rotateOnAxis(axis, radian): void

Defined in: core/Transform.ts:251

绕本地坐标系的指定轴旋转

Parameters ​

axis ​

Vec3

旋转轴 (Vec3)

radian ​

number

旋转角度 (弧度)

Returns ​

void

Inherited from ​

Transform.rotateOnAxis

rotateOnWorldAxis() ​

rotateOnWorldAxis(axis, radian): void

Defined in: core/Transform.ts:261

绕世界坐标系的指定轴旋转

Parameters ​

axis ​

Vec3

旋转轴 (Vec3)

radian ​

number

旋转角度 (弧度)

Returns ​

void

Inherited from ​

Transform.rotateOnWorldAxis

scale() ​

scale(param0): void

Defined in: core/Transform.ts:280

缩放节点 (在现有缩放基础上累乘)

Parameters ​

param0 ​

包含 dx, dy, dz 的对象

dx? ​

number

dy? ​

number

dz? ​

number

Returns ​

void

Inherited from ​

Transform.scale

setMatrix() ​

setMatrix(m): void

Defined in: core/Transform.ts:190

设置节点的本地变换矩阵 会自动分解出 position, quaternion, scaling

Parameters ​

m ​

Mat4

变换矩阵

Returns ​

void

Inherited from ​

Transform.setMatrix

setRotation() ​

setRotation(x, y, z): void

Defined in: core/Transform.ts:218

设置旋转角度 (欧拉角)

Parameters ​

x ​

number

X轴旋转角度 (弧度)，也可传入 Vec3

y ​

number = x

Y轴旋转角度 (弧度)

z ​

number = x

Z轴旋转角度 (弧度)

Returns ​

void

Inherited from ​

Transform.setRotation

setup() ​

setup(renderer, onControlUpdate?): void

Defined in: control/controlBase.ts:96

注册帧回调和渲染函数

Parameters ​

renderer ​

Renderer

渲染器

onControlUpdate? ​

Function

控制器更新回调

Returns ​

void

toJSON() ​

toJSON(): any

Defined in: core/Transform.ts:393

序列化为 JSON 对象

Returns ​

any

包含位置、旋转和缩放的 JSON 对象

Inherited from ​

Transform.toJSON

translate() ​

translate(param0): void

Defined in: core/Transform.ts:240

沿本地坐标系的 X, Y, Z 轴平移

Parameters ​

param0 ​

包含 dx, dy, dz 的对象

dx? ​

number

dy? ​

number

dz? ​

number

Returns ​

void

Inherited from ​

Transform.translate

translateOnAxis() ​

translateOnAxis(axis, distance): ControlBase

Defined in: core/Transform.ts:230

沿指定轴平移节点 轴是在本地坐标系下指定的，但移动方向受当前旋转影响

Parameters ​

axis ​

Vec3

移动轴 (Vec3)

distance ​

number

移动距离

Returns ​

ControlBase

this

Inherited from ​

Transform.translateOnAxis

traverse() ​

traverse(cb): void

Defined in: core/Transform.ts:199

遍历场景树，对当前节点及所有后代节点执行回调

Parameters ​

cb ​

(node) => void

回调函数，接收当前正在处理的节点作为参数

Returns ​

void

Inherited from ​

Transform.traverse

updateMatrix() ​

updateMatrix(): void

Defined in: core/Transform.ts:313

更新本地矩阵 根据当前的 position, quaternion, scaling 组合计算 matrix

Returns ​

void

Inherited from ​

Transform.updateMatrix

updateWorldMatrix() ​

updateWorldMatrix(updateParant, updateChildren): void

Defined in: core/Transform.ts:323

更新世界矩阵 递归更新父节点（可选）和所有子节点（可选）

Parameters ​

updateParant ​

boolean = false

是否同时更新父节点

updateChildren ​

boolean = true

是否同时更新子节点

Returns ​

void

Inherited from ​

Transform.updateWorldMatrix