Class InstancedMeshModule

实例化mesh模块

Hierarchy (view full)

EntityModuleBase
- InstancedMeshModule

Implements

IEntityModuleBase

Index

Constructors

constructor

new InstancedMeshModule(entity, options?): InstancedMeshModule
Parameters
- entity: Entity
- Optional options: InstancedMeshModuleOption
Returns InstancedMeshModule
Overrides EntityModuleBase.constructor

Properties

`Optional` _app

_app?: App

`Protected` _destroyed

_destroyed: boolean = false

appRenderIndex

appRenderIndex: number = 0

data

data: ShallowReactive<{
[key: string]: any;
}> = ...

Type declaration

[key: string]: any

entity

entity: Entity

extData

extData: {
[key: string]: any;
} = {}

Type declaration

[key: string]: any

idIndexMap

idIndexMap: BidirectionalMap = ...

instConfig

instConfig: Record<string, {
    color?: Color;
    isBloom?: boolean;
    isHighlight?: boolean;
    isOutline?: boolean;
    isSelected?: boolean;
    position?: Vector3;
    rotation?: Vector3;
    scale?: number | Vector3;
}> = {}

Type declaration

Optional color?: Color
Optional isBloom?: boolean
Optional isHighlight?: boolean
Optional isOutline?: boolean
Optional isSelected?: boolean
Optional position?: Vector3
Optional rotation?: Vector3
Optional scale?: number | Vector3

`Readonly` instanceId

instanceId: number = ++AppObject._instanceIdCounter

instancedMeshList

instancedMeshList: DynamicInstancedMesh[] = []

matrixWorldList

matrixWorldList: Matrix4[] = []

meshList

meshList: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[] = []

onInstanceTransformChangedSignal

onInstanceTransformChangedSignal: Signal = ...

onSetApp

onSetApp: Signal = ...

uuidList

uuidList: string[] = []

`Static` moduleName

moduleName: string = "InstancedMeshModule"

Accessors

app

get app(): App
Returns App
Inherited from EntityModuleBase.app
set app(value): void
Parameters
- value: App
Returns void
Inherited from EntityModuleBase.app

destroyed

get destroyed(): boolean
Whether it has been destroyed.

Returns boolean
Inherited from EntityModuleBase.destroyed

enabled

get enabled(): boolean
Indicates whether the component is enabled.

Returns boolean
Inherited from EntityModuleBase.enabled
set enabled(value): void
Parameters
- value: boolean
Returns void
Inherited from EntityModuleBase.enabled

uiConfig

get uiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>
Inherited from EntityModuleBase.uiConfig

Methods

_onAwake

_onAwake(): void
Internal
Returns void
Inherited from EntityModuleBase._onAwake

_onDestroy

_onDestroy(): void
Internal
Returns void
Inherited from EntityModuleBase._onDestroy

_onDisable

_onDisable(): void
Internal
Returns void
Inherited from EntityModuleBase._onDisable

_onEnable

_onEnable(): void
Internal
Returns void
Inherited from EntityModuleBase._onEnable

_setActive

_setActive(value): void
Internal
Parameters
- value: boolean
Returns void
Inherited from EntityModuleBase._setActive

addDispose

addDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from EntityModuleBase.addDispose

addInstance

addInstance(opts): any
增加实例化对象，如果id为空，则自动增加，如存在，则修改
Parameters
- opts: {
      color?: Color;
      computeBoundingSphere?: boolean;
      id: string;
      position?: Vector3;
      rotation?: Vector3;
      scale?: number | Vector3;
  }
  - Optional color?: Color
  - Optional computeBoundingSphere?: boolean
  - id: string
  - Optional position?: Vector3
  - Optional rotation?: Vector3
  - Optional scale?: number | Vector3
Returns any

applyMixinsTo

applyMixinsTo(toClassInst, methodNames?, addMethods?, filterName?): void
Parameters
- toClassInst: any
- Optional methodNames: string[]
- Optional addMethods: string[]
- Optional filterName: string[]
Returns void
Inherited from EntityModuleBase.applyMixinsTo

clearInstanceBloom

clearInstanceBloom(): void
清除所有实例辉光

Returns void

clearInstanceHighlight

clearInstanceHighlight(): void
清除所有实例高亮

Returns void

clearInstanceOutline

clearInstanceOutline(): void
清除所有实例描边

Returns void

clearInstanceSelected

clearInstanceSelected(): void
清除所有实例选择

Returns void

destroy

destroy(): void
Destroy self.

Returns void
Inherited from EntityModuleBase.destroy

dispatch

dispatch(event, ...data): boolean
触发指定事件名称.
Parameters
- event: string
  Event name
- Rest ...data: any
  Data
Returns boolean
- Whether the dispatching is successful
Inherited from EntityModuleBase.dispatch

effectScope

effectScope(fn): void
Parameters
- fn: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from EntityModuleBase.effectScope

eventNames

eventNames(): string[]
返回注册的所有事件名.

Returns string[]
所有事件名

Inherited from EntityModuleBase.eventNames

getGroup

getGroup(): Group<Object3DEventMap>
获取实体化的组对象

Returns Group<Object3DEventMap>

getIdByIndex

getIdByIndex(index): string
通过id获取索引
Parameters
- index: number
Returns string

getIndexById

getIndexById(id): number
通过索引获取id
Parameters
- id: string
Returns number

getInstanceAttr

getInstanceAttr(id, key): any
获取实例属性
Parameters
- id: string
  id
- key: string
Returns any

getInstanceBox3

getInstanceBox3(id): Box3
获取实例的外包盒
Parameters
- id: string
  id
Returns Box3

getInstancedMeshList

