Navigation
API > API/Plugins > API/Plugins/Water
Struct holding the result from water queries :
| Name | FWaterBodyQueryResult |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterBodyTypes.h |
| Include Path | #include "WaterBodyTypes.h" |
Syntax
struct FWaterBodyQueryResult
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FWaterBodyQueryResult
(
const TOptional< float >& InSplineInputKey |
WaterBodyTypes.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsInExclusionVolume | bool | Whether the requested location is within an exclusion volme (optionally ignored) | WaterBodyTypes.h | |
| ImmersionDepth | float | Difference between the query location depth and the water surface depth, (optionally) includes wave perturbation (if IncludeWaves is passed) | WaterBodyTypes.h | |
| QueryFlags | EWaterBodyQueryFlags | Always set : | WaterBodyTypes.h | |
| SplineInputKey | TOptional< float > | Optionally set : Sample point on the spline used in the query (may or may not be computed depending on the query/water body type) : | WaterBodyTypes.h | |
| Velocity | FVector | Velocity of the water at this location. | WaterBodyTypes.h | |
| WaterPlaneDepth | float | Depth of the water plane (i.e. the water surface, excluding waves) : | WaterBodyTypes.h | |
| WaterPlaneLocation | FVector | Location of the water plane (i.e. the water surface, excluding waves) : | WaterBodyTypes.h | |
| WaterPlaneNormal | FVector | Normal of the water plane (i.e. the water surface, excluding waves) : | WaterBodyTypes.h | |
| WaterSurfaceDepth | float | (Optionally) includes wave perturbation (if IncludeWaves is passed), otherwise, same as WaterPlaneDepth : | WaterBodyTypes.h | |
| WaterSurfaceLocation | FVector | (Optionally) includes wave perturbation (if IncludeWaves is passed), otherwise, same as WaterPlaneLocation : | WaterBodyTypes.h | |
| WaterSurfaceNormal | FVector | (Optionally) includes wave perturbation (if IncludeWaves is passed), otherwise, same as WaterPlaneNormal : | WaterBodyTypes.h | |
| WaveInfo | FWaveInfo | Wave perturbation information (if IncludeWaves is passed) : | WaterBodyTypes.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetImmersionDepth() |
WaterBodyTypes.h | ||
EWaterBodyQueryFlags GetQueryFlags() |
WaterBodyTypes.h | ||
const TOptional< float > & GetSplineInputKey() |
WaterBodyTypes.h | ||
const FVector & GetVelocity() |
WaterBodyTypes.h | ||
float GetWaterPlaneDepth() |
WaterBodyTypes.h | ||
const FVector & GetWaterPlaneLocation() |
WaterBodyTypes.h | ||
const FVector & GetWaterPlaneNormal() |
WaterBodyTypes.h | ||
float GetWaterSurfaceDepth() |
WaterBodyTypes.h | ||
const FVector & GetWaterSurfaceLocation() |
WaterBodyTypes.h | ||
const FVector & GetWaterSurfaceNormal() |
WaterBodyTypes.h | ||
const FWaveInfo & GetWaveInfo() |
WaterBodyTypes.h | ||
bool IsInExclusionVolume() |
WaterBodyTypes.h | ||
bool IsInWater() |
WaterBodyTypes.h | ||
float LazilyComputeSplineKey
(
const UWaterBodyComponent& InWaterBodyComponent, |
WaterBodyTypes.h | ||
float LazilyComputeSplineKey
(
const FWaterSplineDataPhysics& InWaterSpline, |
WaterBodyTypes.h | ||
void SetImmersionDepth
(
float InValue |
WaterBodyTypes.h | ||
void SetIsInExclusionVolume
(
bool bInValue |
WaterBodyTypes.h | ||
void SetQueryFlags
(
EWaterBodyQueryFlags InFlags |
WaterBodyTypes.h | ||
void SetVelocity
(
const FVector& InValue |
WaterBodyTypes.h | ||
void SetWaterPlaneDepth
(
float InValue |
WaterBodyTypes.h | ||
void SetWaterPlaneLocation
(
const FVector& InValue |
WaterBodyTypes.h | ||
void SetWaterPlaneNormal
(
const FVector& InValue |
WaterBodyTypes.h | ||
void SetWaterSurfaceDepth
(
float InValue |
WaterBodyTypes.h | ||
void SetWaterSurfaceLocation
(
const FVector& InValue |
WaterBodyTypes.h | ||
void SetWaterSurfaceNormal
(
const FVector& InValue |
WaterBodyTypes.h | ||
void SetWaveInfo
(
const FWaveInfo& InValue |
WaterBodyTypes.h |