1. Epic GamesDeveloper
  3. UWaterSplineMetadata

UWaterSplineMetadata

API > API/Plugins > API/Plugins/Water

   
Name UWaterSplineMetadata
Type class
Header File /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterSplineMetadata.h
Include Path #include "WaterSplineMetadata.h"

Syntax

UCLASS (MinimalAPI)  
class UWaterSplineMetadata : public USplineMetadata

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UWaterSplineMetadata ( const FObjectInitializer& ObjectInitializer
)

   WaterSplineMetadata.h  

Typedefs

Name Type Remarks Include Path
FOnWaterSplineMetadataChanged TMulticastDelegate_OneParam< void, const FOnWaterSplineMetadataChangedParams & > Delegate called whenever the metadata is updated. WaterSplineMetadata.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AudioIntensity FInterpCurveFloat A scalar used to define intensity of the water audio along the spline WaterSplineMetadata.h
  • EditAnywhere
  • Category="Water|Audio"
bShouldVisualizeDepth bool Whether depth visualization should be displayed WaterSplineMetadata.h
  • EditAnywhere
  • Category="Water"
  • Meta=(InlineEditConditionToggle=true)
bShouldVisualizeRiverWidth bool Whether river width visualization should be displayed WaterSplineMetadata.h
  • EditAnywhere
  • Category="Water"
  • Meta=(InlineEditConditionToggle=true)
bShouldVisualizeWaterVelocity bool Whether water velocity visualization should be displayed WaterSplineMetadata.h
  • EditAnywhere
  • Category="Water"
  • Meta=(InlineEditConditionToggle=true)
Depth FInterpCurveFloat   WaterSplineMetadata.h
  • EditAnywhere
  • Category="Water"
OnChangeMetadata FOnWaterSplineMetadataChanged   WaterSplineMetadata.h  
RiverWidth FInterpCurveFloat Rivers Only: The width of the river (from center) in each direction WaterSplineMetadata.h
  • EditAnywhere
  • Category="Water"
WaterVelocityScalar FInterpCurveFloat The Current of the water at this vertex. Magnitude and direction WaterSplineMetadata.h
  • EditAnywhere
  • Category="Water"

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanEditDepth()

   WaterSplineMetadata.h  

bool CanEditRiverWidth()

   WaterSplineMetadata.h  

bool CanEditVelocity()

   WaterSplineMetadata.h  

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

   WaterSplineMetadata.h  

Overridden from USplineMetadata

Name Remarks Include Path Unreal Specifiers

virtual void AddPoint ( float InputKey
)

   WaterSplineMetadata.h  

virtual void CopyPoint ( const USplineMetadata* FromSplineMetadata,
int32 FromIndex,
int32 ToIndex
)

   WaterSplineMetadata.h  

virtual void DuplicatePoint ( int32 Index
)

   WaterSplineMetadata.h  

virtual void Fixup ( int32 NumPoints,
USplineComponent* SplineComp
)

   WaterSplineMetadata.h  

virtual void InsertPoint ( int32 Index,
float t,
bool bClosedLoop
)

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

virtual void RemovePoint ( int32 Index
)

   WaterSplineMetadata.h  

virtual void Reset ( int32 NumPoints
)

   WaterSplineMetadata.h  

virtual void UpdatePoint ( int32 Index,
float t,
bool bClosedLoop
)

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

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   WaterSplineMetadata.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page