@simversus/yjvis

---

@simversus/yjvis / objects / Sprite

Class: Sprite

Defined in: objects/Sprite.ts:23

A sprite is a plane that always faces towards the camera, generally with a partially transparent texture applied.

Sprites do not cast shadows, setting Object3D#castShadow to true will have no effect.

Extends

• Mesh

Constructors

Constructor

new Sprite(geometry, material?): Sprite

Defined in: objects/Sprite.ts:86

Constructs a new sprite.

Parameters

geometry

BufferGeometry = ...

material?

SpriteNodeMaterial = ...

The sprite material.

Returns

Sprite

Overrides

Mesh.constructor

Properties

_visible

_visible: boolean = true

Defined in: core/Transform.ts:51

是否可见

Inherited from

Mesh._visible

---

attributeData?

optional attributeData: InstancedBufferAttribute

Defined in: objects/Sprite.ts:51

当前属性数据（色度条模式使用，在着色器中采样颜色纹理）

---

castShadow

castShadow: boolean = false

Defined in: core/Transform.ts:27

是否投射阴影

Inherited from

Mesh.castShadow

---

center

center: Vec2

Defined in: objects/Sprite.ts:34

The sprite's anchor point, and the point around which the sprite rotates. A value of (0.5, 0.5) corresponds to the midpoint of the sprite. A value of (0, 0) corresponds to the lower left corner of the sprite.

Default

(0.5,0.5)

---

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

---

geometry

geometry: BufferGeometry

Defined in: objects/Sprite.ts:87

几何体，定义物体的形状

Inherited from

Mesh.geometry

---

id

readonly id: number

Defined in: core/Transform.ts:40

唯一序号

Inherited from

Mesh.id

---

isSprite

isSprite: boolean = true

Defined in: objects/Sprite.ts:24

---

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: SpriteNodeMaterial

Defined in: objects/Sprite.ts:88

The sprite material.

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

---

originRange

originRange: [number, number][] = []

Defined in: objects/Sprite.ts:54

---

parent?

optional parent: Transform

Defined in: core/Transform.ts:63

父节点

Inherited from

Mesh.parent

---

pointCloudColor?

optional pointCloudColor: InstancedBufferAttribute

Defined in: objects/Sprite.ts:46

点云颜色矩阵（直接颜色模式使用）

---

pointsPos

pointsPos: InstancedBufferAttribute

Defined in: objects/Sprite.ts:41

点云位置 ==> 偏移

---

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/Sprite.ts:36

---

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

---

useScalarMode

useScalarMode: boolean = false

Defined in: objects/Sprite.ts:59

是否使用标量数据模式（true: 标量+纹理采样, false: 直接实例颜色渲染）

---

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

attrComponents

Get Signature

get attrComponents(): number

Defined in: objects/Sprite.ts:77

Returns

number

---

count

Get Signature

get count(): number

Defined in: objects/Sprite.ts:70

Returns

number

---

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?): Sprite

Defined in: core/Transform.ts:406

克隆当前节点

Parameters

recursive?

boolean

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

Returns

Sprite

克隆后的新节点

Inherited from

Mesh.clone

---

copy()

copy(source, recursive): Sprite

Defined in: objects/Sprite.ts:144

从源节点复制属性

Parameters

source

this

源节点

recursive

boolean

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

Returns

Sprite

this

Overrides

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

---

raycast()

raycast(raycaster, intersects): void

Defined in: objects/Sprite.ts:140

Computes intersection points between a casted ray and this sprite.

Parameters

raycaster

any

The raycaster.

intersects

any

The target array that holds the intersection points.

Returns

void

---

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/Sprite.ts:155

设置点云颜色数据 ==> 考虑是否可以使用uint?

Parameters

index

number

color

Color

Returns

void

---

setCount()

setCount(count, numberOfComponents): void

Defined in: objects/Sprite.ts:185

设置点云数量 若数量发生变化，则需要重新分配颜色和点云位置数据

Parameters

count

number

点云数量

numberOfComponents

number = null

分量个数

Returns

void

---

setMatrix()

setMatrix(m): void

Defined in: core/Transform.ts:190

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

Parameters

m

Mat4

变换矩阵

Returns

void

Inherited from

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

Mesh.setRotation

---

setScalarData()

setScalarData(data, numberOfComponents): void

Defined in: objects/Sprite.ts:169

设置标量数据（用于着色器采样颜色纹理） 暂时不支持单独修改里面的数组元素

Parameters

data

ArrayLike<number>

numberOfComponents

number

Returns

void

---

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

Defined in: core/Transform.ts:230

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

Parameters

axis

Vec3

移动轴 (Vec3)

distance

number

移动距离

Returns

Sprite

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