UWaterSplineMetadata

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Water

Header

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

Include

#include "WaterSplineMetadata.h"

Syntax

UCLASS()
class UWaterSplineMetadata : public USplineMetadata

Variables

Name Description

Public variable UProperty Category, EditAnywhere

FInterpCurveFlo...

 

AudioIntensity

A scalar used to define intensity of the water audio along the spline

Public variable UProperty Category, EditAnywhere, Meta

bool

 

bShouldVisualizeDepth

Whether depth visualization should be displayed

Public variable UProperty Category, EditAnywhere, Meta

bool

 

bShouldVisualizeRiverWidth

Whether river width visualization should be displayed

Public variable UProperty Category, EditAnywhere, Meta

bool

 

bShouldVisualizeWaterVelocity

Whether water velocity visualization should be displayed

Public variable UProperty Category, EditAnywhere

FInterpCurveFlo...

 

Depth

Public variable

FOnChangeData

 

OnChangeData

Public variable UProperty Category, EditAnywhere

FInterpCurveFlo...

 

RiverWidth

Rivers Only: The width of the river (from center) in each direction

Public variable UProperty Category, EditAnywhere

FInterpCurveFlo...

 

WaterVelocityScalar

The Current of the water at this vertex. Magnitude and direction

Constructors

Name Description

Public function

UWaterSplineMetadata

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

bool

 

CanEditDepth()

Public function Const

bool

 

CanEditRiverWidth()

Public function Const

bool

 

CanEditVelocity()

Public function

bool

 

PropagateDefaultValue

(
    int32 PointIndex,
    const FWaterSplineCurveDefaults& C...,
    const FWaterSplineCurveDefaults& N...
)

Overridden from USplineMetadata

Name Description

Public function Virtual

void

 

AddPoint

(
    float InputKey
)

Public function Virtual

void

 

CopyPoint

(
    const USplineMetadata* FromSpl...,
    int32 FromIndex,
    int32 ToIndex
)

Public function Virtual

void

 

DuplicatePoint

(
    int32 Index
)

Public function Virtual

void

 

Fixup

(
    int32 NumPoints,
    USplineComponent* SplineComp
)

Public function Virtual

void

 

InsertPoint

(
    int32 Index,
    float t,
    bool bClosedLoop
)

Insert point before index, lerping metadata between previous and next key values

Public function Virtual

void

 

RemovePoint

(
    int32 Index
)

Public function Virtual

void

 

Reset

(
    int32 NumPoints
)

Public function Virtual

void

 

UpdatePoint

(
    int32 Index,
    float t,
    bool bClosedLoop
)

Update point at index by lerping metadata between previous and next key values

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

FOnChangeData

Delegate called whenever the metadata is updated.