Navigation
API > API/Runtime > API/Runtime/Chaos > API/Runtime/Chaos/FHeightField
| Name | FData |
| Type | struct |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/HeightField.h |
| Include Path | #include "Chaos/HeightField.h" |
Syntax
template<typename InStorageType>
struct FData
Structs
| Name | Remarks |
|---|---|
| MinMaxHeights |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| StorageType | InStorageType | For ease of access through typedefs. | Chaos/HeightField.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| LowResInc | int32 | Chaos/HeightField.h | |
| RealSize | int32 | Data sizes to validate during serialization. | Chaos/HeightField.h |
| StorageRange | int32 | Range of the chosen type (unsigned so Min is always 0) | Chaos/HeightField.h |
| StorageSize | int32 | Chaos/HeightField.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| HeightPerUnit | FReal | Chaos/HeightField.h | ||
| Heights | TArray< StorageType > | Heights in the chosen format. | Chaos/HeightField.h | |
| LowResolutionHeights | TArray< MinMaxHeights > | Chaos/HeightField.h | ||
| MaterialIndices | TArray< uint8 > | Chaos/HeightField.h | ||
| MaxValue | FReal | Chaos/HeightField.h | ||
| MinValue | FReal | Chaos/HeightField.h | ||
| NumCols | uint16 | Chaos/HeightField.h | ||
| NumColsLowRes | uint16 | Chaos/HeightField.h | ||
| NumRows | uint16 | Chaos/HeightField.h | ||
| Range | FReal | Chaos/HeightField.h | ||
| Scale | FVec3 | Chaos/HeightField.h | ||
| ScaleSimd | VectorRegister4Float | Chaos/HeightField.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BuildLowResolutionData() |
A height bounds for grids of cells of size "LowResInc" square, for faster culling. | Chaos/HeightField.h | |
int32 CellIndexToVertexIndex
(
const int32 CellIndex |
Convert a Cell Index to a Vertex Index. Returns the vertex index of the first corner in the cell. The other corners will be (VertexIndex + 1), (VertexIndex + NumCols), (VertexIndex + NumCols + 1). Most functions in this class take a vertex index. | Chaos/HeightField.h | |
void GetBounds
(
TVec2< int32 > CellIdx, |
Chaos/HeightField.h | ||
void GetBoundsScaled
(
TVec2< int32 > CellIdx, |
Chaos/HeightField.h | ||
void GetBoundsScaled
(
TVec2< int32 > CellIdx, |
Chaos/HeightField.h | ||
void GetBoundsScaledSimd
(
int32 Index, |
Chaos/HeightField.h | ||
void GetBoundsSimd
(
int32 Index, |
Chaos/HeightField.h | ||
FReal GetCellHeight() |
Chaos/HeightField.h | ||
FReal GetCellWidth() |
Chaos/HeightField.h | ||
void GetLowResBounds
(
TVec2< int32 > CellIdx, |
Chaos/HeightField.h | ||
void GetLowResBoundsScaled
(
TVec2< int32 > CellIdx, |
Chaos/HeightField.h | ||
FReal GetMaxHeight() |
Chaos/HeightField.h | ||
FReal GetMinHeight() |
Chaos/HeightField.h | ||
FVec3 GetPoint
(
int32 Index |
Chaos/HeightField.h | ||
void GetPoints
(
int32 Index, |
Chaos/HeightField.h | ||
void GetPointsAndBounds
(
int32 Index, |
Chaos/HeightField.h | ||
void GetPointsAndBoundsScaled
(
int32 Index, |
Chaos/HeightField.h | ||
void GetPointsAndBoundsScaledSimd
(
int32 Index, |
Chaos/HeightField.h | ||
void GetPointsAndBoundsSimd
(
int32 Index, |
Chaos/HeightField.h | ||
FVec3 GetPointScaled
(
int32 Index |
Chaos/HeightField.h | ||
void GetPointsScaled
(
int32 Index, |
Chaos/HeightField.h | ||
void Serialize
(
FChaosArchive& Ar |
Chaos/HeightField.h |