Class ParticleNoiseModule

Script interface for the Noise Module.

The Noise Module allows you to apply turbulence to the movement of your particles. Use the low quality settings to create computationally efficient Noise, or simulate smoother, richer Noise with the higher quality settings. You can also choose to define the behavior of the Noise individually for each axis.

噪声模块

噪声模块允许你将湍流应用到粒子的运动中。使用低质量设置来创建计算效率高的噪声，或者使用高质量设置来模拟更平滑、更丰富的噪声。您还可以选择为每个轴分别定义噪声的行为。

Hierarchy

ParticleModule
- ParticleNoiseModule

Constructors

constructor

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

Properties

`Private` _scrollValue

_scrollValue: number = 0

damping

damping: boolean = true

Higher frequency noise will reduce the strength by a proportional amount, if enabled.

如果启用高频率噪音，将按比例减少强度。

enabled

enabled: boolean = false

是否开启

frequency

frequency: number = 0.5

Low values create soft, smooth noise, and high values create rapidly changing noise.

低值产生柔和、平滑的噪声，高值产生快速变化的噪声。

octaveCount

octaveCount: number = 1

Layers of noise that combine to produce final noise.

一层一层的噪声组合在一起产生最终的噪声。

octaveMultiplier

octaveMultiplier: number = 0.5

When combining each octave, scale the intensity by this amount.

当组合每个八度时，按这个比例调整强度。

octaveScale

octaveScale: number = 2

When combining each octave, zoom in by this amount.

当组合每个八度时，放大这个数字。

particleSystem

particleSystem: ParticleSystem3D

粒子系统

quality

quality: ParticleSystemNoiseQuality = ParticleSystemNoiseQuality.High

Generate 1D, 2D or 3D noise.

生成一维、二维或三维噪声。

remap3D

remap3D: MinMaxCurveVector3 = ...

Define how the noise values are remapped.

定义如何重新映射噪声值。

remapEnabled

remapEnabled: boolean = false

Enable remapping of the final noise values, allowing for noise values to be translated into different values.

允许重新映射最终的噪声值，允许将噪声值转换为不同的值。

scrollSpeed

scrollSpeed: MinMaxCurve = ...

Scroll the noise map over the particle system.

在粒子系统上滚动噪声图。

separateAxes

separateAxes: boolean = false

Control the noise separately for each axis.

分别控制每个轴的噪声。

strength3D

strength3D: MinMaxCurveVector3 = ...

How strong the overall noise effect is.

整体噪音效应有多强。

`Static` _frequencyScale

_frequencyScale: number = 5

`Static` _strengthScale

_strengthScale: number = 0.3

`Static` _timeScale

_timeScale: number = 5

Accessors

remap

get remap(): MinMaxCurve
Define how the noise values are remapped.

定义如何重新映射噪声值。

Returns MinMaxCurve
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:182
set remap(v: MinMaxCurve): void
Parameters
- v: MinMaxCurve
Returns void
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:188

remapX

get remapX(): MinMaxCurve
Define how the noise values are remapped on the X axis, when using the ParticleSystem.NoiseModule.separateAxes option.

在使用分别控制每个轴时，如何在X轴上重新映射噪声值。

Returns MinMaxCurve
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:211
set remapX(v: MinMaxCurve): void
Parameters
- v: MinMaxCurve
Returns void
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:216

remapY

get remapY(): MinMaxCurve
Define how the noise values are remapped on the Y axis, when using the ParticleSystem.NoiseModule.separateAxes option.

在使用分别控制每个轴时，如何在Y轴上重新映射噪声值。

Returns MinMaxCurve
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:226
set remapY(v: MinMaxCurve): void
Parameters
- v: MinMaxCurve
Returns void
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:231

remapZ

get remapZ(): MinMaxCurve
Define how the noise values are remapped on the Z axis, when using the ParticleSystem.NoiseModule.separateAxes option.

在使用分别控制每个轴时，如何在Z轴上重新映射噪声值。

Returns MinMaxCurve
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:241
set remapZ(v: MinMaxCurve): void
Parameters
- v: MinMaxCurve
Returns void
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:246

strength

get strength(): MinMaxCurve
How strong the overall noise effect is.

整体噪音效应有多强。

Returns MinMaxCurve
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:40
set strength(v: MinMaxCurve): void
Parameters
- v: MinMaxCurve
Returns void
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:46

strengthX

get strengthX(): MinMaxCurve
Define the strength of the effect on the X axis, when using separateAxes option.

