|
| 1 | +import { Vector3 } from "@galacean/engine-math"; |
| 2 | +import { ignoreClone } from "../../clone/CloneManager"; |
| 3 | +import { ShaderData, ShaderMacro, ShaderProperty } from "../../shader"; |
| 4 | +import { ParticleGenerator } from "../ParticleGenerator"; |
| 5 | +import { ParticleGeneratorModule } from "./ParticleGeneratorModule"; |
| 6 | + |
| 7 | +/** |
| 8 | + * Noise module for particle system. |
| 9 | + * Adds simplex noise-based turbulence displacement to particles. |
| 10 | + */ |
| 11 | +export class NoiseModule extends ParticleGeneratorModule { |
| 12 | + static readonly _enabledMacro = ShaderMacro.getByName("RENDERER_NOISE_MODULE_ENABLED"); |
| 13 | + static readonly _dampingMacro = ShaderMacro.getByName("RENDERER_NOISE_DAMPING"); |
| 14 | + |
| 15 | + static readonly _strengthProperty = ShaderProperty.getByName("renderer_NoiseStrength"); |
| 16 | + static readonly _frequencyProperty = ShaderProperty.getByName("renderer_NoiseFrequency"); |
| 17 | + static readonly _scrollSpeedProperty = ShaderProperty.getByName("renderer_NoiseScrollSpeed"); |
| 18 | + static readonly _octaveInfoProperty = ShaderProperty.getByName("renderer_NoiseOctaveInfo"); |
| 19 | + |
| 20 | + @ignoreClone |
| 21 | + private _enabledModuleMacro: ShaderMacro; |
| 22 | + @ignoreClone |
| 23 | + private _dampingModuleMacro: ShaderMacro; |
| 24 | + |
| 25 | + @ignoreClone |
| 26 | + private _strengthVec = new Vector3(); |
| 27 | + @ignoreClone |
| 28 | + private _octaveInfoVec = new Vector3(); |
| 29 | + |
| 30 | + private _strengthX: number = 1.0; |
| 31 | + private _strengthY: number = 1.0; |
| 32 | + private _strengthZ: number = 1.0; |
| 33 | + private _frequency: number = 0.5; |
| 34 | + private _scrollSpeed: number = 0.0; |
| 35 | + private _damping: boolean = true; |
| 36 | + private _octaves: number = 1; |
| 37 | + private _octaveMultiplier: number = 0.5; |
| 38 | + private _octaveScale: number = 2.0; |
| 39 | + |
| 40 | + /** |
| 41 | + * Noise strength for x axis. |
| 42 | + */ |
| 43 | + get strengthX(): number { |
| 44 | + return this._strengthX; |
| 45 | + } |
| 46 | + |
| 47 | + set strengthX(value: number) { |
| 48 | + if (value !== this._strengthX) { |
| 49 | + this._strengthX = value; |
| 50 | + this._generator._renderer._onGeneratorParamsChanged(); |
| 51 | + } |
| 52 | + } |
| 53 | + |
| 54 | + /** |
| 55 | + * Noise strength for y axis. |
| 56 | + */ |
| 57 | + get strengthY(): number { |
| 58 | + return this._strengthY; |
| 59 | + } |
| 60 | + |
| 61 | + set strengthY(value: number) { |
| 62 | + if (value !== this._strengthY) { |
| 63 | + this._strengthY = value; |
| 64 | + this._generator._renderer._onGeneratorParamsChanged(); |
| 65 | + } |
| 66 | + } |
| 67 | + |
| 68 | + /** |
| 69 | + * Noise strength for z axis. |
| 70 | + */ |
| 71 | + get strengthZ(): number { |
| 72 | + return this._strengthZ; |
| 73 | + } |
| 74 | + |
| 75 | + set strengthZ(value: number) { |
| 76 | + if (value !== this._strengthZ) { |
| 77 | + this._strengthZ = value; |
| 78 | + this._generator._renderer._onGeneratorParamsChanged(); |
| 79 | + } |
| 80 | + } |
| 81 | + |
| 82 | + /** |
| 83 | + * Noise spatial frequency. |
| 84 | + */ |
| 85 | + get frequency(): number { |
| 86 | + return this._frequency; |
| 87 | + } |
| 88 | + |
| 89 | + set frequency(value: number) { |
| 90 | + if (value !== this._frequency) { |
| 91 | + this._frequency = value; |
| 92 | + this._generator._renderer._onGeneratorParamsChanged(); |
| 93 | + } |
| 94 | + } |
| 95 | + |
| 96 | + /** |
| 97 | + * Noise field scroll speed over time. |
| 98 | + */ |
| 99 | + get scrollSpeed(): number { |
| 100 | + return this._scrollSpeed; |
| 101 | + } |
| 102 | + |
| 103 | + set scrollSpeed(value: number) { |
| 104 | + if (value !== this._scrollSpeed) { |
| 105 | + this._scrollSpeed = value; |
| 106 | + this._generator._renderer._onGeneratorParamsChanged(); |
| 107 | + } |
| 108 | + } |
| 109 | + |
| 110 | + /** |
| 111 | + * Whether noise strength diminishes with particle age. |
| 112 | + */ |
| 113 | + get damping(): boolean { |
| 114 | + return this._damping; |
| 115 | + } |
| 116 | + |
| 117 | + set damping(value: boolean) { |
| 118 | + if (value !== this._damping) { |
| 119 | + this._damping = value; |
| 120 | + this._generator._renderer._onGeneratorParamsChanged(); |
| 121 | + } |
| 122 | + } |
| 123 | + |
| 124 | + /** |
| 125 | + * Number of noise octaves (1-3). |
| 126 | + */ |
| 127 | + get octaves(): number { |
| 128 | + return this._octaves; |
| 129 | + } |
| 130 | + |
| 131 | + set octaves(value: number) { |
| 132 | + value = Math.max(1, Math.min(3, Math.floor(value))); |
| 133 | + if (value !== this._octaves) { |
| 134 | + this._octaves = value; |
| 135 | + this._generator._renderer._onGeneratorParamsChanged(); |
| 136 | + } |
| 137 | + } |
| 138 | + |
| 139 | + /** |
| 140 | + * Amplitude decay factor per octave. |
| 141 | + */ |
| 142 | + get octaveMultiplier(): number { |
| 143 | + return this._octaveMultiplier; |
| 144 | + } |
| 145 | + |
| 146 | + set octaveMultiplier(value: number) { |
| 147 | + if (value !== this._octaveMultiplier) { |
| 148 | + this._octaveMultiplier = value; |
| 149 | + this._generator._renderer._onGeneratorParamsChanged(); |
| 150 | + } |
| 151 | + } |
| 152 | + |
| 153 | + /** |
| 154 | + * Frequency increase factor per octave. |
| 155 | + */ |
| 156 | + get octaveScale(): number { |
| 157 | + return this._octaveScale; |
| 158 | + } |
| 159 | + |
| 160 | + set octaveScale(value: number) { |
| 161 | + if (value !== this._octaveScale) { |
| 162 | + this._octaveScale = value; |
| 163 | + this._generator._renderer._onGeneratorParamsChanged(); |
| 164 | + } |
| 165 | + } |
| 166 | + |
| 167 | + override get enabled(): boolean { |
| 168 | + return this._enabled; |
| 169 | + } |
| 170 | + |
| 171 | + override set enabled(value: boolean) { |
| 172 | + if (value !== this._enabled) { |
| 173 | + this._enabled = value; |
| 174 | + this._generator._renderer._onGeneratorParamsChanged(); |
| 175 | + } |
| 176 | + } |
| 177 | + |
| 178 | + constructor(generator: ParticleGenerator) { |
| 179 | + super(generator); |
| 180 | + } |
| 181 | + |
| 182 | + /** |
| 183 | + * @internal |
| 184 | + */ |
| 185 | + _updateShaderData(shaderData: ShaderData): void { |
| 186 | + let enabledMacro = <ShaderMacro>null; |
| 187 | + let dampingMacro = <ShaderMacro>null; |
| 188 | + |
| 189 | + if (this.enabled) { |
| 190 | + enabledMacro = NoiseModule._enabledMacro; |
| 191 | + |
| 192 | + const strength = this._strengthVec; |
| 193 | + strength.set(this._strengthX, this._strengthY, this._strengthZ); |
| 194 | + shaderData.setVector3(NoiseModule._strengthProperty, strength); |
| 195 | + |
| 196 | + shaderData.setFloat(NoiseModule._frequencyProperty, this._frequency); |
| 197 | + shaderData.setFloat(NoiseModule._scrollSpeedProperty, this._scrollSpeed); |
| 198 | + |
| 199 | + const octaveInfo = this._octaveInfoVec; |
| 200 | + octaveInfo.set(this._octaves, this._octaveMultiplier, this._octaveScale); |
| 201 | + shaderData.setVector3(NoiseModule._octaveInfoProperty, octaveInfo); |
| 202 | + |
| 203 | + if (this._damping) { |
| 204 | + dampingMacro = NoiseModule._dampingMacro; |
| 205 | + } |
| 206 | + } |
| 207 | + |
| 208 | + this._enabledModuleMacro = this._enableMacro(shaderData, this._enabledModuleMacro, enabledMacro); |
| 209 | + this._dampingModuleMacro = this._enableMacro(shaderData, this._dampingModuleMacro, dampingMacro); |
| 210 | + } |
| 211 | +} |
0 commit comments