Class InstancedMesh

Hierarchy

Mesh
- InstancedMesh

Constructors

constructor

new InstancedMesh(geom: Geometry, mat: Material, instanceCount: number): InstancedMesh

Overrides Mesh.constructor
- Defined in glc/dist/Mesh/InstancedMesh.d.ts:9
Parameters
- geom: Geometry
- mat: Material
- instanceCount: number
Returns InstancedMesh

Properties

Private _checkIsIndexInvalid

_checkIsIndexInvalid: any

检查索引是否合法

param idx: 实例索引

Private _initInstanceAttributes

_initInstanceAttributes: any

初始化实例属性设置

Private _instanceColors

_instanceColors: any

Private _instanceMatrixes

_instanceMatrixes: any

Protected _isLocalMatrixDirty

_isLocalMatrixDirty: boolean

_listeners

_listeners: Map<string, TinoeEventListener[]>

Protected _localMatrix

_localMatrix: Matrix4

Private _onChange

_onChange: any

Protected _shouldUpdateWorldMatrix

_shouldUpdateWorldMatrix: boolean

Private _uploadData

_uploadData: any

上传实例属性数据

param key: 实例属性key
returns: void

bbox

bbox: BBox

castShadow

castShadow: boolean

children

children: Object3D[]

coreData

coreData: CoreData

drawMode

drawMode: DrawMode

geometry

geometry: BufferGeometry

instanceCount

instanceCount: number

material

material: Material

name

name: string

parent

parent: Object3D

position

position: Vector3

rotation

rotation: Quaternion

scale

scale: Vector3

visible

visible: boolean

worldMatrix

worldMatrix: Matrix4

Accessors

localMatrix

get localMatrix(): Matrix4

Inherited from Mesh.localMatrix
- Defined in glc/dist/Object3D.d.ts:15
Returns Matrix4

Methods

Protected _addChild

_addChild(c: Object3D): void

Inherited from Mesh._addChild
- Defined in glb/dist/node/index.d.ts:16
添加子节点

Parameters
- c: Object3D
  
  子节点
Returns void

Protected _onPositionChange

_onPositionChange(): void

Inherited from Mesh._onPositionChange
- Defined in glc/dist/Object3D.d.ts:21
Returns void

Protected _onRotationChange

_onRotationChange(): void

Inherited from Mesh._onRotationChange
- Defined in glc/dist/Object3D.d.ts:22
Returns void

Protected _onScaleChange

_onScaleChange(): void

Inherited from Mesh._onScaleChange
- Defined in glc/dist/Object3D.d.ts:23
Returns void

Protected _onTransformChange

_onTransformChange(): void

Inherited from Mesh._onTransformChange
- Defined in glc/dist/Object3D.d.ts:19
Returns void

Protected _removeChild

_removeChild(c: Object3D): void

Inherited from Mesh._removeChild
- Defined in glb/dist/node/index.d.ts:11
删除子节点

Parameters
- c: Object3D
  
  子节点
Returns void

Protected _tapTransformChange

_tapTransformChange(obj: ObservedInstanceType<(new (x?: number, y?: number, z?: number) => Vector3 & { elements: readonly number[]; tapChange: any }) & typeof Vector3> | ObservedInstanceType<(new (x?: number, y?: number, z?: number, w?: number) => Quaternion & { elements: readonly number[]; tapChange: any }) & typeof Quaternion>): void

Inherited from Mesh._tapTransformChange
- Defined in glc/dist/Object3D.d.ts:20
Parameters
- obj: ObservedInstanceType<(new (x?: number, y?: number, z?: number) => Vector3 & { elements: readonly number[]; tapChange: any }) & typeof Vector3> | ObservedInstanceType<(new (x?: number, y?: number, z?: number, w?: number) => Quaternion & { elements: readonly number[]; tapChange: any }) & typeof Quaternion>
Returns void

addChildren

addChildren(...children: Object3D[]): void

Inherited from Mesh.addChildren
- Defined in glb/dist/node/index.d.ts:21
添加1～n个子节点

Parameters
- Rest ...children: Object3D[]
  
  待添加节点
Returns void

addEventListener

