UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FISMPoolMeshGroup Struct Reference

#include <ISMPoolComponent.h>

Public Types

using FMeshId = int32
 

Public Member Functions

FMeshId AddMesh (const FISMPoolStaticMeshInstance &MeshInstance, int32 InstanceCount, const FISMPoolMeshInfo &ISMInstanceInfo, TArrayView< const float > CustomDataFloats)
 
bool BatchUpdateInstancesTransforms (FISMPool &ISMPool, FMeshId MeshId, int32 StartInstanceIndex, TArrayView< const FTransform > NewInstancesTransforms, bool bWorldSpace, bool bMarkRenderStateDirty, bool bTeleport)
 
void BatchUpdateInstanceCustomData (FISMPool &ISMPool, int32 CustomFloatIndex, float CustomFloatValue)
 
void RemoveAllMeshes (FISMPool &ISMPool)
 

Public Attributes

TArray< FISMPoolMeshInfoMeshInfos
 
bool bAllowPerInstanceRemoval = false
 

Detailed Description

A mesh group which is a collection of meshes and their related FISMPoolMeshInfo. We group these with a single handle with the expectation that a client will want to own multiple meshs and release them together.

Member Typedef Documentation

◆ FMeshId

Member Function Documentation

◆ AddMesh()

FISMPoolMeshGroup::FMeshId FISMPoolMeshGroup::AddMesh ( const FISMPoolStaticMeshInstance MeshInstance,
int32  InstanceCount,
const FISMPoolMeshInfo ISMInstanceInfo,
TArrayView< const float CustomDataFloats 
)

Adds a new mesh with instance count. We expect to only add a unique mesh instance once to each group. Returns a ID that can be used to update the instances.

◆ BatchUpdateInstanceCustomData()

void FISMPoolMeshGroup::BatchUpdateInstanceCustomData ( FISMPool ISMPool,
int32  CustomFloatIndex,
float  CustomFloatValue 
)

◆ BatchUpdateInstancesTransforms()

bool FISMPoolMeshGroup::BatchUpdateInstancesTransforms ( FISMPool ISMPool,
FMeshId  MeshId,
int32  StartInstanceIndex,
TArrayView< const FTransform NewInstancesTransforms,
bool  bWorldSpace,
bool  bMarkRenderStateDirty,
bool  bTeleport 
)

Update instance transforms for a group of instances.

◆ RemoveAllMeshes()

void FISMPoolMeshGroup::RemoveAllMeshes ( FISMPool ISMPool)

Remove all of our managed meshes and associated instances.

Member Data Documentation

◆ bAllowPerInstanceRemoval

bool FISMPoolMeshGroup::bAllowPerInstanceRemoval = false

Flag for whether we allow removal of instances when transform scale is set to zero.

◆ MeshInfos

TArray<FISMPoolMeshInfo> FISMPoolMeshGroup::MeshInfos

Array of allocated mesh infos.


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