Class TypedGroup<T>

Type Parameters

T extends Model

Hierarchy

Group<T>
- TypedGroup

Implements

EventTarget

Index

Constructors

constructor

new TypedGroup<T>(iterable?: null | Iterable<T>): TypedGroup<T>
Type Parameters
- T extends Model<T>
Parameters
- Optional iterable: null | Iterable<T>
Returns TypedGroup<T>

Inherited from Group<T>.constructor

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Readonly` size

size: number

`Static` `Readonly` [species]

[species]: SetConstructor

Accessors

clickable

get clickable(): boolean
获取模型组的可点击状态当组内任一成员为可点击时，即为 true，否则 false。

Returns boolean

ids

get ids(): string[]
获取该组所包含的所有模型 id 列表。

Returns string[]

visible

get visible(): boolean
获取模型组的可见性状态。当组内任一成员为可见时，即为 true，否则 false。

Returns boolean

Methods

[iterator]

[iterator](): IterableIterator<T>
Iterates over values in the set.

Returns IterableIterator<T>

Inherited from Group.__@iterator@189

add

add(value: T): TypedGroup<T>
Parameters
- value: T
Returns TypedGroup<T>

Inherited from Group.add

addEventListener

addEventListener<K>(type: K, listener: ((this: Model, ev: GroupEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
Type Parameters
- K extends keyof GroupEventMap
Parameters
- type: K
- listener: ((this: Model, ev: GroupEventMap[K]) => any)
  - - (this: Model, ev: GroupEventMap[K]): any
    - Parameters
      
      this: Model
      
      ev: GroupEventMap[K]
      
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
addEventListener(type: string, listener: EventListener, options?: AddEventListenerOptions): void
Parameters
- type: string
- listener: EventListener
- Optional options: AddEventListenerOptions
Returns void

assemble

assemble(): Promise<void>
将已经拆解的状态下组装起来。

Returns Promise<void>

attach

attach(client: JsonRpcClient): void
Parameters
- client: JsonRpcClient
Returns void

clear

clear(): void
Returns void

Inherited from Group.clear

create

create(): Promise<void>
Returns Promise<void>

delete

delete(value: T): boolean
Parameters
- value: T
Returns boolean

Inherited from Group.delete

destroy

destroy(): Promise<void>
Returns Promise<void>

detach

detach(): void
Returns void

disassemble

disassemble(options: DisassemblableGroupOptions): Promise<void>
将当前模型组，在垂直朝上的方向按照选项配置进行拆解。
Parameters
- options: DisassemblableGroupOptions
  
  拆解参数选项
Returns Promise<void>

dispatchEvent

dispatchEvent(event: Event): boolean
Parameters
- event: Event
Returns boolean

entries

entries(): IterableIterator<[T, T]>
Returns an iterable of [v,v] pairs for every value v in the set.

Returns IterableIterator<[T, T]>

Inherited from Group.entries

forEach

forEach(callbackfn: ((value: T, value2: T, set: Set<T>) => void), thisArg?: any): void
Parameters
- callbackfn: ((value: T, value2: T, set: Set<T>) => void)
  - - (value: T, value2: T, set: Set<T>): void
    - Parameters
      
      value: T
      
      value2: T
      
      set: Set<T>
      
      Returns void
- Optional thisArg: any
Returns void

Inherited from Group.forEach

getBoundingInfo

getBoundingInfo(): Promise<BoundingInfo>
获取当前模型组的边界包围数据。

Returns Promise<BoundingInfo>

has

has(value: T): boolean
Parameters
- value: T
Returns boolean

Inherited from Group.has

keys

keys(): IterableIterator<T>
Despite its name, returns an iterable of the values in the set.

Returns IterableIterator<T>

Inherited from Group.keys

removeEventListener

removeEventListener<K>(type: K, listener: ((this: Model, ev: GroupEventMap[K]) => any), options?: boolean | EventListenerOptions): void
Type Parameters
- K extends keyof GroupEventMap
Parameters
- type: K
- listener: ((this: Model, ev: GroupEventMap[K]) => any)
  - - (this: Model, ev: GroupEventMap[K]): any
    - Parameters
      
      this: Model
      
      ev: GroupEventMap[K]
      
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
removeEventListener(type: string, callback: EventListener): void
Parameters
- type: string
- callback: EventListener
Returns void

rotateByAll

rotateByAll(delta: Quaternion): Promise<void>
将模型组在当前旋转的基础之上，以模型组的几何中心为变换中心，做增量旋转。
Parameters
- delta: Quaternion
  
  旋转增量四元数
Returns Promise<void>

rotateByEach

rotateByEach(delta: Quaternion): Promise<void>
将模型组在当前旋转的基础之上做增量旋转。
Parameters
- delta: Quaternion
  
  旋转增量四元数
Returns Promise<void>

scalingByAll

scalingByAll(delta: Vector3): Promise<void>
将模型组在当前平移的基础之上，以模型组的几何中心为变换中心，做增量缩放。
Parameters
- delta: Vector3
  
  缩放增量向量
Returns Promise<void>

scalingByEach

scalingByEach(delta: Vector3): Promise<void>
将模型组在当前平移的基础之上做增量缩放。
Parameters
- delta: Vector3
  
  缩放增量向量
Returns Promise<void>

setClickability

setClickability(clickable: boolean): Promise<void>
设置组成员可点击性。

Deprecated
请用 setClickable 代替
Parameters
- clickable: boolean
  
  可点击性
Returns Promise<void>

setClickable

setClickable(clickable: boolean): Promise<void>
设置组成员可点击性。
Parameters
- clickable: boolean
  
  可点击性
Returns Promise<void>

setRenderMode

setRenderMode(mode: Emission | Emission, opt: { color: string; speed?: number; strength?: number }): Promise<void>
将组内全部模型设置为指定的渲染风格模式。
Parameters
- mode: Emission | Emission
  
  自发光渲染模式
- opt: { color: string; speed?: number; strength?: number }
  
  自发光参数选项
  - color: string
    
    自发光颜色, HEX 色值，支持 alpha 通道。
  - Optional speed?: number
    
    闪烁速度，取值范围 0~20
  - Optional strength?: number
    
    自发光强度,取值范围 0~50，建议不超过 0.5，否则容易过亮。
Returns Promise<void>
setRenderMode(mode: Default | Alarm | Translucence | Hidden | Highlight | Default | Alarm | Translucence | Hidden | Highlight): Promise<void>
将组内全部模型设置为指定的渲染风格模式。
Parameters
- mode: Default | Alarm | Translucence | Hidden | Highlight | Default | Alarm | Translucence | Hidden | Highlight
  
  渲染风格模式
Returns Promise<void>

setRenderingStyleMode

setRenderingStyleMode(mode: Emission | Emission, opt: { color: string; speed?: number; strength?: number }): Promise<void>
将组内全部模型设置为指定的渲染风格模式。

Deprecated
请使用 setRenderMode 代替
Parameters
- mode: Emission | Emission
  
  自发光渲染模式
- opt: { color: string; speed?: number; strength?: number }
  
  自发光参数选项
  - color: string
    
    自发光颜色, HEX 色值，支持 alpha 通道。
  - Optional speed?: number
    
    闪烁速度，取值范围 0~20
  - Optional strength?: number
    
    自发光强度,取值范围 0~50，建议不超过 0.5，否则容易过亮。
Returns Promise<void>
setRenderingStyleMode(mode: Default | Alarm | Translucence | Hidden | Highlight | Default | Alarm | Translucence | Hidden | Highlight): Promise<void>
将组内全部模型设置为指定的渲染风格模式。

Deprecated
请使用 setRenderMode 代替
Parameters
- mode: Default | Alarm | Translucence | Hidden | Highlight | Default | Alarm | Translucence | Hidden | Highlight
  
  渲染风格模式
Returns Promise<void>

setVisibility

setVisibility(visible: boolean): Promise<void>
设置组成员可见性。

Deprecated
请用 setVisible 代替
Parameters
- visible: boolean
  
  可见性
Returns Promise<void>

setVisible

setVisible(visible: boolean): Promise<void>
设置组成员可见性。
Parameters
- visible: boolean
  
  可见性
Returns Promise<void>

translate

translate(delta: Vector3): Promise<void>
将模型组在当前平移的基础之上做增量平移。
Parameters
- delta: Vector3
  
  平移增量向量
Returns Promise<void>

values

values(): IterableIterator<T>
Returns an iterable of values in the set.

Returns IterableIterator<T>

Inherited from Group.values

`Static` Create

Create<T>(client: JsonRpcClient, ctor: Class<T>, iterable?: null | Iterable<T>): TypedGroup<T>
Type Parameters
- T extends Model<T>
Parameters
- client: JsonRpcClient
- ctor: Class<T>
- Optional iterable: null | Iterable<T>
Returns TypedGroup<T>

`Static` From

From(iterable: null | Iterable<GroupData>, config: TypedGroupFromMappingConfig): TypedGroup<Model>
Parameters
- iterable: null | Iterable<GroupData>
- config: TypedGroupFromMappingConfig
Returns TypedGroup<Model>

`Static` Typify

Typify<T>(ctor: Class<T>, group: TypedGroup<T>): TypedGroup<T>
Type Parameters
- T extends Model<T>
Parameters
- ctor: Class<T>
- group: TypedGroup<T>
Returns TypedGroup<T>

Class TypedGroup<T>

Type Parameters

T extends Model

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends Model<T>

Parameters

Optional iterable: null | Iterable<T>

Returns TypedGroup<T>

Properties

Readonly [toStringTag]

Readonly size

Static Readonly [species]

Accessors

clickable

Returns boolean

ids

Returns string[]

visible

Returns boolean

Methods

[iterator]

Returns IterableIterator<T>

add

Parameters

value: T

Returns TypedGroup<T>

addEventListener

Type Parameters

K extends keyof GroupEventMap

Parameters

type: K

listener: ((this: Model, ev: GroupEventMap[K]) => any)

Parameters

this: Model

ev: GroupEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListener

Optional options: AddEventListenerOptions

Returns void

assemble

Returns Promise<void>

attach

Parameters

client: JsonRpcClient

Returns void

clear

Returns void

create

Returns Promise<void>

delete

Parameters

value: T

Returns boolean

destroy

Returns Promise<void>

detach

Returns void

disassemble

Parameters

options: DisassemblableGroupOptions

Returns Promise<void>

dispatchEvent

`Optional` iterable: null | Iterable<T>

`Readonly` [toStringTag]

`Readonly` size

`Static` `Readonly` [species]

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: AddEventListenerOptions

`Optional` thisArg: any

`Optional` options: boolean | EventListenerOptions

`Optional` options: boolean | EventListenerOptions