@simversus/yjvis / objects / InstancedMesh

Class: InstancedMesh

Defined in: objects/InstancedMesh.ts:12

实例化网格，用于高效渲染大量相同几何体的实例每个实例可以有不同的位置、旋转、缩放和颜色

Extends

Mesh

Constructors

Constructor

new InstancedMesh(geometry?, material?, count?, isGlyph?, scaleFactor?): InstancedMesh

Defined in: objects/InstancedMesh.ts:30

构造函数

Parameters

geometry?

BufferGeometry

几何体

material?

NodeMaterial

材质

count?

number = 10

实例数量，默认 10

isGlyph?

boolean = true

是否是矢量字符，默认 true

scaleFactor?

number = 1

缩放因子，默认 1

Returns

InstancedMesh

Overrides

Mesh.constructor

Properties

_visible

_visible: boolean = true

Defined in: core/Transform.ts:51

是否可见

Inherited from

Mesh._visible

castShadow

castShadow: boolean = false

Defined in: core/Transform.ts:27

是否投射阴影

Inherited from

Mesh.castShadow

children

children: Transform[] = []

Defined in: core/Transform.ts:57

子节点

Inherited from

Mesh.children

classHierarchy

classHierarchy: ClassEnum[]

Defined in: core/baseObject.ts:19

继承链

Inherited from

Mesh.classHierarchy

count

count: number = 10

Defined in: objects/InstancedMesh.ts:33

实例数量，默认 10

geometry

geometry: BufferGeometry

Defined in: objects/Mesh.ts:33

几何体，定义物体的形状

Inherited from

Mesh.geometry

id

readonly id: number

Defined in: core/Transform.ts:40

唯一序号

Inherited from

Mesh.id

instanceColor?

optional instanceColor: InstancedBufferAttribute

Defined in: objects/InstancedMesh.ts:20

单实例颜色矩阵

instanceMatrix

instanceMatrix: InstancedBufferAttribute

Defined in: objects/InstancedMesh.ts:14

单实例偏移矩阵

isGlyph

isGlyph: boolean = true

Defined in: objects/InstancedMesh.ts:34

是否是矢量字符，默认 true

label?

optional label: string

Defined in: core/baseObject.ts:27

自定义标识

Inherited from

Mesh.label

layerMask

layerMask: number = 0

Defined in: core/Transform.ts:139

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

Inherited from

Mesh.layerMask

material

material: NodeMaterial

Defined in: objects/Mesh.ts:34

材质，定义物体的外观

Inherited from

Mesh.material

matrix

matrix: Mat4

Defined in: core/Transform.ts:71

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

Inherited from

Mesh.matrix

modelViewMatrix

modelViewMatrix: Mat4

Defined in: core/Transform.ts:82

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

Inherited from

Mesh.modelViewMatrix

name

name: string = ''

Defined in: objects/Mesh.ts:25

对象名称用于标识和查找物体

Inherited from

Mesh.name

normalMatrix

normalMatrix: Mat3

Defined in: core/Transform.ts:88

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

Inherited from

Mesh.normalMatrix

occlusionTest

occlusionTest: boolean = false

Defined in: core/Transform.ts:35

是否进行遮挡查询测试

Inherited from

Mesh.occlusionTest

onAfterRender()?

optional onAfterRender: (node) => void

Defined in: core/Transform.ts:134

渲染后的回调

Parameters

node

Transform

Returns

void

Inherited from

Mesh.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

Mesh.onBeforeRender

parent?

optional parent: Transform

Defined in: core/Transform.ts:63

父节点

Inherited from

Mesh.parent

position

position: Vec3

Defined in: core/Transform.ts:100

位置

Inherited from

Mesh.position

quaternion

quaternion: Quat

Defined in: core/Transform.ts:112

旋转

Inherited from

Mesh.quaternion

receiveShadow

receiveShadow: boolean = false

Defined in: core/Transform.ts:31

是否接收阴影

Inherited from

Mesh.receiveShadow

renderEntityID

renderEntityID: number = 6

Defined in: objects/Mesh.ts:14

渲染实体 ID 用于内部识别渲染对象的类型

Inherited from

Mesh.renderEntityID

renderOrder

renderOrder: number = 0

Defined in: core/Transform.ts:45

渲染顺序

Inherited from

Mesh.renderOrder

rotation

rotation: Euler

Defined in: core/Transform.ts:117

旋转信息的欧拉表达

Inherited from

Mesh.rotation

scaleFactor

scaleFactor: number = 1

Defined in: objects/InstancedMesh.ts:35

缩放因子，默认 1

scaling

scaling: Vec3

