FArticyGvEditor Class Reference

Editor class for managing and editing Articy Global Variables. More...

#include <ArticyGVEditor.h>

Inheritance diagram for FArticyGvEditor:

Public Member Functions
virtual	~FArticyGvEditor () override
	Destructor for FArticyGVEditor.
void	InitArticyGvEditor (const EToolkitMode::Type Mode, const TSharedPtr< IToolkitHost > &InitToolkitHost, UArticyGlobalVariables *ObjectToEdit)
	Initializes the Articy Global Variables editor.
virtual void	AddReferencedObjects (FReferenceCollector &Collector) override
	Adds referenced objects to the garbage collector.
virtual FLinearColor	GetWorldCentricTabColorScale () const override
	Gets the color scale for world-centric tabs.
virtual FName	GetToolkitFName () const override
	Gets the toolkit's FName identifier.
virtual FText	GetBaseToolkitName () const override
	Gets the base toolkit name.
virtual FString	GetWorldCentricTabPrefix () const override
	Gets the prefix for world-centric tab titles.
virtual void	RegisterTabSpawners (const TSharedRef< FTabManager > &TabManager) override
	Registers tab spawners for the editor.
virtual FString	GetReferencerName () const override
	Gets the referencer name for the editor.

Detailed Description

Editor class for managing and editing Articy Global Variables.

This class provides an editor interface for editing Articy Global Variables within Unreal Engine.

Constructor & Destructor Documentation

~FArticyGvEditor()

FArticyGvEditor::~FArticyGvEditor ( )

overridevirtual

Destructor for FArticyGVEditor.

Destructor for FArticyGVEditor.

This destructor unregisters the editor from the undo system.

Member Function Documentation

AddReferencedObjects()

void FArticyGvEditor::AddReferencedObjects ( FReferenceCollector & Collector )

overridevirtual

Adds referenced objects to the garbage collector.

FGCObject Interface

This function is called to ensure that referenced objects are not garbage collected while the editor is active.

Parameters

Collector

The reference collector.

GetBaseToolkitName()

FText FArticyGvEditor::GetBaseToolkitName ( ) const

overridevirtual

Gets the base toolkit name.

Returns

The base name of the toolkit.

GetReferencerName()

FString FArticyGvEditor::GetReferencerName ( ) const

overridevirtual

Gets the referencer name for the editor.

Returns

The referencer name.

GetToolkitFName()

FName FArticyGvEditor::GetToolkitFName ( ) const

overridevirtual

Gets the toolkit's FName identifier.

FAssetEditorToolkit Interface

Returns

The FName identifier for the toolkit.

GetWorldCentricTabColorScale()

FLinearColor FArticyGvEditor::GetWorldCentricTabColorScale ( ) const

overridevirtual

Gets the color scale for world-centric tabs.

IToolkit Interface

Returns

The color scale used for world-centric tabs.

GetWorldCentricTabPrefix()

FString FArticyGvEditor::GetWorldCentricTabPrefix ( ) const

overridevirtual

Gets the prefix for world-centric tab titles.

Returns

The prefix for world-centric tab titles.

InitArticyGvEditor()

void FArticyGvEditor::InitArticyGvEditor	(	const EToolkitMode::Type	Mode,
		const TSharedPtr< IToolkitHost > &	InitToolkitHost,
		UArticyGlobalVariables *	ObjectToEdit )

Initializes the Articy Global Variables editor.

Parameters

Mode	The toolkit mode (standalone or world-centric).
InitToolkitHost	The toolkit host for integration.
ObjectToEdit	The ArticyGlobalVariables object to be edited.

This function sets up the editor for editing Articy Global Variables, including registering undo capabilities and initializing the editor layout.

Parameters

Mode	The toolkit mode (standalone or world-centric).
InitToolkitHost	The toolkit host for integration.
ObjectToEdit	The ArticyGlobalVariables object to be edited.

RegisterTabSpawners()

void FArticyGvEditor::RegisterTabSpawners ( const TSharedRef< FTabManager > & InTabManager )

overridevirtual

Registers tab spawners for the editor.

This function registers the tabs that can be spawned by the editor, such as the Details tab.

Parameters

InTabManager

The tab manager for registering tab spawners.

---

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

• Source/ArticyEditor/Public/Customizations/ArticyGVEditor.h
• Source/ArticyEditor/Private/Customizations/ArticyGVEditor.cpp