addEventListener(type: string, handler: ((data: any) => any), once?: boolean): void

Inherited from Mesh.addEventListener
- Defined in glb/dist/event/EventEmitter.d.ts:28
注册handler

memberof
EventEmitter

Parameters
- type: string
- handler: ((data: any) => any)
  - - (data: any): any
    - Parameters
      - data: any
      Returns any
- Optional once: boolean
Returns void

clone

clone(): Mesh<BufferGeometry, Material>

Inherited from Mesh.clone
- Defined in glc/dist/Mesh/Mesh.d.ts:27
克隆

Returns Mesh<BufferGeometry, Material>

destroy

destroy(): void

Inherited from Mesh.destroy
- Defined in glc/dist/Mesh/Mesh.d.ts:28
销毁 TODO: Mesh的销毁是否需要特殊处理

Returns void

disable

disable(): void

Inherited from Mesh.disable
- Defined in glc/dist/Object3D.d.ts:93
Returns void

dispatch

dispatch(type: any, event: TinoeEvent): void

Inherited from Mesh.dispatch
- Defined in glc/dist/Object3D.d.ts:105
派发事件

Parameters
- type: any
- event: TinoeEvent
Returns void

enable

enable(): void

Inherited from Mesh.enable
- Defined in glc/dist/Object3D.d.ts:92
Returns void

getChildByName

getChildByName(name: string, findAll?: boolean): Object3D | Node<Node<any>>[]

Inherited from Mesh.getChildByName
- Defined in glb/dist/node/index.d.ts:37
根据name标识查找子节点

Parameters
- name: string
  
  标识
- Optional findAll: boolean
  
  是否查找所有符合name标识的节点
Returns Object3D | Node<Node<any>>[]
查找到的节点

off

off(type?: string, handler?: ((data: any) => any)): void

Inherited from Mesh.off
- Defined in glb/dist/event/EventEmitter.d.ts:44
注销事件

memberof
EventEmitter

Parameters
- Optional type: string
- Optional handler: ((data: any) => any)
  - - (data: any): any
    - Parameters
      - data: any
      Returns any
Returns void
{void}

on

on(type: string, handler: ((data: any) => any), once?: boolean): void

Inherited from Mesh.on
- Defined in glb/dist/event/EventEmitter.d.ts:20
注册handler

memberof
EventEmitter

Parameters
- type: string
- handler: ((data: any) => any)
  - - (data: any): any
    - Parameters
      - data: any
      Returns any
- Optional once: boolean
Returns void

removeChildren

removeChildren(...children: Object3D[]): void

Inherited from Mesh.removeChildren
- Defined in glb/dist/node/index.d.ts:26
删除1～n个字节点

Parameters
- Rest ...children: Object3D[]
  
  待删除节点
Returns void

removeEventListener

removeEventListener(type?: string, handler?: ((data: any) => any), once?: boolean): void

Inherited from Mesh.removeEventListener
- Defined in glb/dist/event/EventEmitter.d.ts:36
注销handler

memberof
EventEmitter

Parameters
- Optional type: string
- Optional handler: ((data: any) => any)
  - - (data: any): any
    - Parameters
      - data: any
      Returns any
- Optional once: boolean
Returns void

removeFromParent

removeFromParent(): void

Inherited from Mesh.removeFromParent
- Defined in glb/dist/node/index.d.ts:30
从父节点中删除自己

Returns void

rotate

rotate(axis: Vector3, degrees: number): void

Inherited from Mesh.rotate
- Defined in glc/dist/Object3D.d.ts:70
旋转

Parameters
- axis: Vector3
  
  旋转中心轴
- degrees: number
  
  旋转角度
Returns void

rotateX

rotateX(degrees: number): void

Inherited from Mesh.rotateX
- Defined in glc/dist/Object3D.d.ts:75
沿x轴旋转

Parameters
- degrees: number
  
  旋转角度
Returns void

rotateY

rotateY(degrees: number): void

Inherited from Mesh.rotateY
- Defined in glc/dist/Object3D.d.ts:80
沿y轴旋转

Parameters
- degrees: number
  
  旋转角度
Returns void

rotateZ

rotateZ(degrees: number): void

