Navigation
API > API/Plugins > API/Plugins/Buoyancy
| Name | FBuoyancyParticleData |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/Buoyancy/Source/Runtime/Public/BuoyancyParticleData.h |
| Include Path | #include "BuoyancyParticleData.h" |
Syntax
struct FBuoyancyParticleData
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBuoyancyParticleData() |
BuoyancyParticleData.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FBuoyancyParticleData() |
BuoyancyParticleData.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| IndexMap | FHashTable | Bookkeeping arrays | BuoyancyParticleData.h | |
| Interactions | TSparseArray< FBuoyancyInteractionArray > | Sparse array of arrays of buoyancy interactions - the outer array has one entry per particle, the inner array has an entry per water body that it interacts with. | BuoyancyParticleData.h | |
| PrevSubmersionMetaData | TSparseArray< FBuoyancySubmersionMetaData > | BuoyancyParticleData.h | ||
| PrevSubmersions | TSparseArray< FBuoyancySubmersion > | BuoyancyParticleData.h | ||
| ReverseIndexMap | TSparseArray< int32 > | BuoyancyParticleData.h | ||
| SubmergedShapes | TSparseArray< TBitArray<> > | This is a sparse array of bit arrays representing which shapes in an object have already been accounted for when submerging an object. | BuoyancyParticleData.h | |
| SubmersionMetaData | TSparseArray< FBuoyancySubmersionMetaData > | Another sparse array to be kept in sync with Submersions, which will contain metadata useful for event callbacks | BuoyancyParticleData.h | |
| Submersions | TSparseArray< FBuoyancySubmersion > | This sparse array of submersion events is indexed on particle unique indices. | BuoyancyParticleData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 AddOrGetIndex
(
const Chaos::FGeometryParticleHandle& ParticleHandle |
BuoyancyParticleData.h | ||
SIZE_T GetAllocatedSize() |
For memory debugging, log the number of bytes that this class has allocated. | BuoyancyParticleData.h | |
int32 GetIndex
(
const Chaos::FGeometryParticleHandle& ParticleHandle |
Internal index accessor. | BuoyancyParticleData.h | |
FBuoyancyInteractionArray & GetInteractions
(
const Chaos::FGeometryParticleHandle& ParticleHandle |
Element accessors. | BuoyancyParticleData.h | |
FBuoyancySubmersion & GetPrevSubmersion
(
const Chaos::FGeometryParticleHandle& ParticleHandle |
BuoyancyParticleData.h | ||
FBuoyancySubmersionMetaData & GetPrevSubmersionMetaData
(
const Chaos::FGeometryParticleHandle& ParticleHandle |
BuoyancyParticleData.h | ||
TBitArray & GetSubmergedShapes
(
const Chaos::FGeometryParticleHandle& ParticleHandle |
BuoyancyParticleData.h | ||
FBuoyancySubmersion & GetSubmersion
(
const Chaos::FGeometryParticleHandle& ParticleHandle |
BuoyancyParticleData.h | ||
FBuoyancySubmersionMetaData & GetSubmersionMetaData
(
const Chaos::FGeometryParticleHandle& ParticleHandle |
BuoyancyParticleData.h | ||
bool RemoveIndex
(
const Chaos::FGeometryParticleHandle& ParticleHandle |
BuoyancyParticleData.h | ||
void Reset() |
Clear all data without freeing memory, for quick repopulation. | BuoyancyParticleData.h |