Navigation
API > API/Runtime > API/Runtime/Engine
Mapping between the instance ID used by typed elements and the corresponding instance index on the ISM components. This mapping will be kept up-to-date via the add/remove operations of the ISM components, as well as undo/redo.
| Name | FSMInstanceElementIdMap |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/Elements/SMInstance/SMInstanceElementId.h |
| Include Path | #include "Elements/SMInstance/SMInstanceElementId.h" |
Syntax
class FSMInstanceElementIdMap : public FGCObject
Inheritance Hierarchy
- FGCObject → FSMInstanceElementIdMap
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FSMInstanceElementIdMap() |
Elements/SMInstance/SMInstanceElementId.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnInstancePreRemoval | TMulticastDelegate_TwoParams< void, const FSMInstanceElementId &, int32 > | Delegate called when a static mesh instance is about to be removed from the instances array on its component, and the associated ID for a SMInstance element will be unmapped. | Elements/SMInstance/SMInstanceElementId.h |
| FOnInstanceRemapped | TMulticastDelegate_ThreeParams< void, const FSMInstanceElementId &, int32, int32 > | Delegate called when a static mesh instance has been relocated within the instances array on its component (eg, because another instance was removed or added to the array). | Elements/SMInstance/SMInstanceElementId.h |
| FOnInstanceRemoved | TMulticastDelegate_TwoParams< void, const FSMInstanceElementId &, int32 > | Delegate called when a static mesh instance has been removed from the instances array on its component, and the associated ID for a SMInstance element has been unmapped. | Elements/SMInstance/SMInstanceElementId.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ISMComponents | TMap< UInstancedStaticMeshComponent *, TSharedPtr< FSMInstanceElementIdMapEntry > > | Elements/SMInstance/SMInstanceElementId.h | ||
| ISMComponentsCS | FCriticalSection | Elements/SMInstance/SMInstanceElementId.h | ||
| OnInstanceIndexUpdatedHandle | FDelegateHandle | Elements/SMInstance/SMInstanceElementId.h | ||
| OnInstancePreRemovalDelegate | FOnInstancePreRemoval | Elements/SMInstance/SMInstanceElementId.h | ||
| OnInstanceRemappedDelegate | FOnInstanceRemapped | Elements/SMInstance/SMInstanceElementId.h | ||
| OnInstanceRemovedDelegate | FOnInstanceRemoved | Elements/SMInstance/SMInstanceElementId.h | ||
| OnObjectModifiedHandle | FDelegateHandle | Elements/SMInstance/SMInstanceElementId.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSMInstanceElementId GetSMInstanceElementIdFromSMInstanceId
(
const FSMInstanceId& InSMInstanceId, |
Given a FSMInstanceId, attempt to convert it into a FSMInstanceElementId. | Elements/SMInstance/SMInstanceElementId.h | |
TArray< FSMInstanceElementId > GetSMInstanceElementIdsForComponent
(
UInstancedStaticMeshComponent* InComponent |
Given an ISM component, get all FSMInstanceElementId values that are currently mapped for it. | Elements/SMInstance/SMInstanceElementId.h | |
FSMInstanceId GetSMInstanceIdFromSMInstanceElementId
(
const FSMInstanceElementId& InSMInstanceElementId |
Given a FSMInstanceElementId, attempt to convert it into a FSMInstanceId. | Elements/SMInstance/SMInstanceElementId.h | |
void OnComponentReplaced
(
UInstancedStaticMeshComponent* InOldComponent, |
Called when one ISM component is replaced with another, and attempts to copy the ID mapping of the old component to the new. | Elements/SMInstance/SMInstanceElementId.h | |
FOnInstancePreRemoval & OnInstancePreRemoval() |
Elements/SMInstance/SMInstanceElementId.h | ||
FOnInstanceRemapped & OnInstanceRemapped() |
Elements/SMInstance/SMInstanceElementId.h | ||
FOnInstanceRemoved & OnInstanceRemoved() |
Elements/SMInstance/SMInstanceElementId.h | ||
void SerializeIdMappings
(
FSMInstanceElementIdMapEntry* InEntry, |
Elements/SMInstance/SMInstanceElementId.h |
Overridden from FGCObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
Elements/SMInstance/SMInstanceElementId.h | ||
virtual FString GetReferencerName() |
Elements/SMInstance/SMInstanceElementId.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FSMInstanceElementIdMap & Get() |
Elements/SMInstance/SMInstanceElementId.h |