Defined in: core/Transform.ts:106

缩放

Inherited from

Mesh.scaling

type

type: string = 'Mesh'

Defined in: objects/Mesh.ts:19

对象类型

Inherited from

Mesh.type

up

up: Vec3

Defined in: core/Transform.ts:94

上方向

Inherited from

Mesh.up

userData

userData: object = {}

Defined in: core/baseObject.ts:23

用户自定义数据

Inherited from

Mesh.userData

uuid

uuid: string

Defined in: core/baseObject.ts:15

唯一标识符

Inherited from

Mesh.uuid

worldMatrix

worldMatrix: Mat4

Defined in: core/Transform.ts:76

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

Inherited from

Mesh.worldMatrix

Accessors

mtime

Get Signature

get mtime(): number

Defined in: core/baseObject.ts:56

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

Returns

number

Inherited from

Mesh.mtime

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

Mesh.visible

Methods

add()

add(...nodes): void

Defined in: core/Transform.ts:358

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

Parameters

nodes

...Transform[]

要添加的子节点列表

Returns

void

Inherited from

Mesh.add

addEventListener()

addEventListener(type, cb): void

Defined in: core/baseObject.ts:105

添加事件监听器

Parameters

type

string

事件类型字符串

cb

Function

事件触发时的回调函数

Returns

void

Inherited from

Mesh.addEventListener

changed()

changed(): void

Defined in: core/baseObject.ts:72

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

Returns

void

Inherited from

Mesh.changed

clone()

clone(recursive?): InstancedMesh

Defined in: core/Transform.ts:406

克隆当前节点

Parameters

recursive?

boolean

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

Returns

InstancedMesh

克隆后的新节点

Inherited from

Mesh.clone

copy()

copy(source, recursive): InstancedMesh

Defined in: core/Transform.ts:417

从源节点复制属性

Parameters

source

this

源节点

recursive

boolean = true

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

Returns

InstancedMesh

this

Inherited from

Mesh.copy

dispatchEvent()

dispatchEvent(event): void

Defined in: core/baseObject.ts:126

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

Parameters

event

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

data?

any

type

string

Returns

void

Inherited from

Mesh.dispatchEvent

dispose()

dispose(): void

Defined in: core/baseObject.ts:80

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

Returns

void

Inherited from

Mesh.dispose

getRotation()

getRotation(): Number3

Defined in: core/Transform.ts:208

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

Returns

Number3

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

Inherited from

Mesh.getRotation

getWorldDirection()

getWorldDirection(target): Vec3

Defined in: core/Transform.ts:343

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

Parameters

target

Vec3 = ...

目标向量，用于存储结果

Returns

Vec3

朝向向量

Inherited from

Mesh.getWorldDirection

is()

is(t): boolean

Defined in: core/baseObject.ts:65

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

Parameters

t

ClassEnum

类类型枚举值

Returns

boolean

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

Inherited from

Mesh.is

lookAt()

lookAt(target): void

Defined in: core/Transform.ts:291

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

Parameters

target

Vec3 = ...

目标点坐标 (Vec3)

Returns

void

Inherited from

Mesh.lookAt

lookTo()

lookTo(direction): void

Defined in: core/Transform.ts:304

使节点看向指定方向

Parameters

direction

Vec3

方向向量 (Vec3)

Returns

void

Inherited from

Mesh.lookTo

onChanged()

onChanged(cb): () => void

Defined in: core/baseObject.ts:90

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

Parameters

cb

Function

回调函数

Returns

取消注册该回调的函数

(): void

Returns

void

Inherited from

Mesh.onChanged

remove()

remove(...nodes): void

Defined in: core/Transform.ts:372

移除子节点

Parameters

nodes

...Transform[]

要移除的子节点列表

Returns

void

Inherited from

Mesh.remove

removeEventListener()

removeEventListener(type, cb): void

Defined in: core/baseObject.ts:116

移除事件监听器

Parameters

type

string

事件类型字符串

cb

Function

要移除的回调函数

Returns

void

Inherited from

Mesh.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

Mesh.rotate

rotateOnAxis()

rotateOnAxis(axis, radian): void

Defined in: core/Transform.ts:251

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

Parameters

axis

Vec3

旋转轴 (Vec3)

radian

number

旋转角度 (弧度)

Returns

void

Inherited from

Mesh.rotateOnAxis

rotateOnWorldAxis()

rotateOnWorldAxis(axis, radian): void

Defined in: core/Transform.ts:261

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

Parameters

axis

Vec3

旋转轴 (Vec3)

radian

number

旋转角度 (弧度)

Returns

void

