Navigation
API > API/Plugins > API/Plugins/Water
| Name | UWaterWavesBase |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterWaves.h |
| Include Path | #include "WaterWaves.h" |
Syntax
UCLASS (MinimalAPI, EditInlineNew, BlueprintType, NotBlueprintable, Abstract)
class UWaterWavesBase : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UWaterWavesBase
Derived Classes
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnUpdateWavesData | TMulticastDelegate_TwoParams< void, UWaterWavesBase *, EPropertyChangeType::Type > | Delegate called whenever the waves data is updated. | WaterWaves.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnUpdateWavesData | FOnUpdateWavesData | WaterWaves.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual float GetMaxWaveHeight() |
Returns the maximum wave height that can be reached by those waves | WaterWaves.h | |
virtual float GetSimpleWaveHeightAtPosition
(
const FVector& InPosition, |
Computes the raw wave perturbation of the water height only (simple version : faster computation) | WaterWaves.h | |
virtual const UWaterWaves * GetWaterWaves () |
Return the underlying Water class type. | WaterWaves.h | |
virtual UWaterWaves * GetWaterWaves () |
WaterWaves.h | ||
virtual float GetWaveAttenuationFactor
(
const FVector& InPosition, |
Computes the attenuation factor to apply to the raw wave perturbation. | WaterWaves.h | |
virtual float GetWaveHeightAtPosition
(
const FVector& InPosition, |
Computes the raw wave perturbation of the water height/normal | WaterWaves.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
WaterWaves.h |