Inherited from Mesh.rotateZ
- Defined in glc/dist/Object3D.d.ts:85
沿z轴旋转

Parameters
- degrees: number
  
  旋转角度
Returns void

scaleX

scaleX(factor: number, originX?: number): void

Inherited from Mesh.scaleX
- Defined in glc/dist/Mesh/Mesh.d.ts:30
沿x轴方向缩放

Parameters
- factor: number
- Optional originX: number
Returns void

scaleY

scaleY(factor: number, originY?: number): void

Inherited from Mesh.scaleY
- Defined in glc/dist/Mesh/Mesh.d.ts:31
沿y轴方向缩放

Parameters
- factor: number
- Optional originY: number
Returns void

scaleZ

scaleZ(factor: number, originZ?: number): void

Inherited from Mesh.scaleZ
- Defined in glc/dist/Mesh/Mesh.d.ts:32
沿z轴方向缩放

Parameters
- factor: number
- Optional originZ: number
Returns void

scaling

scaling(x: number, y: number, z: number, origin?: ITransformOrigin): void

Inherited from Mesh.scaling
- Defined in glc/dist/Mesh/Mesh.d.ts:29
缩放

Parameters
- x: number
- y: number
- z: number
- Optional origin: ITransformOrigin
Returns void

setColorByIndex

setColorByIndex(idx: number, value: number[] | Color): void

- Defined in glc/dist/Mesh/InstancedMesh.d.ts:41
按索引位置更新实例颜色

Parameters
- idx: number
  
  索引
- value: number[] | Color
  
  值，为number[]类型时，以[r, g, b, a]为一组，且每个元素值的范围在0～1
Returns void

setColors

setColors(values: number[]): void

- Defined in glc/dist/Mesh/InstancedMesh.d.ts:46
全量更新实例颜色值

Parameters
- values: number[]
Returns void

setMatrixByIndex

setMatrixByIndex(idx: number, value: number[] | Matrix4): void

- Defined in glc/dist/Mesh/InstancedMesh.d.ts:30
根据索引更新实例矩阵值

Parameters
- idx: number
  
  实例索引
- value: number[] | Matrix4
  
  矩阵值
Returns void

setMatrixes

setMatrixes(values: number[]): void

- Defined in glc/dist/Mesh/InstancedMesh.d.ts:35
全量更新实例矩阵

Parameters
- values: number[]
Returns void

translate

translate(x: number, y: number, z: number): void

Inherited from Mesh.translate
- Defined in glc/dist/Object3D.d.ts:29
平移

Parameters
- x: number
- y: number
- z: number
Returns void

translateX

translateX(shift: number): void

Inherited from Mesh.translateX
- Defined in glc/dist/Object3D.d.ts:34
沿x轴方向平移

Parameters
- shift: number
  
  平移量
Returns void

translateY

translateY(shift: number): void

Inherited from Mesh.translateY
- Defined in glc/dist/Object3D.d.ts:39
沿y轴方向平移

Parameters
- shift: number
  
  平移量
Returns void

translateZ

translateZ(shift: number): void

Inherited from Mesh.translateZ
- Defined in glc/dist/Object3D.d.ts:44
沿z轴方向平移

Parameters
- shift: number
  
  平移量
Returns void

traverse

traverse(callback: ((n: Object3D) => void), isIncludingSelf?: boolean): void

Inherited from Mesh.traverse
- Defined in glb/dist/node/index.d.ts:43
遍历节点

Parameters
- callback: ((n: Object3D) => void)
  
  回调函数
  - - (n: Object3D): void
    - Parameters
      - n: Object3D
      Returns void
- Optional isIncludingSelf: boolean
  
  自己是否执行回调函数，默认为true
Returns void

updateWorldMatrix

updateWorldMatrix(updateChildren?: boolean, isParentDirty?: boolean): boolean

Inherited from Mesh.updateWorldMatrix
- Defined in glc/dist/Mesh/Mesh.d.ts:26
更新世界矩阵

memberof
Mesh

Parameters
- Optional updateChildren: boolean
  
  是否更新后代节点
- Optional isParentDirty: boolean
  
  是否父节点有变更
Returns boolean

Generated using TypeDoc