1. Epic GamesDeveloper
  3. FGeometryCollectionISMPool

FGeometryCollectionISMPool

A pool of ISMs.

API > API/Runtime > API/Runtime/GeometryCollectionEngine > API/Runtime/GeometryCollectionEngine/GeometryCollection

References

   
Module GeometryCollectionEngine
Header /Engine/Source/Runtime/Experimental/GeometryCollectionEngine/Public/GeometryCollection/GeometryCollectionISMPoolComponent.h
Include #include "GeometryCollection/GeometryCollectionISMPoolComponent.h"

Syntax

struct FGeometryCollectionISMPool

Remarks

A pool of ISMs.

Variables

  Type Name Description
Public variable bool bCachedKeepAlive Cached state of lifecycle cvars from the last Tick()
Public variable bool bCachedRecycle  
Public variable bool bDisableBoundsAndTransformUpdate Whether we force ISMs to use parent bounds and disable transform updates.
Public variable TArray< int32 > FreeList Free list of indices in ISMs that are empty.
Public variable TArray< int32 > FreeListISM Free list of indices in ISMs that have registered ISM components.
Public variable TArray< FGeometryCollectionISM > ISMs Array of ISM objects.
Public variable TMap< FGeometryCollectionStaticMeshInstance, FISMIndex > MeshToISMIndex Mapping from mesh description to ISMs array slot.
Public variable TSet< FGeometryCollectionStaticMeshInstance > PrellocationQueue Set of ISM descriptions that we would like to preallocate.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function FGeometryCollectionMeshInfo

AddInstancesToISM ( UGeometryCollectionISMPoolComponent* OwningComponent,
const FGeometryCollectionStaticMeshInstance& MeshInstance,
int32 InstanceCount,
TArrayView< const float > CustomDataFloats
)

 Add instances to ISM and return a mesh info handle.
Public function void

BatchUpdateInstanceCustomData ( FGeometryCollectionMeshInfo const& MeshInfo,
int32 CustomFloatIndex,
float CustomFloatValue
)

  
Public function bool

BatchUpdateInstancesTransforms ( FGeometryCollectionMeshInfo& MeshInfo,
int32 StartInstanceIndex,
TArrayView< const FTransform > NewInstancesTransforms,
bool bWorldSpace,
bool bMarkRenderStateDirty,
bool bTeleport,
bool bAllowPerInstanceRemoval
)

 Update ISM contents.
Public function void

Clear ()

 Clear all ISM components and associated data.
Public function FISMIndex

GetOrAddISM ( UGeometryCollectionISMPoolComponent* OwningComponent,
const FGeometryCollectionStaticMeshInstance& MeshInstance,
bool& bOutISMCreated
)

 Find or add an ISM and return an ISM index handle.
Public function void Process the preallocation queue.
Public function void Remove instances from an ISM.
Public function void

RemoveISM ( FISMIndex ISMIndex,
bool bKeepAlive,
bool bRecycle
)

 Remove an ISM.
Public function void Add an ISM description to the preallocation queue.
Public function void Tick maintenance of free list and preallocation.
Public function void

UpdateAbsoluteTransforms ( const FTransform& BaseTransform,
EUpdateTransformFlags UpdateTransformFlags,
ETeleportType Teleport
)

  

Typedefs

Name Description
FISMIndex  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page