getInstancedMeshList(): DynamicInstancedMesh[]
获取实体化mesh列表

Returns DynamicInstancedMesh[]

hasEvent

hasEvent(event): boolean
确定是否存在事件侦听
Parameters
- event: string
  事件名
Returns boolean
返回是否存在相应的事件

Inherited from EntityModuleBase.hasEvent

isInstanceBloom

isInstanceBloom(id): any
实例是否辉光
Parameters
- id: string
  id
Returns any

isInstanceHighlight

isInstanceHighlight(id): any
实例是否高亮
Parameters
- id: string
  id
Returns any

isInstanceOutline

isInstanceOutline(id): any
实例是否描边
Parameters
- id: string
  id
Returns any

isInstanceSelected

isInstanceSelected(id): any
实例是否选中
Parameters
- id: string
  id
Returns any

listenerCount

listenerCount(event): number
返回具有指定事件名称的侦听总数.
Parameters
- event: string
  Event name
Returns number
The count of listeners

Inherited from EntityModuleBase.listenerCount

off

off(event, fn?): EventDispatcher
移除监听.
Parameters
- event: string
  Event name
- Optional fn: Function
  Function, If is undefined, delete all corresponding event listeners.
Returns EventDispatcher
Inherited from EntityModuleBase.off

on

on(event, fn): EventDispatcher
增加监听
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from EntityModuleBase.on

once

once(event, fn): EventDispatcher
只监听一次.
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from EntityModuleBase.once

removeAllEventListeners

removeAllEventListeners(event?): void
通过事件名移除所有监听.
Parameters
- Optional event: string
  Event name, delete all events if not passed
Returns void
Inherited from EntityModuleBase.removeAllEventListeners

removeDispose

removeDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from EntityModuleBase.removeDispose

removeInstance

removeInstance(id, computeBoundingSphere?): void
根据一个id删除实例化对象
Parameters
- id: string
- Optional computeBoundingSphere: boolean
Returns void

setInstance

setInstance(opts): any
根据id设置实例化对象属性，如不存在，则新增，如果id为空，则自动增加
Parameters
- opts: {
      color?: Color;
      computeBoundingSphere?: boolean;
      id: string;
      position?: Vector3;
      rotation?: Vector3;
      scale?: number | Vector3;
  }
  - Optional color?: Color
  - Optional computeBoundingSphere?: boolean
  - id: string
  - Optional position?: Vector3
  - Optional rotation?: Vector3
  - Optional scale?: number | Vector3
Returns any

setInstanceAttr

setInstanceAttr(id, key, value): void
设置实例属性
Parameters
- id: string
  id
- key: string
- value: any
Returns void

setInstanceBloom

setInstanceBloom(id, isBloom?): void
设置实例辉光与否
Parameters
- id: string
  id
- Optional isBloom: boolean
Returns void

setInstanceHighlight

setInstanceHighlight(id, highlightColor?): void
设置实例高亮与否
Parameters
- id: string
  id
- Optional highlightColor: ColorRepresentation
  高亮颜色，如果为null，则表示取消高亮
Returns void

setInstanceOutline

setInstanceOutline(id, isOutline?): void
设置实例描边与否
Parameters
- id: string
  id
- Optional isOutline: boolean
Returns void

setInstanceSelected

setInstanceSelected(id, isSelected?): void
设置实例选择与否
Parameters
- id: string
  id
- Optional isSelected: boolean
Returns void

Class InstancedMeshModule

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

entity: Entity

Optional options: InstancedMeshModuleOption

Returns InstancedMeshModule

Properties

Optional _app

Protected _destroyed

appRenderIndex

data

Type declaration

[key: string]: any

entity

extData

Type declaration

[key: string]: any

idIndexMap

instConfig

Type declaration

Optional color?: Color

Optional isBloom?: boolean

Optional isHighlight?: boolean

Optional isOutline?: boolean

Optional isSelected?: boolean

Optional position?: Vector3

Optional rotation?: Vector3

Optional scale?: number | Vector3

Readonly instanceId

instancedMeshList

matrixWorldList

meshList

onInstanceTransformChangedSignal

onSetApp

uuidList

Static moduleName

Accessors

app

Returns App

Parameters

value: App

Returns void

destroyed

Returns boolean

enabled

Returns boolean

Parameters

value: boolean

Returns void

uiConfig

Returns UiObjectConfig<any, string, any>

Methods

_onAwake

Returns void

_onDestroy

Returns void

_onDisable

Returns void

_onEnable

Returns void

_setActive

Parameters

value: boolean

Returns void

addDispose

Parameters

cb: Function

Returns void

addInstance

Parameters

opts: { color?: Color; computeBoundingSphere?: boolean; id: string; position?: Vector3; rotation?: Vector3; scale?: number | Vector3; }

Optional color?: Color

`Optional` options: InstancedMeshModuleOption

`Optional` _app

`Protected` _destroyed

`Optional` color?: Color

`Optional` isBloom?: boolean

`Optional` isHighlight?: boolean

`Optional` isOutline?: boolean

`Optional` isSelected?: boolean

`Optional` position?: Vector3

`Optional` rotation?: Vector3

`Optional` scale?: number | Vector3

`Readonly` instanceId

`Static` moduleName

opts: {
color?: Color;
computeBoundingSphere?: boolean;
id: string;
position?: Vector3;
rotation?: Vector3;
scale?: number | Vector3;
}

`Optional` color?: Color

`Optional` computeBoundingSphere?: boolean

`Optional` position?: Vector3

`Optional` rotation?: Vector3

`Optional` scale?: number | Vector3

`Optional` methodNames: string[]

`Optional` addMethods: string[]

`Optional` filterName: string[]

`Rest` ...data: any