1. Epic GamesDeveloper
  3. Buoyancy

Buoyancy

API > API/Plugins

   
Name Buoyancy
Type Runtime
Part of Plugins Buoyancy
Location /Engine/Plugins/Experimental/Buoyancy/Source/Runtime/
Module Build Rules Buoyancy.Build.cs

Classes

Name Remarks
FBuoyancyBoxShape  
FBuoyancyConstantSplineSampler Sampler for spline rivers, but we are only doing 1 spline sample per interaction to match the perf of the old system.
FBuoyancyConvexShape  
FBuoyancyModule  
FBuoyancyShallowWaterSampler Sample water from a baked shallow water simulation
FBuoyancyShape Abstract class to sample water for a given particle
FBuoyancySubsystemSimCallback NOTE: The Presimulate option is only needed for proper registry with the solver.
FBuoyancyWaterSampler Abstract class to sample water for a given particle
FBuoyancyWaterSplineDataManager Callback object for keeping water splines up to date on the physics thread
FSplineKeyCacheGrid  
UBuoyancyEventInterface  
UBuoyancyRuntimeSettings  
UBuoyancySubsystem Buoyancy Subsystem

Structs

Name Remarks
FBuoyancyInteraction Each particle will have a list of potential midphases to process, which must be sorted in descending Z order.
FBuoyancyParticleData  
FBuoyancySettings Buoyancy Settings
FBuoyancyShapeTopologyLimits #todo(dmp): adjust these
FBuoyancySubmersion A minimal struct of data tracking all the submersions in a frame.
FBuoyancySubmersionMetaData Metadata for submersions, used for event callbacks.
FBuoyancySubsystemSimCallbackInput Buoyancy Sim Callback
FBuoyancySubsystemSimCallbackOutput  
FBuoyancyWaterSplineData  
FSubmersion Minimal struct containing essential data about a particular submersion.

Interfaces

Name Remarks
IBuoyancyEventInterface  

Typedefs

Name Type Remarks Include Path
FBuoyancyInteractionArray TArray< FBuoyancyInteraction, TInlineAllocator< MaxNumBuoyancyInteractions > >   BuoyancyParticleData.h

Enums

Public

Name Remarks
EBuoyancyEventFlags  
EWaterSamplerType  

Constants

Name Type Remarks Include Path
MaxNumBuoyancyInteractions int32   BuoyancyParticleData.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
STATCAT_Advanced     BuoyancyStats.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool BuoyancyAlgorithms::ComputeSubmergedVolume ( FBuoyancyParticleData& ParticleData,
const Chaos::FGeometryParticleHandle* ParticleA,
const Chaos::FGeometryParticleHandle* ParticleB,
int32 NumSubdivisions,
float MinVolume,
float& SubmergedVol,
Chaos::FVec3& SubmergedCoM
)

 Compute an approximate volume and center of mass of particle B submerged in particle A. BuoyancyAlgorithms.h  

bool BuoyancyAlgorithms::ComputeSubmergedVolume ( FBuoyancyParticleData& ParticleData,
const Chaos::FPBDRigidsEvolutionGBF& Evolution,
const Chaos::FGeometryParticleHandle* ParticleA,
const Chaos::FGeometryParticleHandle* ParticleB,
int32 NumSubdivisions,
float MinVolume,
float& SubmergedVol,
Chaos::FVec3& SubmergedCoM,
float& TotalVol
)

 Compute an approximate volume and center of mass of particle B submerged in particle A, adjusting for the volume of the object based on the material density and mass of the object BuoyancyAlgorithms.h  

bool operator! ( EBuoyancyEventFlags E
)

   BuoyancyEventFlags.h  
  BuoyancyEventFlags.h  
  BuoyancyEventFlags.h  
  BuoyancyEventFlags.h  
  BuoyancyEventFlags.h  
  BuoyancyEventFlags.h  
  BuoyancyEventFlags.h  
  BuoyancyEventFlags.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page