Class ParticleColorBySpeedModule

the Color By Speed module.

颜色随速度变化模块。

Hierarchy

ParticleModule
- ParticleColorBySpeedModule

Index

Constructors

constructor

new ParticleColorBySpeedModule(target?: any): ParticleColorBySpeedModule
Parameters
- Optional target: any
Returns ParticleColorBySpeedModule
Inherited from ParticleModule.constructor
- Defined in src/event/EventEmitter.ts:56

Properties

color

color: MinMaxGradient = ...

The gradient controlling the particle colors.

控制粒子颜色的梯度。

enabled

enabled: boolean = false

是否开启

particleSystem

particleSystem: ParticleSystem3D

粒子系统

range

range: Vector2 = ...

Apply the color gradient between these minimum and maximum speeds.

在这些最小和最大速度之间应用颜色渐变。

Methods

broadcast

broadcast<K>(type: K, data?: any): IEvent<any>
将事件广播到下级对象中。

Returns
返回广播后的事件。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: any
  
  事件携带的自定义数据。
Returns IEvent<any>
Inherited from ParticleModule.broadcast
- Defined in src/event/EventEmitter.ts:176

bubbles

bubbles<K>(type: K, data?: any): IEvent<any>
将事件冒泡到上级对象中。

Returns
返回冒泡后的事件。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: any
  
  事件携带的自定义数据。
Returns IEvent<any>
Inherited from ParticleModule.bubbles
- Defined in src/event/EventEmitter.ts:189

dispose

dispose(): void
销毁

Returns void
Inherited from ParticleModule.dispose
- Defined in src/event/EventEmitter.ts:535

emit

emit<K>(type: K, data?: any, bubbles?: boolean, broadcast?: boolean, share?: boolean): IEvent<any>
发射事件。

Returns
返回发射后的事件。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: any
  
  事件携带的自定义数据。
- bubbles: boolean = false
  
  是否向上级报告事件。默认为false。
- broadcast: boolean = false
  
  是否向下级广播事件。默认为false。
- share: boolean = true
  
  是否向平级分享事件。默认为true。
Returns IEvent<any>
Inherited from ParticleModule.emit
- Defined in src/event/EventEmitter.ts:145

emitEvent

emitEvent<K>(event: IEvent<any>): IEvent<any>
发射事件。

当事件重复流向一个对象时将不会被处理。

Returns
返回事件是否被处理
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件对象
Returns IEvent<any>
Inherited from ParticleModule.emitEvent
- Defined in src/event/EventEmitter.ts:110

eventNames

eventNames<K>(): K[]
返回监听的事件类型列表。
Type Parameters
- K extends string
Returns K[]
Inherited from ParticleModule.eventNames
- Defined in src/event/EventEmitter.ts:70

`Protected` handelEventBroadcast

handelEventBroadcast<K>(event: IEvent<any>): void
向下级广播事件
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件
Returns void
Inherited from ParticleModule.handelEventBroadcast
- Defined in src/event/EventEmitter.ts:506

`Protected` handelEventBubbles

handelEventBubbles<K>(event: IEvent<any>): void
向上级报告事件
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件
Returns void
Inherited from ParticleModule.handelEventBubbles
- Defined in src/event/EventEmitter.ts:475

`Protected` handelEventShare

handelEventShare<K>(event: IEvent<any>): void
向平级分享事件
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件
Returns void
Inherited from ParticleModule.handelEventShare
- Defined in src/event/EventEmitter.ts:451

`Protected` handleEvent

handleEvent<K>(e: IEvent<any>): void
处理事件
Type Parameters
- K extends string
Parameters
- e: IEvent<any>
  
  事件
Returns void
Inherited from ParticleModule.handleEvent
- Defined in src/event/EventEmitter.ts:389

has

has<K>(type: K): boolean
检查 Event 对象是否为特定事件类型注册了任何侦听器.

Returns
如果指定类型的侦听器已注册，则值为 true；否则，值为 false。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
Returns boolean
Inherited from ParticleModule.has
- Defined in src/event/EventEmitter.ts:200

initParticleState

initParticleState(particle: Particle): void
初始化粒子状态
Parameters
- particle: Particle
  
  粒子
Returns void
Overrides ParticleModule.initParticleState
- Defined in src/3d/particlesystem/modules/ParticleColorBySpeedModule.ts:41

listenerCount

listenerCount<K>(type: K): number
返回指定事件类型的监听数量。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
Returns number
Inherited from ParticleModule.listenerCount
- Defined in src/event/EventEmitter.ts:82

off

off<K>(type?: K, listener?: ((event: IEvent<any>) => void), thisObject?: any): ParticleColorBySpeedModule
移除监听
Type Parameters
- K extends string
Parameters
- Optional type: K
  
  事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。
- Optional listener: ((event: IEvent<any>) => void)
  
  要删除的监听器对象。可选。该值为空时所有指定类型的监听均将被移除。
  - - (event: IEvent<any>): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
Returns ParticleColorBySpeedModule
Inherited from ParticleModule.off
- Defined in src/event/EventEmitter.ts:253

offAll

offAll<K>(type?: K): ParticleColorBySpeedModule
移除所有监听
Type Parameters
- K extends string
Parameters
- Optional type: K
  
  事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。
Returns ParticleColorBySpeedModule
Inherited from ParticleModule.offAll
- Defined in src/event/EventEmitter.ts:303

