1. Epic GamesDeveloper
  3. UWaterWavesBase

UWaterWavesBase

Unreal Engine C++ API Reference > Plugins > Water

Inheritance Hierarchy

References

   
Module Water
Header /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterWaves.h
Include #include "WaterWaves.h"

Syntax

UCLASS&40;EditInlineNew, BlueprintType, NotBlueprintable, Abstract&41;  
class UWaterWavesBase : public UObject

Variables

  Type Name Description
Public variable FOnUpdateWavesData OnUpdateWavesData  

Functions

  Type Name Description
Public function Virtual Const float 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 UWaterWaves * Return the underlying Water class type.
Public function Virtual UWaterWaves *  
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

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Typedefs

Name Description
FOnUpdateWavesData Delegate called whenever the waves data is updated.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page