1. Epic GamesDeveloper
  3. FShallowWaterSimulationGrid

FShallowWaterSimulationGrid

API > API/Plugins > API/Plugins/Water

References

   
Module Water
Header /Engine/Plugins/Experimental/Water/Source/Runtime/Public/BakedShallowWaterSimulationComponent.h
Include #include "BakedShallowWaterSimulationComponent.h"

Syntax

USTRUCT (BlueprintType )  
struct FShallowWaterSimulationGrid

Variables

  Type Name Description
Public variable UProperty TArray< FVector4 > ArrayValues Raw grid data
Public variable UProperty TObjectPtr< UTexture2D > BakedTexture Texture for baked water sim data
Public variable UProperty FVector2D Dx World space grid cell size
Public variable UProperty FIntVector2 NumCells Number of cells
Public variable UProperty FVector Position World space center
Public variable UProperty FVector2D Size World space size

Constructors

  Type Name Description
Public function    
Public function  

FShallowWaterSimulationGrid ( const TArray< FVector4 >& InArrayValues,
TObjectPtr< UTexture2D > InBakedWaterTexture,
const FIntVector2& InNumCells,
const FVector& InPosition,
const FVector2D& InSize
)

  

Functions

  Type Name Description
Public function Const FVector Compute normal at a world position
Public function Const FVector

FloatIndexToWorld ( const FVector2D& Index
)

 Convert a float index to world space
Public function Const FVector

IndexToWorld ( const FIntVector2& Index
)

 Convert an integer index to world space
Public function Const bool

IsValid ()

 Check for a valid sim domain
Public function Const void

QueryShallowWaterSimulationAtIndex ( const FIntVector2& QueryIndex,
FVector& OutWaterVelocity,
float& OutWaterHeight,
float& OutWaterDepth
)

 Query sim data at an index
Public function Const void

QueryShallowWaterSimulationAtPosition ( const FVector& QueryPos,
FVector& OutWaterVelocity,
float& OutWaterHeight,
float& OutWaterDepth
)

 Query shallow water grid cell values at a world position
Public function Const void

SampleShallowWaterSimulationAtIndex ( const FVector2D& QueryFloatIndex,
FVector& OutWaterVelocity,
float& OutWaterHeight,
float& OutWaterDepth
)

 Linear interpolate sim data at an index
Public function Const void

SampleShallowWaterSimulationAtPosition ( const FVector& QueryPos,
FVector& OutWaterVelocity,
float& OutWaterHeight,
float& OutWaterDepth
)

 Linear interpolate for shallow water grid cell values at a world position
Public function Const FVector2D

WorldToFloatIndex ( const FVector& WorldPos
)

 Convert world space to float index
Public function Const FIntVector2

WorldToIndex ( const FVector& WorldPos
)

 Convert world space to integer index

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page