FSolverSafeWaterBodyData::GetWaveInfoAtPosition

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

Choose your operating system:

Windows

macOS

Linux

References

Module

Water

Header

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

Include

#include "WaterBodyTypes.h"

Source

/Engine/Plugins/Experimental/Water/Source/Runtime/Private/WaterBodyTypes.cpp

Syntax

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

Remarks

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

  • InPosition : water surface position at which to query the wave information

  • InWaterDepth : water depth at this location

  • bSimpleWaves : true for the simple version (faster computation, lesser accuracy, doesn't perturb the normal)

  • FWaveInfo : input/output : the structure's field must be initialized prior to the call (e.g. InOutWaveInfo.Normal is the unperturbed normal) Returns true if waves are supported, false otherwise.