1. Epic GamesDeveloper
  3. FMLDeformerEditorToolkit

FMLDeformerEditorToolkit

The ML Deformer asset editor toolkit.

API > API/Plugins > API/Plugins/MLDeformerFrameworkEditor

The ML Deformer asset editor toolkit. This is the editor that opens when you double click an ML Deformer asset.

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

Syntax

class FMLDeformerEditorToolkit :  
    public FPersonaAssetEditorToolkit,  
    public IHasPersonaToolkit,  
    public FGCObject ,  
    public FEditorUndoClient,  
    public FTickableEditorObject

Inheritance Hierarchy

Implements Interfaces

Destructors

Name Remarks Include Path Unreal Specifiers

~FMLDeformerEditorToolkit()

   MLDeformerEditorToolkit.h  

Constants

Name Type Remarks Include Path
ExtendersMutex FCriticalSection Mutex for adding extenders MLDeformerEditorToolkit.h
ToolsMenuExtenders TArray< TUniquePtr< FToolsMenuExtender > > Extenders for Tools menu MLDeformerEditorToolkit.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveModel TSharedPtr< FMLDeformerEditorModel > The currently active editor model. MLDeformerEditorToolkit.h  
ApplicationMode FMLDeformerApplicationMode * The active application mode. MLDeformerEditorToolkit.h  
bIsInitialized bool Has the asset editor been initialized? MLDeformerEditorToolkit.h  
bIsTraining bool Are we currently in a training process? MLDeformerEditorToolkit.h  
bNeedsPaintModeDisable bool When set to true, the paint mode will be disabled automatically. MLDeformerEditorToolkit.h  
DebugWidget TSharedPtr< SMLDeformerDebugSelectionWidget > The widget where you select which actor to debug. MLDeformerEditorToolkit.h  
DeformerAsset TObjectPtr< UMLDeformerAsset > The ML Deformer Asset. MLDeformerEditorToolkit.h  
ModelDetailsView TSharedPtr< IDetailsView > Model details view. MLDeformerEditorToolkit.h  
PersonaToolkit TSharedPtr< IPersonaToolkit > The persona toolkit. MLDeformerEditorToolkit.h  
PersonaViewport TSharedPtr< IPersonaViewport > Persona viewport. MLDeformerEditorToolkit.h  
TimeSlider TSharedPtr< SMLDeformerTimeline > The timeline slider widget. MLDeformerEditorToolkit.h  
VizSettingsDetailsView TSharedPtr< IDetailsView > Model viz settings details view. MLDeformerEditorToolkit.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddViewportOverlayWidget ( TSharedRef< SWidget > InViewportOverlayWidget,
int32 ZOrder
)

   MLDeformerEditorToolkit.h  

double CalcTimelinePosition()

   MLDeformerEditorToolkit.h  

void DisablePaintMode()

   MLDeformerEditorToolkit.h  

void EnablePaintMode()

   MLDeformerEditorToolkit.h  
  MLDeformerEditorToolkit.h  
  MLDeformerEditorToolkit.h  

TWeakPtr< FMLDeformerEditorModel > GetActiveModelPointer()

   MLDeformerEditorToolkit.h  

FMLDeformerApplicationMode * GetApplicationMode()

   MLDeformerEditorToolkit.h  

virtual FText GetBaseToolkitName()

   MLDeformerEditorToolkit.h  

AActor * GetDebugActor()

 Get the actor we want to debug, if any. Returns a nullptr when we don't want to debug anything. MLDeformerEditorToolkit.h  
Get the component space transforms of the actor we want to debug. MLDeformerEditorToolkit.h  

TSharedPtr< SMLDeformerDebugSelectionWidget > GetDebugWidget()

   MLDeformerEditorToolkit.h  

UMLDeformerAsset * GetDeformerAsset()

   MLDeformerEditorToolkit.h  

IDetailsView * GetModelDetailsView()

   MLDeformerEditorToolkit.h  

virtual TSharedRef< IPersonaToolkit > GetPersonaToolkit()

   MLDeformerEditorToolkit.h  

