FGeometryCollectionRemoveOnBreakDynamicFacade Class Reference

#include <GeometryCollectionEngineRemoval.h>

Public Member Functions
GEOMETRYCOLLECTIONENGINE_API	FGeometryCollectionRemoveOnBreakDynamicFacade (FGeometryDynamicCollection &InCollection)
GEOMETRYCOLLECTIONENGINE_API bool	IsValid () const
GEOMETRYCOLLECTIONENGINE_API bool	IsConst () const
GEOMETRYCOLLECTIONENGINE_API void	DefineSchema ()
GEOMETRYCOLLECTIONENGINE_API void	SetAttributeValues (const GeometryCollection::Facades::FCollectionRemoveOnBreakFacade &RemoveOnBreakFacade)
GEOMETRYCOLLECTIONENGINE_API bool	IsRemovalActive (int32 TransformIndex) const
GEOMETRYCOLLECTIONENGINE_API bool	UseClusterCrumbling (int32 TransformIndex) const
GEOMETRYCOLLECTIONENGINE_API float	UpdateBreakTimerAndComputeDecay (int32 TransformIndex, float DeltaTime)

Static Public Attributes
static constexpr float	DisabledBreakTimer = -1
static constexpr float	BreakTimerStartValue = 0
static constexpr float	DisabledPostBreakDuration = -1
static constexpr float	CrumblingRemovalTimer = -1

Detailed Description

Provides an API for the run time aspect of the remove on break feature this is to be used with the dynamic collection

Constructor & Destructor Documentation

FGeometryCollectionRemoveOnBreakDynamicFacade()

FGeometryCollectionRemoveOnBreakDynamicFacade::FGeometryCollectionRemoveOnBreakDynamicFacade

(

FGeometryDynamicCollection &

InCollection

)

Member Function Documentation

DefineSchema()

void FGeometryCollectionRemoveOnBreakDynamicFacade::DefineSchema

(

)

Add the relevant attributes

IsConst()

bool FGeometryCollectionRemoveOnBreakDynamicFacade::IsConst

(

)

const

Is this facade const access

IsRemovalActive()

bool FGeometryCollectionRemoveOnBreakDynamicFacade::IsRemovalActive

(

int32

TransformIndex

)

const

true if the removal is active for a specific piece

IsValid()

bool FGeometryCollectionRemoveOnBreakDynamicFacade::IsValid

(

)

const

returns true if all the necessary attributes are present if not then the API can be used to create

SetAttributeValues()

void FGeometryCollectionRemoveOnBreakDynamicFacade::SetAttributeValues

(

const GeometryCollection::Facades::FCollectionRemoveOnBreakFacade &

RemoveOnBreakFacade

)

Add the necessary attributes if they are missing and initialize them if necessary

Parameters

RemoveOnBreakFacade

remove on break facade from the rest collection that contain the original user set attributes

UpdateBreakTimerAndComputeDecay()

float FGeometryCollectionRemoveOnBreakDynamicFacade::UpdateBreakTimerAndComputeDecay	(	int32	TransformIndex,
		float	DeltaTime
	)

Update break timer and return the matching decay

Parameters

TransformIndex	index of the transform to update
DeltaTime	elapsed time since the last update in second

Returns

decay value computed from the timer and duration ( [0,1] range )

UseClusterCrumbling()

bool FGeometryCollectionRemoveOnBreakDynamicFacade::UseClusterCrumbling

(

int32

TransformIndex

)

const

true if a specific transform uses cluster crumbling

Member Data Documentation

BreakTimerStartValue

constexpr float FGeometryCollectionRemoveOnBreakDynamicFacade::BreakTimerStartValue = 0

staticconstexpr

CrumblingRemovalTimer

constexpr float FGeometryCollectionRemoveOnBreakDynamicFacade::CrumblingRemovalTimer = -1

staticconstexpr

DisabledBreakTimer

constexpr float FGeometryCollectionRemoveOnBreakDynamicFacade::DisabledBreakTimer = -1

staticconstexpr

DisabledPostBreakDuration

constexpr float FGeometryCollectionRemoveOnBreakDynamicFacade::DisabledPostBreakDuration = -1

staticconstexpr

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Experimental/GeometryCollectionEngine/Public/GeometryCollection/GeometryCollectionEngineRemoval.h
• Engine/Source/Runtime/Experimental/GeometryCollectionEngine/Private/GeometryCollection/GeometryCollectionEngineRemoval.cpp