IEditorModeFactory | Unreal Engine 5.4 Documentation

Inheritance Hierarchy

References


Module	UnrealEd
Header	/Engine/Source/Editor/UnrealEd/Public/EditorModeRegistry.h
Include	#include "EditorModeRegistry.h"

Syntax

struct IEditorModeFactory : public TSharedFromThis< IEditorModeFactory >

Remarks

Class responsible for maintaining a list of registered editor mode types.

Example usage:

Register your mode type with: FEditorModeRegistry::Get().RegisterMode( FName( TEXT("MyEditorMode") ) ); or: class FMyEditorModeFactory : public IEditorModeFactory { virtual void OnSelectionChanged( FEditorModeTools& Tools, UObject* ItemUndergoingChange ) const override; virtual FEditorModeInfo GetModeInfo() const override; virtual TSharedRef CreateMode() const override; }; TSharedRef Factory = MakeShareable( new FMyEditorModeFactory ); FEditorModeRegistry::Get().RegisterMode( FName( TEXT("MyEditorMode") ), Factory );

Unregister your mode when it is no longer available like so (this will prompt the destruction of any existing modes of this type): FEditorModeRegistry::Get().UnregisterMode( FName( TEXT("MyEditorMode") ) );

Destructors

	Type	Name	Description
		~IEditorModeFactory ()	Virtual destructor

Functions

Type	Name	Description
TSharedRef< FEdMode >	CreateMode ()	Create a new instance of our mode
FEditorModeInfo	GetModeInfo ()	Gets the information pertaining to the mode type that this factory creates
void	OnSelectionChanged ( FEditorModeTools& Tools, UObject* ItemUndergoingChange )	Allows mode factories to handle selection change events, and potentially activate/deactivate modes