UWaterWavesBase

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Water

Header

/Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterWaves.h

Include

#include "WaterWaves.h"

Syntax

UCLASS(EditInlineNew, BlueprintType, NotBlueprintable, Abstract)
class UWaterWavesBase : public UObject

Variables

Name Description

Public variable

FOnUpdateWavesD...

 

OnUpdateWavesData

Functions

Name Description

Public function Virtual Const

float

 

GetMaxWaveHeight()

Returns the maximum wave height that can be reached by those waves

Public function Virtual Const

float

 

GetSimpleWaveHeightAtPosition

(
    const FVector& InPosition,
    float InWaterDepth,
    float InTime
)

Computes the raw wave perturbation of the water height only (simple version : faster computation)

Public function Virtual Const

const UWater...

 

GetWaterWaves()

Return the underlying Water class type.

Public function Virtual

UWaterWaves ...

 

GetWaterWaves()

Public function Virtual Const

float

 

GetWaveAttenuationFactor

(
    const FVector& InPosition,
    float InWaterDepth,
    float InTargetWaveMaskDepth
)

Computes the attenuation factor to apply to the raw wave perturbation.

Public function Virtual Const

float

 

GetWaveHeightAtPosition

(
    const FVector& InPosition,
    float InWaterDepth,
    float InTime,
    FVector& OutNormal
)

Computes the raw wave perturbation of the water height/normal

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Typedefs

Name

Description

FOnUpdateWavesData

Delegate called whenever the waves data is updated.