1. Epic GamesDeveloper
  3. UBuoyancyComponent

UBuoyancyComponent

API > API/Plugins > API/Plugins/Water

Inheritance Hierarchy

References

   
Module Water
Header /Engine/Plugins/Experimental/Water/Source/Runtime/Public/BuoyancyComponent.h
Include #include "BuoyancyComponent.h"

Syntax

UCLASS&40;Blueprintable, Config&61;Game, Meta&61;&40;BlueprintSpawnableComponent&41;&41;  
class UBuoyancyComponent : public UActorComponent

Variables

  Type Name Description
Protected variable int8: 1 bCanBeActive  
Protected variable int8: 1 bIsInWaterBody  
Protected variable int8: 1 bIsOverlappingWaterBody  
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly FBuoyancyData BuoyancyData  
Public variable uint8: 1 bUseAsyncPath  
Protected variable TMap< uint32, TArray< float > > ConfiguredPontoonCoefficients  
Protected variable FBuoyancyComponentAsyncInput * CurAsyncInput  
Protected variable FBuoyancyComponentAsyncOutput * CurAsyncOutput  
Protected variable EAsyncBuoyancyComponentDataType CurAsyncType  
Protected variable UProperty Transient TArray< TObjectPtr< UWaterBodyComponent > > CurrentWaterBodyComponents  
Protected variable FBuoyancyComponentAsyncOutput * NextAsyncOutput  
Public variable UProperty Category BlueprintAssignable FOnPontoonEnteredWater OnEnteredWaterDelegate  
Public variable UProperty Category BlueprintAssignable FOnPontoonExitedWater OnExitedWaterDelegate  
Protected variable float OutputInterpAlpha  
Protected variable TArray< FAsyncOutputWrapper > OutputsWaitingOn  
Protected variable uint32 PontoonConfiguration  
Protected variable UProperty TObjectPtr< UPrimitiveComponent > SimulatingComponent Primitive component that will be used for physics simulation.
Protected variable int32 VelocityPontoonIndex  

Constructors

  Type Name Description
Public function  

UBuoyancyComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddCustomPontoon ( float Radius,
FName CenterSocketName
)

  
Public function void

AddCustomPontoon ( float Radius,
const FVector& RelativeLocation
)

  
Protected function Virtual void

ApplyBuoyancy ( UPrimitiveComponent* PrimitiveComponent
)

  
Public function Virtual void

ApplyForces ( float DeltaTime,
FVector LinearVelocity,
float ForwardSpeed,
float ForwardSpeedKmh,
UPrimitiveComponent* PrimitiveComponent
)

  
Public function Const FVector

ComputeAngularDragTorque ( const FVector& AngularVelocity
)

  
Protected function void

ComputeBuoyancy ( FSphericalPontoon& Pontoon,
float ForwardSpeedKmh
)

  
Public function Const FVector

ComputeLinearDragForce ( const FVector& PhyiscsVelocity
)

  
Protected function void  
Public function Const FVector

ComputeWaterForce ( const float DeltaTime,
const FVector LinearVelocity
)

  
Public function Virtual Const TUniquePtr< FBuoyancyComponentAsyncAux >  
Public function void

EnteredWaterBody ( UWaterBodyComponent* WaterBodyComponent
)

  
Public function void

ExitedWaterBody ( UWaterBodyComponent* WaterBodyComponent
)

  
Public function Virtual void  
Public function void  
Public function Virtual void  
Public function void  
Public function TArray< TObjectPtr< UWaterBodyComponent > > &  
Public function Const UFunction BlueprintCallable, Category const TArray< UWaterBodyComponent * > &  
Public function UFunction BlueprintCallable, Category void

GetLastWaterSurfaceInfo ( FVector& OutWaterPlaneLocation,
FVector& OutWaterPlaneNormal,
FVector& OutWaterSurfacePosition,
float& OutWaterDepth,
int32& OutWaterBodyIdx,
FVector& OutWaterVelocity
)

  
Public function UPrimitiveComponent *  
Public function float

GetWaterHeight ( FVector Position,
const TMap< const UWaterBodyComponent*, float >& SplineKeyMap,
float DefaultHeight,
UWaterBodyComponent*& OutWaterBodyComponent,
float& OutWaterDepth,
FVector& OutWaterPlaneLocation,
FVector& OutWaterPlaneNormal,
FVector& OutWaterSurfacePosition,
FVector& OutWaterVelocity,
int32& OutWaterBodyIdx,
bool bShouldIncludeWaves
)

  
Public function float

GetWaterHeight ( FVector Position,
const TMap< const UWaterBodyComponent*, float >& SplineKeyMap,
float DefaultHeight,
bool bShouldIncludeWaves
)

  
Public function Const void

GetWaterSplineKey ( FVector Location,
TMap< const UWaterBodyComponent*, float >& OutMap,
TMap< const UWaterBodyComponent*, float >& OutSegmentMap
)

  
Public function Const bool  
Public function Virtual Const bool  
Public function Const UFunction BlueprintCallable, Category bool  
Public function Const UFunction BlueprintCallable, Category bool  
Public function Const bool  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function void

SetCanBeActive ( bool bInCanBeActive
)

  
Public function Virtual TUniquePtr< FBuoyancyComponentAsyncInput >

SetCurrentAsyncInputOutput ( int32 InputIdx,
FBuoyancyManagerAsyncOutput* CurOutput,
FBuoyancyManagerAsyncOutput* NextOutput,
float Alpha,
int32 BuoyancyManagerTimestamp
)

  
Public function void

SetCurrentAsyncInputOutputInternal ( FBuoyancyComponentAsyncInput* CurInput,
int32 InputIdx,
FBuoyancyManagerAsyncOutput* CurOutput,
FBuoyancyManagerAsyncOutput* NextOutput,
float Alpha,
int32 BuoyancyManagerTimestamp
)

  
Public function Virtual void  
Public function Virtual void

Update ( float DeltaTime
)

  
Public function void  
Public function Virtual int32

UpdatePontoons ( float DeltaTime,
float ForwardSpeed,
float ForwardSpeedKmh,
UPrimitiveComponent* PrimitiveComponent
)

  

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Begins Play for the component.
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Ends gameplay for this component.
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Protected struct FAsyncOutputWrapper    

Deprecated Variables

  Type Name Description
Public variable UProperty Meta TArray< FSphericalPontoon > Pontoons_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page