FWaterBodyQueryResult

Struct holding the result from water queries :

Choose your operating system:

Windows

macOS

Linux

References

Module

Water

Header

/Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterBodyTypes.h

Include

#include "WaterBodyTypes.h"

Syntax

struct FWaterBodyQueryResult

Remarks

Struct holding the result from water queries :

Constructors

Name Description

Public function

FWaterBodyQueryResult

(
    const TOptional< float >& InSpline...
)

Functions

Name Description

Public function Const

float

 

GetImmersionDepth()

Public function Const

EWaterBodyQu...

 

GetQueryFlags()

Public function Const

const TOptio...

 

GetSplineInputKey()

Public function Const

const FVecto...

 

GetVelocity()

Public function Const

float

 

GetWaterPlaneDepth()

Public function Const

const FVecto...

 

GetWaterPlaneLocation()

Public function Const

const FVecto...

 

GetWaterPlaneNormal()

Public function Const

float

 

GetWaterSurfaceDepth()

Public function Const

const FVecto...

 

GetWaterSurfaceLocation()

Public function Const

const FVecto...

 

GetWaterSurfaceNormal()

Public function Const

const FWaveI...

 

GetWaveInfo()

Public function Const

bool

 

IsInExclusionVolume()

Public function Const

bool

 

IsInWater()

Public function

float

 

LazilyComputeSplineKey

(
    const UWaterBodyComponent& InWater...,
    const FVector& InWorldLocation
)

Public function

float

 

LazilyComputeSplineKey

(
    const FWaterSplineDataPhysics& InW...,
    const FVector& InWorldLocation
)

Public function

void

 

SetImmersionDepth

(
    float InValue
)

Public function

void

 

SetIsInExclusionVolume

(
    bool bInValue
)

Public function

void

 

SetQueryFlags

(
    EWaterBodyQueryFlags InFlags
)

Public function

void

 

SetVelocity

(
    const FVector& InValue
)

Public function

void

 

SetWaterPlaneDepth

(
    float InValue
)

Public function

void

 

SetWaterPlaneLocation

(
    const FVector& InValue
)

Public function

void

 

SetWaterPlaneNormal

(
    const FVector& InValue
)

Public function

void

 

SetWaterSurfaceDepth

(
    float InValue
)

Public function

void

 

SetWaterSurfaceLocation

(
    const FVector& InValue
)

Public function

void

 

SetWaterSurfaceNormal

(
    const FVector& InValue
)

Public function

void

 

SetWaveInfo

(
    const FWaveInfo& InValue
)