在使用分别控制每个轴时，在X轴上定义效果的强度。

Returns MinMaxCurve
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:65
set strengthX(v: MinMaxCurve): void
Parameters
- v: MinMaxCurve
Returns void
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:70

strengthY

get strengthY(): MinMaxCurve
Define the strength of the effect on the Y axis, when using separateAxes option.

在使用分别控制每个轴时，在Y轴上定义效果的强度。

Returns MinMaxCurve
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:80
set strengthY(v: MinMaxCurve): void
Parameters
- v: MinMaxCurve
Returns void
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:85

strengthZ

get strengthZ(): MinMaxCurve
Define the strength of the effect on the Z axis, when using separateAxes option.

在使用分别控制每个轴时，在Z轴上定义效果的强度。

Returns MinMaxCurve
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:95
set strengthZ(v: MinMaxCurve): void
Parameters
- v: MinMaxCurve
Returns void
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:100

Methods

`Private` _getDrawImageStrength

_getDrawImageStrength(): {
    x: number;
    y: number;
    z: number;
}
Returns {
    x: number;
    y: number;
    z: number;
}
- x: number
- y: number
- z: number
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:370

`Private` _getNoiseValue

_getNoiseValue(x: number, y: number): number
获取噪音值
Parameters
- x: number
- y: number
Returns number
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:442

`Private` _getNoiseValueBase

_getNoiseValueBase(x: number, y: number): number
获取单层噪音值
Parameters
- x: number
- y: number
Returns number
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:460

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

drawImage

drawImage(image: ImageData): void
绘制噪音到图片
Parameters
- image: ImageData
  
  图片数据
Returns void
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:314

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/ParticleNoiseModule.ts:255

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): ParticleNoiseModule
移除监听
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 ParticleNoiseModule
Inherited from ParticleModule.off
- Defined in src/event/EventEmitter.ts:253

offAll

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

offAny

offAny<K>(listener?: ((event: IEvent<any>) => void), thisObject?: any): ParticleNoiseModule
移除监听对象的任意事件。
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 ParticleNoiseModule
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): ParticleNoiseModule
为监听对象新增指定类型的事件监听。
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 ParticleNoiseModule
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): ParticleNoiseModule
监听对象的任意事件，该对象的任意事件都将触发该监听器的调用。
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 ParticleNoiseModule
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): ParticleNoiseModule
监听一次事件后将会被移除
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 ParticleNoiseModule
Inherited from ParticleModule.once
- Defined in src/event/EventEmitter.ts:95

update

update(interval: number): void
更新
Parameters
- interval: number
Returns void
Overrides ParticleModule.update
- Defined in src/3d/particlesystem/modules/ParticleNoiseModule.ts:481

updateParticleState

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

`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 ParticleNoiseModule

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional target: any

Returns ParticleNoiseModule

Properties

Private _scrollValue

damping

enabled

frequency

octaveCount

octaveMultiplier

octaveScale

particleSystem

quality

remap3D

remapEnabled

scrollSpeed

separateAxes

strength3D

Static _frequencyScale

Static _strengthScale

Static _timeScale

Accessors

remap

Returns MinMaxCurve

Parameters

v: MinMaxCurve

Returns void

remapX

Returns MinMaxCurve

Parameters

v: MinMaxCurve

Returns void

remapY

Returns MinMaxCurve

Parameters

v: MinMaxCurve

Returns void

remapZ

Returns MinMaxCurve

Parameters

v: MinMaxCurve

Returns void

strength

Returns MinMaxCurve

Parameters

v: MinMaxCurve

Returns void

strengthX

Returns MinMaxCurve

Parameters

v: MinMaxCurve

Returns void

strengthY

Returns MinMaxCurve

Parameters

v: MinMaxCurve

Returns void

strengthZ

Returns MinMaxCurve

Parameters

v: MinMaxCurve

Returns void

Methods

Private _getDrawImageStrength

Returns { x: number; y: number; z: number; }

x: number

y: number

z: number

Private _getNoiseValue

Parameters

x: number

`Optional` target: any

`Private` _scrollValue

`Static` _frequencyScale

`Static` _strengthScale

`Static` _timeScale

`Private` _getDrawImageStrength

Returns {
x: number;
y: number;
z: number;
}

`Private` _getNoiseValue

`Private` _getNoiseValueBase

`Optional` data: any

`Optional` data: any

`Optional` data: any

`Protected` handelEventBroadcast

`Protected` handelEventBubbles

`Protected` handelEventShare

`Protected` handleEvent