Navigation
API > API/Runtime > API/Runtime/GeometryCollectionEngine
Provides an API for the run time aspect of the remove on break feature this is to be used with the dynamic collection
| Name | FGeometryCollectionRemoveOnBreakDynamicFacade |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/GeometryCollectionEngine/Public/GeometryCollection/GeometryCollectionEngineRemoval.h |
| Include Path | #include "GeometryCollection/GeometryCollectionEngineRemoval.h" |
Syntax
class FGeometryCollectionRemoveOnBreakDynamicFacade
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FGeometryCollectionRemoveOnBreakDynamicFacade
(
FGeometryDynamicCollection& InCollection |
GeometryCollection/GeometryCollectionEngineRemoval.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| BreakTimerStartValue | float | GeometryCollection/GeometryCollectionEngineRemoval.h | |
| CrumblingRemovalTimer | float | GeometryCollection/GeometryCollectionEngineRemoval.h | |
| DisabledBreakTimer | float | GeometryCollection/GeometryCollectionEngineRemoval.h | |
| DisabledPostBreakDuration | float | GeometryCollection/GeometryCollectionEngineRemoval.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BreakRemovalDurationAttribute | TManagedArrayAccessor< float > | Removal duration | GeometryCollection/GeometryCollectionEngineRemoval.h | |
| BreakTimerAttribute | TManagedArrayAccessor< float > | Time elapsed since the break in seconds | GeometryCollection/GeometryCollectionEngineRemoval.h | |
| DynamicCollection | const FGeometryDynamicCollection & | GeometryCollection/GeometryCollectionEngineRemoval.h | ||
| PostBreakDurationAttribute | TManagedArrayAccessor< float > | Duration after the break before the removal process starts | GeometryCollection/GeometryCollectionEngineRemoval.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DefineSchema() |
Add the relevant attributes | GeometryCollection/GeometryCollectionEngineRemoval.h | |
bool IsConst() |
Is this facade const access | GeometryCollection/GeometryCollectionEngineRemoval.h | |
bool IsRemovalActive
(
int32 TransformIndex |
True if the removal is active for a specific piece | GeometryCollection/GeometryCollectionEngineRemoval.h | |
bool IsValid() |
Returns true if all the necessary attributes are present if not then the API can be used to create | GeometryCollection/GeometryCollectionEngineRemoval.h | |
void SetAttributeValues
(
const GeometryCollection::Facades::FCollectionRemoveOnBreakFacade& RemoveOnBreakFacade |
Add the necessary attributes if they are missing and initialize them if necessary | GeometryCollection/GeometryCollectionEngineRemoval.h | |
float UpdateBreakTimerAndComputeDecay
(
int32 TransformIndex, |
Update break timer and return the matching decay | GeometryCollection/GeometryCollectionEngineRemoval.h | |
bool UseClusterCrumbling
(
int32 TransformIndex |
True if a specific transform uses cluster crumbling | GeometryCollection/GeometryCollectionEngineRemoval.h |