FToolElementRegistry | Unreal Engine 5.6 Documentation

A Registry for FToolElements, where the FToolElements will generate the UI for a certain tool


Name	FToolElementRegistry
Type	class
Header File	/Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h
Include Path	#include "ToolElementRegistry.h"

Syntax

class FToolElementRegistry

Name	Remarks	Include Path	Unreal Specifiers
FToolElementRegistry()		ToolElementRegistry.h

Name	Type	Remarks	Include Path	Unreal Specifiers
ToolElementKeyToToolElementMap	TMap< FString, TSharedPtr< FToolElement > >	The Map of tool element Key to tool element	ToolElementRegistry.h

Name	Remarks	Include Path
TSharedRef< SWidget > GenerateWidget ( TSharedRef< FToolElementRegistrationKey > ToolElementKeySR, TSharedPtr< FToolElementRegistrationArgs > RegistrationArgsSP, bool bUpdateRegistrationArgs )	Generates the widget for the tool element denoted by the FToolElementRegistrationKey, using the specified TSharedPtr if provided (otherwise it will use the default registered registration arguments. If bUpdateRegistrationArgs is set to true and RegistrationArgsSP is not nullptr, the specified registration args will replace the existing ones for the tool element.	ToolElementRegistry.h
TSharedPtr< FToolElement > GetToolElementSP ( FToolElementRegistrationKey& ToolElementKey )	Gets the TSharedPtr for the given FToolElementRegistrationKey& tool element key	ToolElementRegistry.h
void RegisterElement ( const TSharedRef< FToolElement > ToolElement )	Registers the FToolElement ToolElement	ToolElementRegistry.h
void UnregisterElement ( const TSharedRef< FToolElement > ToolElement )	Unregisters the FToolElement ToolElement	ToolElementRegistry.h

Name	Remarks	Include Path	Unreal Specifiers
static FToolElementRegistry & Get()		ToolElementRegistry.h