Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. FGeometryCollectionRemoveOnSleepDynamicFacade

FGeometryCollectionRemoveOnSleepDynamicFacade

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

API > API/Runtime > API/Runtime/GeometryCollectionEngine

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

   
Name FGeometryCollectionRemoveOnSleepDynamicFacade
Type class
Header File /Engine/Source/Runtime/Experimental/GeometryCollectionEngine/Public/GeometryCollection/GeometryCollectionEngineRemoval.h
Include Path #include "GeometryCollection/GeometryCollectionEngineRemoval.h"

Syntax

class FGeometryCollectionRemoveOnSleepDynamicFacade

Constructors

Name Remarks Include Path Unreal Specifiers

FGeometryCollectionRemoveOnSleepDynamicFacade ( FManagedArrayCollection& InCollection
)

   GeometryCollection/GeometryCollectionEngineRemoval.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
LastPositionAttribute TManagedArrayAccessor< FVector > Last position used to detect slow moving pieces GeometryCollection/GeometryCollectionEngineRemoval.h  
MaxSleepTimeAttribute TManagedArrayAccessor< float > Duration after the sleep detection before the removal process starts (read only from outside) GeometryCollection/GeometryCollectionEngineRemoval.h  
SleepRemovalDurationAttribute TManagedArrayAccessor< float > Removal duration (read only from outside) GeometryCollection/GeometryCollectionEngineRemoval.h  
SleepTimerAttribute TManagedArrayAccessor< float > Time elapsed since the sleep detection GeometryCollection/GeometryCollectionEngineRemoval.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

float ComputeDecay ( int32 TransformIndex
) const

 Compute decay from elapsed timer and duration attributes GeometryCollection/GeometryCollectionEngineRemoval.h  

bool 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 GeometryCollection/GeometryCollectionEngineRemoval.h  

void DefineSchema()

 Add the relevant attributes GeometryCollection/GeometryCollectionEngineRemoval.h  

float GetMaxSleepTime ( int32 TransformIndex
) const

   GeometryCollection/GeometryCollectionEngineRemoval.h  

float GetSleepRemovalDuration ( int32 TransformIndex
) const

   GeometryCollection/GeometryCollectionEngineRemoval.h  

bool IsConst()

 Is this facade const access GeometryCollection/GeometryCollectionEngineRemoval.h  

bool IsRemovalActive ( int32 TransformIndex
) const

 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 FVector2D& MaximumSleepTime,
const FVector2D& RemovalDuration
)

 Add the necessary attributes if they are missing and initialize them if necessary GeometryCollection/GeometryCollectionEngineRemoval.h  

void SetMaxSleepTime ( int32 TransformIndex,
float MaxSleepTime
)

   GeometryCollection/GeometryCollectionEngineRemoval.h  

void SetSleepRemovalDuration ( int32 TransformIndex,
float SleepRemovalDuration
)

   GeometryCollection/GeometryCollectionEngineRemoval.h  

void UpdateSleepTimer ( int32 TransformIndex,
float DeltaTime
)

 Update the sleep timer GeometryCollection/GeometryCollectionEngineRemoval.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page