IPersonaToolkit * GetPersonaToolkitPointer()

   MLDeformerEditorToolkit.h  

virtual TStatId GetStatId()

   MLDeformerEditorToolkit.h  

virtual ETickableTickType GetTickableTickType()

   MLDeformerEditorToolkit.h  

SMLDeformerTimeline * GetTimeSlider()

   MLDeformerEditorToolkit.h  

virtual FName GetToolkitFName()

   MLDeformerEditorToolkit.h  

virtual FText GetToolkitName()

   MLDeformerEditorToolkit.h  

TSharedPtr< IPersonaViewport > GetViewport()

   MLDeformerEditorToolkit.h  

IDetailsView * GetVizSettingsDetailsView()

   MLDeformerEditorToolkit.h  

virtual FLinearColor GetWorldCentricTabColorScale()

   MLDeformerEditorToolkit.h  

virtual FString GetWorldCentricTabPrefix()

   MLDeformerEditorToolkit.h  

void InitAssetEditor ( const EToolkitMode::Type Mode,
const TSharedPtr< IToolkitHost >& InitToolkitHost,
UMLDeformerAsset* InDeformerAsset
)

 Initialize the asset editor. This will register the application mode, init the preview scene, etc. MLDeformerEditorToolkit.h  

bool IsDefaultModeActive()

   MLDeformerEditorToolkit.h  

bool IsInitialized()

   MLDeformerEditorToolkit.h  

bool IsPaintModeActive()

   MLDeformerEditorToolkit.h  

bool IsTrainButtonEnabled()

   MLDeformerEditorToolkit.h  

bool IsTraining()

   MLDeformerEditorToolkit.h  

void OnTimeSliderScrubPositionChanged ( double NewScrubTime,
bool bIsScrubbing
)

   MLDeformerEditorToolkit.h  

void PostRedo ( bool bSuccess
)

   MLDeformerEditorToolkit.h  

void PostUndo ( bool bSuccess
)

   MLDeformerEditorToolkit.h  

virtual void RegisterTabSpawners ( const TSharedRef< FTabManager >& InTabManager
)

   MLDeformerEditorToolkit.h  

virtual void RemoveViewportOverlayWidget ( TSharedRef< SWidget > InViewportOverlayWidget
)

   MLDeformerEditorToolkit.h  

void SetNeedsPaintModeDisable ( bool bNeedsDisable
)

   MLDeformerEditorToolkit.h  

void SetTimeSlider ( TSharedPtr< SMLDeformerTimeline > InTimeSlider
)

   MLDeformerEditorToolkit.h  

void SetTimeSliderRange ( double StartTime,
double EndTime
)

   MLDeformerEditorToolkit.h  

void SetVizSettingsDetailsView ( TSharedPtr< IDetailsView > InDetailsView
)

   MLDeformerEditorToolkit.h  

bool SwitchModelType ( UClass* ModelType,
bool bForceChange
)

 Switch the editor to a given model type. MLDeformerEditorToolkit.h  

void SwitchVizMode ( EMLDeformerVizMode Mode
)

 Switch the editor's visualization mode. MLDeformerEditorToolkit.h  

virtual void Tick ( float DeltaTime
)

   MLDeformerEditorToolkit.h  

bool Train ( bool bSuppressDialogs
)

   MLDeformerEditorToolkit.h  

virtual void UnregisterTabSpawners ( const TSharedRef< FTabManager >& InTabManager
)

   MLDeformerEditorToolkit.h  

void UpdateTimeSliderRange()

   MLDeformerEditorToolkit.h  

void ZoomOnActors()

   MLDeformerEditorToolkit.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   MLDeformerEditorToolkit.h  

virtual FString GetReferencerName()

   MLDeformerEditorToolkit.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddToolsMenuExtender ( TUniquePtr< FToolsMenuExtender > Extender
)

   MLDeformerEditorToolkit.h  

static TConstArrayView< TUniquePtr< FToolsMenuExtender > > GetToolsMenuExtenders()

   MLDeformerEditorToolkit.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page