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

Constructors

Properties

_getDrawImageStrength: any
_getNoiseValue: any

获取噪音值

Param

Param

_getNoiseValueBase: any

获取单层噪音值

Param

Param

_scrollValue: any
damping: boolean

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

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

enabled: boolean

是否开启

frequency: number

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

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

octaveCount: number

Layers of noise that combine to produce final noise.

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

octaveMultiplier: number

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

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

octaveScale: number

When combining each octave, zoom in by this amount.

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

particleSystem: ParticleSystem3D

粒子系统

Generate 1D, 2D or 3D noise.

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

Define how the noise values are remapped.

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

remapEnabled: boolean

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

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

scrollSpeed: MinMaxCurve

Scroll the noise map over the particle system.

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

separateAxes: boolean

Control the noise separately for each axis.

分别控制每个轴的噪声。

strength3D: MinMaxCurveVector3

How strong the overall noise effect is.

整体噪音效应有多强。

_frequencyScale: number
_strengthScale: number
_timeScale: number

Accessors

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

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

    Returns MinMaxCurve

  • set remap(v): void
  • Parameters

    Returns void

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

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

    Returns MinMaxCurve

  • set remapX(v): void
  • Parameters

    Returns void

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

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

    Returns MinMaxCurve

  • set remapY(v): void
  • Parameters

    Returns void

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

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

    Returns MinMaxCurve

  • set remapZ(v): void
  • Parameters

    Returns void

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

    整体噪音效应有多强。

    Returns MinMaxCurve

  • set strength(v): void
  • Parameters

    Returns void

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

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

    Returns MinMaxCurve

  • set strengthX(v): void
  • Parameters

    Returns void

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

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

    Returns MinMaxCurve

  • set strengthY(v): void
  • Parameters

    Returns void

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

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

    Returns MinMaxCurve

  • set strengthZ(v): void
  • Parameters

    Returns void

Methods

  • 将事件广播到下级对象中。

    Type Parameters

    • K extends string

    Parameters

    • type: K

      事件的类型。类型区分大小写。

    • Optional data: any

      事件携带的自定义数据。

    Returns IEvent<any>

    返回广播后的事件。

  • 将事件冒泡到上级对象中。

    Type Parameters

    • K extends string

    Parameters

    • type: K

      事件的类型。类型区分大小写。

    • Optional data: any

      事件携带的自定义数据。

    Returns IEvent<any>

    返回冒泡后的事件。

  • 销毁

    Returns void

  • 绘制噪音到图片

    Parameters

    • image: ImageData

      图片数据

    Returns void

  • 发射事件。

    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>

    返回发射后的事件。

  • 发射事件。

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

    Type Parameters

    • K extends string

    Parameters

    • event: IEvent<any>

      事件对象

    Returns IEvent<any>

    返回事件是否被处理

  • 返回监听的事件类型列表。

    Type Parameters

    • K extends string

    Returns K[]

  • 向下级广播事件

    Type Parameters

    • K extends string

    Parameters

    Returns void

  • 向上级报告事件

    Type Parameters

    • K extends string

    Parameters

    Returns void

  • 向平级分享事件

    Type Parameters

    • K extends string

    Parameters

    Returns void

  • 处理事件

    Type Parameters

    • K extends string

    Parameters

    Returns void

  • 检查 Event 对象是否为特定事件类型注册了任何侦听器.

    Type Parameters

    • K extends string

    Parameters

    • type: K

      事件的类型。

    Returns boolean

    如果指定类型的侦听器已注册,则值为 true;否则,值为 false。

  • 初始化粒子状态

    Parameters

    Returns void

  • 返回指定事件类型的监听数量。

    Type Parameters

    • K extends string

    Parameters

    • type: K

      事件的类型。

    Returns number

  • 移除监听

    Type Parameters

    • K extends string

    Parameters

    • Optional type: K

      事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。

    • Optional listener: ((event) => void)

      要删除的监听器对象。可选。该值为空时所有指定类型的监听均将被移除。

        • (event): void
        • Parameters

          Returns void

    • Optional thisObject: any

      监听器的上下文。可选。

    Returns ParticleNoiseModule

  • 移除所有监听

    Type Parameters

    • K extends string

    Parameters

    • Optional type: K

      事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。

    Returns ParticleNoiseModule

  • 移除监听对象的任意事件。

    Type Parameters

    • K extends string

    Parameters

    • Optional listener: ((event) => void)

      处理事件的监听器函数。

        • (event): void
        • Parameters

          Returns void

    • Optional thisObject: any

      监听器的上下文。可选。

    Returns ParticleNoiseModule

  • 为监听对象新增指定类型的事件监听。

    Type Parameters

    • K extends string

    Parameters

    • type: K

      事件的类型。

    • listener: ((event) => void)

      处理事件的监听器函数。

        • (event): void
        • Parameters

          Returns void

    • Optional thisObject: any

      监听器的上下文。可选。

    • priority: number = 0

      事件监听器的优先级。数字越大,优先级越高。默认为0。

    • once: boolean = false

      值为true时在监听一次事件后该监听器将被移除。默认为false。

    Returns ParticleNoiseModule

  • 监听对象的任意事件,该对象的任意事件都将触发该监听器的调用。

    Type Parameters

    • K extends string

    Parameters

    • listener: ((event) => void)

      处理事件的监听器函数。

        • (event): void
        • Parameters

          Returns void

    • Optional thisObject: any

      监听器的上下文。可选。

    • priority: number = 0

      事件监听器的优先级。数字越大,优先级越高。默认为0。

    • once: boolean = false

      值为true时在监听一次事件后该监听器将被移除。默认为false。

    Returns ParticleNoiseModule

  • 监听一次事件后将会被移除

    Type Parameters

    • K extends string

    Parameters

    • type: K

      事件的类型。

    • listener: ((event) => void)

      处理事件的侦听器函数。

        • (event): void
        • Parameters

          Returns void

    • Optional thisObject: any

      listener函数作用域

    • priority: number = 0

      事件侦听器的优先级。数字越大,优先级越高。默认优先级为 0。

    Returns ParticleNoiseModule

  • 更新

    Parameters

    • interval: number

    Returns void

  • 更新粒子状态

    Parameters

    Returns void

Generated using TypeDoc