AWaterBody::GetWaveInfoAtPosition

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

Windows
MacOS
Linux

References

Module

Water

Header

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

Include

#include "WaterBodyActor.h"

Source

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

Syntax

bool GetWaveInfoAtPosition
(
    const FVector & InPosition,
    float InWaterDepth,
    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. Returns wave-related information at the given world position and for this water depth. Pass bSimpleWaves = true for the simple version (faster computation, lesser accuracy, doesn't perturb the normal)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss