The Water system uses GPU-driven wave data to simulate the surface of waves on Water Body Actors. The Water Waves Asset provides the individual wave parameters that are governed by its simulation model.
Creating a Water Waves Asset
Water Bodies are supplied with a wave simulation model to use with a Water Waves Asset assignment slot. By default, one is already supplied that uses the TODOLINK Gerstner wave simulation model.
While you do not need to create a new Water Wave Asset every time you use a Water Body, there are times when you want different types of wave input from the simulation model to behave differently, or when you want to use a completely different wave simulation model.
You can create your own Water Waves Asset using the Content Browser to click Add/Import or use the Right-Click Context Menu. From the menu, select Water > Water Waves.
On a selected Water Body, use the Water Waves Asset assignment slot to apply this asset.
Editing the Water Waves Asset
When creating, or opening an existing, Water Wave Asset, you select the type of wave simulation to be used, when multiple simulation models are available to choose from. Any editable properties will populate the panel to configure the simulation.
Water Waves Asset Editor using Gerstner Water Waves simulation model.
The Waves Source specifies the wave simulation model that is to be used for generating waves on Water Bodies. When one is selected, it provides parameters that are exposed through the selected Waves Source file to control the wave simulation. For example, the Gerstner Water Waves source provides parameters under the Gerstner Wave Generator.
You can configure these parameters to define the look of the wave simulation on any Water Bodies placed in the Level that have this Water Wave Asset assigned to them.
Unreal Engine only provides the Gerstner wave simulation model. However, you can implement other models or your own by using Blueprint or C++ code as a function that outputs waves based on some specified input. See the TODOLINK Adding Your Own Wave Simulation Model and Wave Generator section of this page for more details.
Gerstner Water Waves Properties
The Gerstner Water Waves simulation model provides the following parameters for wave simulation.
| Property | Description |
|---|---|
| Default | |
| Num Waves | The number of waves to be summed up. |
| Seed | A deterministic starting point for generating a random value to feed the wave model. |
| Randomness | Adds some amount of randomness to the interpolation between the minimum and maximum wavelength and amplitude values used by the Gerstner Water Waves model.. |
| Wavelengths | |
| Min Wavelength | Specifies the low-end of the wavelength range between waves that have a specified falloff. |
| Max Wavelength | Specifies the high-end of the wavelength range between waves that have a specified falloff. |
| Wavelength Falloff | Uses the minimum and maximum wavelengths to determine the distance between wave crests on a continuous wave. |
| Amplitude | |
| Min Amplitude | Specifies the low-end of all generated waves’ amplitude with a specified falloff. |
| Max Amplitude | Specifies the high-end of all generated waves’ amplitude with a specified falloff. |
| Amplitude Falloff | Uses the minimum and maximum amplitudes to determine the height of generated waves. |
| Directions | |
| Dominant Wind Angle | Set the primary direction from which the wind is blowing. |
| Dominant Angular Spread | Sets a random wind direction within the specified angle that the window should blow. Waves will appear to travel in this direction. |
| Steepness | |
| Small Wave Steepness | Specifies the steepness of smaller waves with a specified falloff. The steepness determines how sharp the point of the wave crest becomes. This is achieved through lateral motion and controls how much the waves move side-to-side. |
| Large Wave Steepness | Specifies the steepness of larger waves with a specified falloff. The steepness determines how sharp the point of the wave crest becomes. This is achieved through lateral motion and controls how much the waves move side-to-side. |
| Steepness Falloff | Uses the small and large wave steepness values to determine the height range of wave crests that occur. |
The Water system’s mesh rendering system for surface detail is ideal for defining the macro movement patterns and look of waves. The micro details are best handled using the water material with normal maps where the tessellation of the mesh is limited by the balance of quality and performance.
Material-driven details have been disabled in the demonstrations that follow to demonstrate the macro-level detail that is achievable using the Water Wave Asset alone.
Setting the Number of Waves and Randomness
The Default category of parameters define the overall look of the Lake and Ocean Water Bodies.
The Num Waves parameter specifies the number of waves. This creates the overall look of the waves that are formed. By default 16 waves are used. Using fewer waves is more performant, but offers less variation in the randomness of waves colliding.
The Seed parameter creates a deterministic starting point for a random value, which is passed to the wave simulation algorithm to create variations with the waves. The Randomness parameter feeds random values to the minimum and maximum wavelength and amplitude values, to reduce repeating patterns in the wave simulation.
Wavelength of the Waves Simulation
The Wavelengths parameters specify a minimum and maximum value range for the distance between waves when a falloff value is used. The Seed and Randomness values work together with the Wavelength minimum and maximum value ranges to further define the look of the water surface.
Amplitude of the Waves Simulation
The Amplitude parameters specify a minimum and maximum value range for height displacement between waves. This controls the peaks and valleys of the wave crests. The Seed and Randomness values work together with the Amplitude minimum and maximum value ranges to further define the look of the water surface.
Direction and Angular Spread of Wind
The Directions parameters specify the direction wind is traveling. With the Dominant Wind Angle, the wind will push the waves in the wind’s general direction.The Dominant Angular Spread specifies a secondary angle that waves move along while traveling in the direction set by the Dominant Wind Angle.
Steepness of the Waves Simulation
The Steepness parameters define how pointed or rounded the cresting waves become. The steepness of the wave crests is achieved through lateral motion, and controls how much the waves move side-to-side.
Small steepness values have softer, rounded wave crests. Large steepness values have sharper wave crests. These values provide random wave interactions that produce both softer and sharper wave crests without all wave crests being completely soft or sharp.
Adding Your Own Wave Simulation Model and Wave Generator
Unreal Engine provides the Gerstner wave simulation model for the Water System. The Water system is capable of supporting additional wave simulation models through the Water Wave Asset with configurable parameters, which can be done either through C++ code or Blueprint.
The information in this section uses the Gerstner wave implementation as a working example for creating your own wave generator backend for evaluating surface waves.
In C++, you would start by creating a new type that derives from UGerstnerWaterWaveGeneratorBaseand uses GenerateGerstnerWaves_Implementation(TArray<FGerstnerWave>&OutWaves) const.
In Blueprint, the Parent Class inherits from the GerstnerWaterWaveGeneratorBase class.
In the Blueprint, you override and add your own Generate Gerstner Waves function that uses the Make GerstnerWave and Make GerstnerWaveOctave nodes to output to an array that stores information.
In the Water Waves Asset, the Gerstner Wave Generator selection dropdown lists any classes that inherit from the Gerstner Wave Source.
