1. Epic GamesDeveloper
  3. FShallowWaterSimulationGrid

FShallowWaterSimulationGrid

API > API/Plugins > API/Plugins/Water

   
Name FShallowWaterSimulationGrid
Type struct
Header File /Engine/Plugins/Experimental/Water/Source/Runtime/Public/BakedShallowWaterSimulationComponent.h
Include Path #include "BakedShallowWaterSimulationComponent.h"

Syntax

USTRUCT (BlueprintType )  
struct FShallowWaterSimulationGrid

Constructors

Name Remarks Include Path Unreal Specifiers
  BakedShallowWaterSimulationComponent.h  

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

   BakedShallowWaterSimulationComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ArrayValues TArray< FVector4 > Raw grid data BakedShallowWaterSimulationComponent.h  
BakedTexture TObjectPtr< UTexture2D > Texture for baked water sim data BakedShallowWaterSimulationComponent.h  
Dx FVector2D World space grid cell size BakedShallowWaterSimulationComponent.h  
NumCells FIntVector2 Number of cells BakedShallowWaterSimulationComponent.h  
Position FVector World space center BakedShallowWaterSimulationComponent.h  
Size FVector2D World space size BakedShallowWaterSimulationComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FVector ComputeShallowWaterSimulationNormalAtPosition ( const FVector& QueryPos
) const

 Compute normal at a world position BakedShallowWaterSimulationComponent.h  

FVector FloatIndexToWorld ( const FVector2D& Index
) const

 Convert a float index to world space BakedShallowWaterSimulationComponent.h  

FVector IndexToWorld ( const FIntVector2& Index
) const

 Convert an integer index to world space BakedShallowWaterSimulationComponent.h  

bool IsValid()

 Check for a valid sim domain BakedShallowWaterSimulationComponent.h  

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

 Query sim data at an index BakedShallowWaterSimulationComponent.h  

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

 Query shallow water grid cell values at a world position BakedShallowWaterSimulationComponent.h  

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

 Linear interpolate sim data at an index BakedShallowWaterSimulationComponent.h  

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

 Linear interpolate for shallow water grid cell values at a world position BakedShallowWaterSimulationComponent.h  

FVector2D WorldToFloatIndex ( const FVector& WorldPos
) const

 Convert world space to float index BakedShallowWaterSimulationComponent.h  

FIntVector2 WorldToIndex ( const FVector& WorldPos
) const

 Convert world space to integer index BakedShallowWaterSimulationComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page