Navigation
API > API/Plugins > API/Plugins/Water
| Name | UShallowWaterSimulationDataBase |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Water/Source/Runtime/Public/BakedShallowWaterSimulationComponent.h |
| Include Path | #include "BakedShallowWaterSimulationComponent.h" |
Syntax
UCLASS (MinimalAPI)
class UShallowWaterSimulationDataBase : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UShallowWaterSimulationDataBase
Derived Classes
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BakedTexture | TObjectPtr< UTexture2D > | Texture for baked water sim data | 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 |
Compute normal at a world position | BakedShallowWaterSimulationComponent.h | |
FVector FloatIndexToWorld
(
const FVector2D& Index |
Convert a float index to world space | BakedShallowWaterSimulationComponent.h | |
bool HasValidData() |
Check for a valid sim domain | BakedShallowWaterSimulationComponent.h | |
FVector IndexToWorld
(
const FIntVector2& Index |
Convert an integer index to world space | BakedShallowWaterSimulationComponent.h | |
void QueryShallowWaterSimulationAtIndex
(
const FIntVector2& QueryIndex, |
Query sim data at an index | BakedShallowWaterSimulationComponent.h | |
void QueryShallowWaterSimulationAtPosition
(
const FVector& QueryPos, |
Query shallow water grid cell values at a world position | BakedShallowWaterSimulationComponent.h | |
void SampleShallowWaterSimulationAtIndex
(
const FVector2D& QueryFloatIndex, |
Linear interpolate sim data at an index | BakedShallowWaterSimulationComponent.h | |
void SampleShallowWaterSimulationAtPosition
(
const FVector& QueryPos, |
Linear interpolate for shallow water grid cell values at a world position | BakedShallowWaterSimulationComponent.h | |
FVector2D WorldToFloatIndex
(
const FVector& WorldPos |
Convert world space to float index | BakedShallowWaterSimulationComponent.h | |
FIntVector2 WorldToIndex
(
const FVector& WorldPos |
Convert world space to integer index | BakedShallowWaterSimulationComponent.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Build
(
const TArray< FFloat16Color >& InputDenseGrid, |
BakedShallowWaterSimulationComponent.h | ||
virtual int GetMemoryInBytes() |
BakedShallowWaterSimulationComponent.h | ||
virtual int GetNumAllocatedCells() |
BakedShallowWaterSimulationComponent.h | ||
virtual int GetTotalNumCells() |
BakedShallowWaterSimulationComponent.h | ||
virtual FVector4 QueryLowLevelGridAtIndex
(
const FIntVector2 Index |
BakedShallowWaterSimulationComponent.h |