Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UWaterSplineMetadata

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USplineMetadata

UWaterSplineMetadata

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UWaterSplineMetadata : public USplineMetadata

Variables

	Name	Description
FInterpCurveFlo...	AudioIntensity	A scalar used to define intensity of the water audio along the spline
bool	bShouldVisualizeDepth	Whether depth visualization should be displayed
bool	bShouldVisualizeRiverWidth	Whether river width visualization should be displayed
bool	bShouldVisualizeWaterVelocity	Whether water velocity visualization should be displayed
FInterpCurveFlo...	Depth
FOnChangeData	OnChangeData
FInterpCurveFlo...	RiverWidth	Rivers Only: The width of the river (from center) in each direction
FInterpCurveFlo...	WaterVelocityScalar	The Current of the water at this vertex. Magnitude and direction

Constructors

	Name	Description
	UWaterSplineMetadata ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	bool	CanEditDepth()
	bool	CanEditRiverWidth()
	bool	CanEditVelocity()
	bool	PropagateDefaultValue ( int32 PointIndex, const FWaterSplineCurveDefaults& C..., const FWaterSplineCurveDefaults& N... )

Overridden from USplineMetadata

	Name	Description
void	AddPoint ( float InputKey )
void	CopyPoint ( const USplineMetadata* FromSpl..., int32 FromIndex, int32 ToIndex )
void	DuplicatePoint ( int32 Index )
void	Fixup ( int32 NumPoints, USplineComponent* SplineComp )
void	InsertPoint ( int32 Index, float t, bool bClosedLoop )	Insert point before index, lerping metadata between previous and next key values
void	RemovePoint ( int32 Index )
void	Reset ( int32 NumPoints )
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
	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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss