FGeometryCollectionRemoveOnSleepDynamicFacade Class Reference

#include <GeometryCollectionEngineRemoval.h>

Public Member Functions
GEOMETRYCOLLECTIONENGINE_API	FGeometryCollectionRemoveOnSleepDynamicFacade (FManagedArrayCollection &InCollection)
GEOMETRYCOLLECTIONENGINE_API bool	IsValid () const
GEOMETRYCOLLECTIONENGINE_API bool	IsConst () const
GEOMETRYCOLLECTIONENGINE_API void	DefineSchema ()
GEOMETRYCOLLECTIONENGINE_API float	GetSleepRemovalDuration (int32 TransformIndex) const
GEOMETRYCOLLECTIONENGINE_API float	GetMaxSleepTime (int32 TransformIndex) const
GEOMETRYCOLLECTIONENGINE_API void	SetSleepRemovalDuration (int32 TransformIndex, float SleepRemovalDuration)
GEOMETRYCOLLECTIONENGINE_API void	SetMaxSleepTime (int32 TransformIndex, float MaxSleepTime)
GEOMETRYCOLLECTIONENGINE_API void	SetAttributeValues (const FVector2D &MaximumSleepTime, const FVector2D &RemovalDuration)
GEOMETRYCOLLECTIONENGINE_API bool	IsRemovalActive (int32 TransformIndex) const
GEOMETRYCOLLECTIONENGINE_API bool	ComputeSlowMovingState (int32 TransformIndex, const FVector &Position, float DeltaTime, FVector::FReal VelocityThreshold)
GEOMETRYCOLLECTIONENGINE_API void	UpdateSleepTimer (int32 TransformIndex, float DeltaTime)
GEOMETRYCOLLECTIONENGINE_API float	ComputeDecay (int32 TransformIndex) const

Detailed Description

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

Constructor & Destructor Documentation

FGeometryCollectionRemoveOnSleepDynamicFacade()

FGeometryCollectionRemoveOnSleepDynamicFacade::FGeometryCollectionRemoveOnSleepDynamicFacade

(

FManagedArrayCollection &

InCollection

)

Member Function Documentation

ComputeDecay()

float FGeometryCollectionRemoveOnSleepDynamicFacade::ComputeDecay

(

int32

TransformIndex

)

const

Compute decay from elapsed timer and duration attributes

ComputeSlowMovingState()

bool FGeometryCollectionRemoveOnSleepDynamicFacade::ComputeSlowMovingState	(	int32	TransformIndex,
		const FVector &	Position,
		float	DeltaTime,
		FVector::FReal	VelocityThreshold
	)

Compute the slow moving state and update from the last position After calling this method, LastPosition will be updated with Position

Parameters

Position	Current world position
DeltaTime	elapsed time since last update

Returns

true if the piece if the piece is considered slow moving

DefineSchema()

void FGeometryCollectionRemoveOnSleepDynamicFacade::DefineSchema

(

)

Add the relevant attributes

GetMaxSleepTime()

float FGeometryCollectionRemoveOnSleepDynamicFacade::GetMaxSleepTime

(

int32

TransformIndex

)

const

GetSleepRemovalDuration()

float FGeometryCollectionRemoveOnSleepDynamicFacade::GetSleepRemovalDuration

(

int32

TransformIndex

)

const

IsConst()

bool FGeometryCollectionRemoveOnSleepDynamicFacade::IsConst

(

)

const

Is this facade const access

IsRemovalActive()

bool FGeometryCollectionRemoveOnSleepDynamicFacade::IsRemovalActive

(

int32

TransformIndex

)

const

true if the removal is active for a specific piece

IsValid()

bool FGeometryCollectionRemoveOnSleepDynamicFacade::IsValid

(

)

const

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

SetAttributeValues()

void FGeometryCollectionRemoveOnSleepDynamicFacade::SetAttributeValues	(	const FVector2D &	MaximumSleepTime,
		const FVector2D &	RemovalDuration
	)

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

Parameters

MaximumSleepTime	range of time to initialize the sleep duration
RemovalDuration	range of time to initialize the removal duration

SetMaxSleepTime()

void FGeometryCollectionRemoveOnSleepDynamicFacade::SetMaxSleepTime	(	int32	TransformIndex,
		float	MaxSleepTime
	)

SetSleepRemovalDuration()

void FGeometryCollectionRemoveOnSleepDynamicFacade::SetSleepRemovalDuration	(	int32	TransformIndex,
		float	SleepRemovalDuration
	)

UpdateSleepTimer()

void FGeometryCollectionRemoveOnSleepDynamicFacade::UpdateSleepTimer	(	int32	TransformIndex,
		float	DeltaTime
	)

Update the sleep timer

Parameters

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

---

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