Navigation
API > API/Plugins > API/Plugins/Water
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UWaterWavesBase
- UWaterWavesAssetReference
References
| Module | Water |
| Header | /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterWaves.h |
| Include | #include "WaterWaves.h" |
Syntax
UCLASS&40;BlueprintType, NotBlueprintable, AutoExpandCategories&61;"Water Waves Asset"&41;
class UWaterWavesAssetReference : public UWaterWavesBase
Functions
| Type | Name | Description | |
|---|---|---|---|
| const UWaterWavesAsset * | GetWaterWavesAsset
(
UWaterWaves* InWaterWavesAsset |
||
| void | SetWaterWavesAsset
(
UWaterWavesAsset* InWaterWavesAsset |
Overridden from UWaterWavesBase
| Type | Name | Description | |
|---|---|---|---|
| float | Returns the maximum wave height that can be reached by those waves | ||
| float | GetSimpleWaveHeightAtPosition
(
const FVector& InPosition, |
Computes the raw wave perturbation of the water height only (simple version : faster computation) | |
| const UWaterWaves * | Return the underlying Water class type. | ||
| UWaterWaves * | |||
| float | GetWaveAttenuationFactor
(
const FVector& InPosition, |
Computes the attenuation factor to apply to the raw wave perturbation. | |
| float | GetWaveHeightAtPosition
(
const FVector& InPosition, |
Computes the raw wave perturbation of the water height/normal |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | BeginDestroy () |
Called before destroying the object. | |
| void | PostDuplicate
(
EDuplicateMode::Type DuplicateMode |
||
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally | |
| void | PostEditUndo () |
Called after applying a transaction to the object. | |
| void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. | |
| void | PreEditChange
(
FProperty* PropertyAboutToChange |
This is called when a property is about to be modified externally | |
| void | PreEditUndo () |
Called before applying a transaction to the object. |