FMLDeformerEditorModelRegistry | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/MLDeformerFrameworkEditor

The editor model registry, which keeps track of different types of runtime ML Deformer models and their related editor models. When you create a new ML Deformer model type, you register it to this registry using the RegisterEditorModel method. You typically do this in your editor module's StartupModule method. And you unregister it again in the editor module's ShutdownModule method. Models can have priorities. The one model with the highest priority level will be the model that is created by default when creating a new ML Deformer asset.


Name	FMLDeformerEditorModelRegistry
Type	class
Header File	/Engine/Plugins/Animation/MLDeformer/MLDeformerFramework/Source/MLDeformerFrameworkEditor/Public/MLDeformerModelRegistry.h
Include Path	#include "MLDeformerModelRegistry.h"

Syntax

class FMLDeformerEditorModelRegistry

Destructors

Name	Remarks	Include Path	Unreal Specifiers
~FMLDeformerEditorModelRegistry()		MLDeformerModelRegistry.h

Variables

Protected

Name	Type	Remarks	Include Path
HighestPriorityModelType	UClass *	The registered model type that has the highest priority level.	MLDeformerModelRegistry.h
InstanceMap	TMap< UMLDeformerModel , FMLDeformerEditorModel >	A map of runtime model instances, and the related editor models.	MLDeformerModelRegistry.h
Map	TMap< UClass *, FOnGetEditorModelInstance >	A map that maps runtime model types with a function that creates its editor model.	MLDeformerModelRegistry.h
ModelPriorities	TMap< UClass *, int32 >	The map of model type priority levels.	MLDeformerModelRegistry.h

Functions

Public

Name	Remarks	Include Path
FMLDeformerEditorModel * GetEditorModel ( UMLDeformerModel* Model )	Get the editor model related to a given runtime model.	MLDeformerModelRegistry.h
UClass * GetHighestPriorityModel ()	Get the highest priority runtime model class.	MLDeformerModelRegistry.h
int32 GetHighestPriorityModelIndex ()	Get the highest priority model index into the map.	MLDeformerModelRegistry.h
const TMap< UMLDeformerModel , FMLDeformerEditorModel > & GetModelInstances()	Get the read-only map that maps instanced models with their editor models.	MLDeformerModelRegistry.h
int32 GetNumInstancedModels()	Get the number of instanced models.	MLDeformerModelRegistry.h
int32 GetNumRegisteredModels()	Get the number of registered models.	MLDeformerModelRegistry.h
int32 GetPriorityForModel ( UClass* ModelType ) const	Get the priority level for a given runtime model type.	MLDeformerModelRegistry.h
const TMap< UClass *, FOnGetEditorModelInstance > & GetRegisteredModels()	Get the read-only map of registered models.	MLDeformerModelRegistry.h
void RegisterEditorModel ( UClass* ModelType, FOnGetEditorModelInstance Delegate, int32 ModelPriority )	Register a new model.	MLDeformerModelRegistry.h
void UnregisterEditorModel ( const UClass* ModelType )	Unregister the editor model. Call this method in your editor module's ShutdownModule call.	MLDeformerModelRegistry.h