UGerstnerWaterWaves

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Water

Header

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

Include

#include "GerstnerWaterWaves.h"

Syntax

UCLASS(EditInlineNew, BlueprintType, MinimalAPI)
class UGerstnerWaterWaves : public UWaterWaves

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadOnly instanced

UGerstnerWaterW...

 

GerstnerWaveGenerator

Protected variable UProperty Category BlueprintReadOnly

TArray< FGerstn...

 

GerstnerWaves

Protected variable UProperty Category BlueprintReadOnly

float

 

MaxWaveHeight

Constructors

Name Description

Public function

UGerstnerWaterWaves()

Functions

Name Description

Public function Const

const TArray...

 

GetGerstnerWaves()

Public function

void

 

RecomputeWaves

(
    bool bAllowBPScript
)

Call RecomputeWaves whenever wave data changes, so that all cached data can be recomputed (do not call OnPostLoad... can call BP script internally)

Overridden from UWaterWavesBase

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

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

 

PostDuplicate

(
    EDuplicateMode::Type DuplicateMode
)

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostEditUndo()

Called after applying a transaction to the object.