UWaterWavesAssetReference

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(BlueprintType, NotBlueprintable, AutoExpandCategories="Water Waves Asset")
class UWaterWavesAssetReference : public UWaterWavesBase

Functions

Name Description

Public function Const

const UWater...

 

GetWaterWavesAsset

(
    UWaterWaves* InWaterWavesAsset
)

Public function

void

 

SetWaterWavesAsset

(
    UWaterWavesAsset* InWaterWaves...
)

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

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

 

BeginDestroy()

Called before destroying the object.

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.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

PreEditChange

(
    FProperty* PropertyAboutToChan...
)

This is called when a property is about to be modified externally

Public function Virtual

void

 

PreEditUndo()

Called before applying a transaction to the object.