1. Epic GamesDeveloper
  3. UWaterSplineMetadata

UWaterSplineMetadata

Unreal Engine C++ API Reference > Plugins > Water

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;&41;  
class UWaterSplineMetadata : public USplineMetadata

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere FInterpCurveFloat 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 FInterpCurveFloat Depth  
Public variable FOnWaterSplineMetadataChanged OnChangeMetadata  
Public variable UProperty Category, EditAnywhere FInterpCurveFloat RiverWidth Rivers Only: The width of the river (from center) in each direction
Public variable UProperty Category, EditAnywhere FInterpCurveFloat WaterVelocityScalar The Current of the water at this vertex. Magnitude and direction

Constructors

  Type Name Description
Public function  

UWaterSplineMetadata ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function bool

PropagateDefaultValue ( int32 PointIndex,
const FWaterSplineCurveDefaults& CurrentDefaults,
const FWaterSplineCurveDefaults& NewDefaults
)

  

Overridden from USplineMetadata

  Type Name Description
Public function Virtual void

AddPoint ( float InputKey
)

  
Public function Virtual void

CopyPoint ( const USplineMetadata* FromSplineMetadata,
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

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Typedefs

Name Description
FOnChangeData  
FOnWaterSplineMetadataChanged Delegate called whenever the metadata is updated.

Deprecated Variables

  Type Name Description
Public variable FOnChangeData OnChangeData Use OnChangeMetadata

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page