1. Epic GamesDeveloper
  3. FSolverSafeWaterBodyData

FSolverSafeWaterBodyData

API > API/Plugins > API/Plugins/Water

References

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

Syntax

struct FSolverSafeWaterBodyData

Variables

  Type Name Description
Public variable TArray< UPrimitiveComponent * > LandscapeCollisionComponents  
Public variable FVector Location  
Public variable float MaxWaveHeight  
Public variable float OceanHeightOffset  
Public variable float TargetWaveMaskDepth  
Public variable int32 WaterBodyIndex  
Public variable EWaterBodyType WaterBodyType  
Public variable FWaterSplineDataPhysics WaterSpline  
Public variable FWaterSplineMetadataPhysics WaterSplineMetadata  
Public variable TArray< FGerstnerWave > WaveParams  
Public variable float WaveSpeedFactor  
Public variable UWorld * World  

Constructors

  Type Name Description
Public function    
Public function    

Functions

  Type Name Description
Public function Const EWaterBodyQueryFlags  
Public function Const float

GetSimpleWaveHeightAtPosition ( const FVector& InPosition,
float InWaterDepth,
float InTime
)

 Computes the raw wave perturbation of the water height only (simple version : faster computation)
Public function Const float

GetSimpleWaveOffsetAtPosition ( const FGerstnerWave& InParams,
const FVector& InPosition,
float InTime
)

  
Public function Const float  
Public function Const FVector  
Public function Const float

GetWaveAttenuationFactor ( const FVector& InPosition,
float InWaterDepth
)

 Computes the attenuation factor to apply to the raw wave perturbation.
Public function Const float

GetWaveHeightAtPosition ( const FVector& InPosition,
float InWaterDepth,
float InTime,
FVector& OutNormal
)

  
Public function Const 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.
Public function Const FVector

GetWaveOffsetAtPosition ( const FGerstnerWave& InWaveParams,
const FVector& InPosition,
float InTime,
FVector& OutNormal,
float& OutOffset1D
)

  
Public function Const FWaterBodyQueryResult

QueryWaterInfoClosestToWorldLocation ( const FVector& InWorldLocation,
EWaterBodyQueryFlags InQueryFlags,
float InWaveReferenceTime,
const TOptional< float >& InSplineInputKey
)

  
Public function Const bool  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page