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

FSolverSafeWaterBodyData

Windows

MacOS

Linux

References

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

Syntax

struct FSolverSafeWaterBodyData

Variables

		Name	Description
	TArray< UPrimit...	LandscapeCollisionComponents
	FVector	Location
	float	MaxWaveHeight
	float	OceanHeightOffset
	float	TargetWaveMaskDepth
	int32	WaterBodyIndex
	EWaterBodyType	WaterBodyType
	FWaterSplineDat...	WaterSpline
	FWaterSplineMet...	WaterSplineMetadata
	TArray< FGerstn...	WaveParams
	float	WaveSpeedFactor
	UWorld *	World

Constructors

	Name	Description
	FSolverSafeWaterBodyData()
	FSolverSafeWaterBodyData ( AWaterBody* WaterBody )

Functions

	Name	Description
EWaterBodyQu...	CheckAndAjustQueryFlags ( EWaterBodyQueryFlags InQueryFlags )
float	GetSimpleWaveHeightAtPosition ( const FVector& InPosition, float InWaterDepth, float InTime )	Computes the raw wave perturbation of the water height only (simple version : faster computation)
float	GetSimpleWaveOffsetAtPosition ( const FGerstnerWave& InParams, const FVector& InPosition, float InTime )
float	GetWaterVelocityAtSplineInputKey ( float InKey )
FVector	GetWaterVelocityVectorAtSplineInputKey ( float InKey )
float	GetWaveAttenuationFactor ( const FVector& InPosition, float InWaterDepth )	Computes the attenuation factor to apply to the raw wave perturbation.
float	GetWaveHeightAtPosition ( const FVector& InPosition, float InWaterDepth, float InTime, FVector& OutNormal )
bool	GetWaveInfoAtPosition ( const FVector& InPosition, float InWaterDepth, float InWaveReferenceTime, bool bInSimpleWaves, FWaveInfo& InOutWaveInfo )	Fills wave-related information at the given world position and for this water depth.
FVector	GetWaveOffsetAtPosition ( const FGerstnerWave& InWaveParams, const FVector& InPosition, float InTime, FVector& OutNormal, float& OutOffset1D )
FWaterBodyQu...	QueryWaterInfoClosestToWorldLocation ( const FVector& InWorldLocation, EWaterBodyQueryFlags InQueryFlags, float InWaveReferenceTime, const TOptional< float >& InSpline... )
bool	WaterBodyTypeSupportsWaves()

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

Take our survey

Dismiss