offAny

offAny<K>(listener?: ((event: IEvent<any>) => void), thisObject?: any): ParticleColorBySpeedModule
移除监听对象的任意事件。
Type Parameters
- K extends string
Parameters
- Optional listener: ((event: IEvent<any>) => void)
  
  处理事件的监听器函数。
  - - (event: IEvent<any>): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
Returns ParticleColorBySpeedModule
Inherited from ParticleModule.offAny
- Defined in src/event/EventEmitter.ts:353

on

on<K>(type: K, listener: ((event: IEvent<any>) => void), thisObject?: any, priority?: number, once?: boolean): ParticleColorBySpeedModule
为监听对象新增指定类型的事件监听。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
- listener: ((event: IEvent<any>) => void)
  
  处理事件的监听器函数。
  - - (event: IEvent<any>): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
- priority: number = 0
  
  事件监听器的优先级。数字越大，优先级越高。默认为0。
- once: boolean = false
  
  值为true时在监听一次事件后该监听器将被移除。默认为false。
Returns ParticleColorBySpeedModule
Inherited from ParticleModule.on
- Defined in src/event/EventEmitter.ts:214

onAny

onAny<K>(listener: ((event: IEvent<any>) => void), thisObject?: any, priority?: number, once?: boolean): ParticleColorBySpeedModule
监听对象的任意事件，该对象的任意事件都将触发该监听器的调用。
Type Parameters
- K extends string
Parameters
- listener: ((event: IEvent<any>) => void)
  
  处理事件的监听器函数。
  - - (event: IEvent<any>): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
- priority: number = 0
  
  事件监听器的优先级。数字越大，优先级越高。默认为0。
- once: boolean = false
  
  值为true时在监听一次事件后该监听器将被移除。默认为false。
Returns ParticleColorBySpeedModule
Inherited from ParticleModule.onAny
- Defined in src/event/EventEmitter.ts:318

once

once<K>(type: K, listener: ((event: IEvent<any>) => void), thisObject?: any, priority?: number): ParticleColorBySpeedModule
监听一次事件后将会被移除
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
- listener: ((event: IEvent<any>) => void)
  
  处理事件的侦听器函数。
  - - (event: IEvent<any>): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  listener函数作用域
- priority: number = 0
  
  事件侦听器的优先级。数字越大，优先级越高。默认优先级为 0。
Returns ParticleColorBySpeedModule
Inherited from ParticleModule.once
- Defined in src/event/EventEmitter.ts:95

update

update(_interval: number): void
更新
Parameters
- _interval: number
Returns void
Inherited from ParticleModule.update
- Defined in src/3d/particlesystem/modules/ParticleModule.ts:72

updateParticleState

updateParticleState(particle: Particle): void
更新粒子状态
Parameters
- particle: Particle
  
  粒子
Returns void
Overrides ParticleModule.updateParticleState
- Defined in src/3d/particlesystem/modules/ParticleColorBySpeedModule.ts:50

`Static` getEventEmitter

getEventEmitter(target: any): EventEmitter<any>
获取事件发射器
Parameters
- target: any
Returns EventEmitter<any>
Inherited from ParticleModule.getEventEmitter
- Defined in src/event/EventEmitter.ts:29

`Static` getOrCreateEventEmitter

getOrCreateEventEmitter(target: any): EventEmitter<any>
获取事件发射器，当没有找到对应发射器时，返回新建的事件发射器。
Parameters
- target: any
Returns EventEmitter<any>
Inherited from ParticleModule.getOrCreateEventEmitter
- Defined in src/event/EventEmitter.ts:44

Class ParticleColorBySpeedModule

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional target: any

Returns ParticleColorBySpeedModule

Properties

color

enabled

particleSystem

range

Methods

broadcast

Returns

Type Parameters

K extends string

Parameters

type: K

Optional data: any

Returns IEvent<any>

bubbles

Returns

Type Parameters

K extends string

Parameters

type: K

Optional data: any

Returns IEvent<any>

dispose

Returns void

emit

Returns

Type Parameters

K extends string

Parameters

type: K

Optional data: any

bubbles: boolean = false

broadcast: boolean = false

share: boolean = true

Returns IEvent<any>

emitEvent

Returns

Type Parameters

K extends string

Parameters

event: IEvent<any>

Returns IEvent<any>

eventNames

Type Parameters

K extends string

Returns K[]

Protected handelEventBroadcast

Type Parameters

K extends string

Parameters

event: IEvent<any>

Returns void

Protected handelEventBubbles

Type Parameters

K extends string

Parameters

event: IEvent<any>

Returns void

Protected handelEventShare

Type Parameters

K extends string

Parameters

event: IEvent<any>

Returns void

Protected handleEvent

Type Parameters

K extends string

Parameters

e: IEvent<any>

`Optional` target: any

`Optional` data: any

`Optional` data: any

`Optional` data: any

`Protected` handelEventBroadcast

`Protected` handelEventBubbles

`Protected` handelEventShare

`Protected` handleEvent

`Optional` type: K

`Optional` listener: ((event: IEvent<any>) => void)

`Optional` thisObject: any

`Optional` type: K

`Optional` listener: ((event: IEvent<any>) => void)

`Optional` thisObject: any

`Optional` thisObject: any

`Optional` thisObject: any