Inherited from

Mesh.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

Mesh.scale

setColorAt()

setColorAt(index, color): void

Defined in: objects/InstancedMesh.ts:58

设置指定实例的颜色如果 instanceColor 属性不存在，会自动创建

Parameters

index

number

实例索引

color

Color

颜色

Returns

void

setCount()

setCount(count): void

Defined in: objects/InstancedMesh.ts:83

设置实例数量会重新分配 instanceMatrix 和 instanceColor 的内存

Parameters

count

number

新的实例数量

Returns

void

setMatrix()

setMatrix(m): void

Defined in: core/Transform.ts:190

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

Parameters

m

Mat4

变换矩阵

Returns

void

Inherited from

Mesh.setMatrix

setMatrixAt()

setMatrixAt(index, matrix): void

Defined in: objects/InstancedMesh.ts:74

设置指定实例的变换矩阵

Parameters

index

number

实例索引

matrix

Mat4

变换矩阵

Returns

void

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

Mesh.setRotation

toJSON()

toJSON(): any

Defined in: core/Transform.ts:393

序列化为 JSON 对象

Returns

any

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

Inherited from

Mesh.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

Mesh.translate

translateOnAxis()

translateOnAxis(axis, distance): InstancedMesh

Defined in: core/Transform.ts:230

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

Parameters

axis

Vec3

移动轴 (Vec3)

distance

number

移动距离

Returns

InstancedMesh

this

Inherited from

Mesh.translateOnAxis

traverse()

traverse(cb): void

Defined in: core/Transform.ts:199

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

Parameters

cb

(node) => void

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

Returns

void

Inherited from

Mesh.traverse

updateMatrix()

updateMatrix(): void

Defined in: core/Transform.ts:313

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

Returns

void

Inherited from

Mesh.updateMatrix

updateWorldMatrix()

updateWorldMatrix(updateParant, updateChildren): void

Defined in: core/Transform.ts:323

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

Parameters

updateParant

boolean = false

是否同时更新父节点

updateChildren

boolean = true

是否同时更新子节点

Returns

void

Inherited from

Mesh.updateWorldMatrix

Class: InstancedMesh ​

Extends ​

Constructors ​

Constructor ​

Parameters ​

geometry? ​

material? ​

count? ​

isGlyph? ​

scaleFactor? ​

Returns ​

Overrides ​

Properties ​

_visible ​

Inherited from ​

castShadow ​

Inherited from ​

children ​

Inherited from ​

classHierarchy ​

Inherited from ​

count ​

geometry ​

Inherited from ​

id ​

Inherited from ​

instanceColor? ​

instanceMatrix ​

isGlyph ​

label? ​

Inherited from ​

layerMask ​

Inherited from ​

material ​

Inherited from ​

matrix ​

Inherited from ​

modelViewMatrix ​

Inherited from ​

name ​

Inherited from ​

normalMatrix ​

Inherited from ​

occlusionTest ​

Inherited from ​

onAfterRender()? ​

Parameters ​

node ​

Returns ​

Inherited from ​

onBeforeRender()? ​

Parameters ​

node ​

scene? ​

camera? ​

geometry? ​

material? ​

group? ​

Returns ​

Inherited from ​

parent? ​

Inherited from ​

position ​

Inherited from ​

quaternion ​

Inherited from ​

receiveShadow ​

Inherited from ​

renderEntityID ​

Inherited from ​

renderOrder ​

Inherited from ​

rotation ​

Inherited from ​

scaleFactor ​

scaling ​

Inherited from ​

type ​

Inherited from ​

up ​

Class: InstancedMesh

Extends

Constructors

Constructor

Parameters

geometry?

material?

count?

isGlyph?

scaleFactor?

Returns

Overrides

Properties

_visible

Inherited from

castShadow

Inherited from

children

Inherited from

classHierarchy

Inherited from

count

geometry

Inherited from

id

Inherited from

instanceColor?

instanceMatrix

isGlyph

label?

Inherited from

layerMask

Inherited from

material

Inherited from

matrix

Inherited from

modelViewMatrix

Inherited from

name

Inherited from

normalMatrix

Inherited from

occlusionTest

Inherited from

onAfterRender()?

Parameters

node

Returns

Inherited from

onBeforeRender()?

Parameters

node

scene?

camera?

geometry?

material?

group?

Returns

Inherited from

parent?

Inherited from

position

Inherited from

quaternion

Inherited from

receiveShadow

Inherited from

renderEntityID

Inherited from

renderOrder

Inherited from

rotation

Inherited from

scaleFactor

scaling

Inherited from

type

Inherited from

up