1. Epic GamesDeveloper
  3. FSolverSafeWaterBodyData

FSolverSafeWaterBodyData

API > API/Plugins > API/Plugins/Water

   
Name FSolverSafeWaterBodyData
Type struct
Header File /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterBodyTypes.h
Include Path #include "WaterBodyTypes.h"

Syntax

struct FSolverSafeWaterBodyData

Constructors

Name Remarks Include Path Unreal Specifiers
  WaterBodyTypes.h  
  WaterBodyTypes.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
LandscapeCollisionComponents TArray< UPrimitiveComponent * >   WaterBodyTypes.h  
Location FVector   WaterBodyTypes.h  
MaxWaveHeight float   WaterBodyTypes.h  
OceanHeightOffset float   WaterBodyTypes.h  
TargetWaveMaskDepth float   WaterBodyTypes.h  
WaterBodyIndex int32   WaterBodyTypes.h  
WaterBodyType EWaterBodyType   WaterBodyTypes.h  
WaterSpline FWaterSplineDataPhysics   WaterBodyTypes.h  
WaterSplineMetadata FWaterSplineMetadataPhysics   WaterBodyTypes.h  
WaveParams TArray< FGerstnerWave >   WaterBodyTypes.h  
WaveSpeedFactor float   WaterBodyTypes.h  
World UWorld *   WaterBodyTypes.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

EWaterBodyQueryFlags CheckAndAjustQueryFlags ( EWaterBodyQueryFlags InQueryFlags
) const

   WaterBodyTypes.h  

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

 Computes the raw wave perturbation of the water height only (simple version : faster computation) WaterBodyTypes.h  

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

   WaterBodyTypes.h  

float GetWaterVelocityAtSplineInputKey ( float InKey
) const

   WaterBodyTypes.h  

FVector GetWaterVelocityVectorAtSplineInputKey ( float InKey
) const

   WaterBodyTypes.h  

float GetWaveAttenuationFactor ( const FVector& InPosition,
float InWaterDepth
) const

 Computes the attenuation factor to apply to the raw wave perturbation. WaterBodyTypes.h  

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

   WaterBodyTypes.h  

bool GetWaveInfoAtPosition ( const FVector& InPosition,
float InWaterDepth,
float InWaveReferenceTime,
bool bInSimpleWaves,
FWaveInfo& InOutWaveInfo
) const

 Fills wave-related information at the given world position and for this water depth. WaterBodyTypes.h  

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

   WaterBodyTypes.h  

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

   WaterBodyTypes.h  

bool WaterBodyTypeSupportsWaves()

   WaterBodyTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page