1. Epic GamesDeveloper
  3. FMetaHumanToolkitBase

FMetaHumanToolkitBase

A base toolkit class with common functionality of the MetaHuman asset editors.

API > API/Plugins > API/Plugins/MetaHumanToolkit

A base toolkit class with common functionality of the MetaHuman asset editors. FMetaHumanToolkitBase provides a toolkit with with a details panel, sequencer and viewport. The viewport has AB capabilities by default with a post process component already in the scene to control exactly how the viewport behaves. Derived classes have the option to provide an extra widget to be displayed in the bottom of the viewport as well as extra entries to the AB view menus to control the visibility of components displayed in the viewport.

   
Name FMetaHumanToolkitBase
Type class
Header File /Engine/Plugins/MetaHuman/MetaHumanAnimator/Source/MetaHumanToolkit/Public/MetaHumanToolkitBase.h
Include Path #include "MetaHumanToolkitBase.h"

Syntax

class FMetaHumanToolkitBase :  
    public FBaseAssetToolkit ,  
    public FGCObject ,  
    public FNotifyHook ,  
    public FSelfRegisteringEditorUndoClient

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FMetaHumanToolkitBase ( UAssetEditor* InOwningAssetEditor
)

   MetaHumanToolkitBase.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FMetaHumanToolkitBase()

   MetaHumanToolkitBase.h  

Enums

Protected

Name Remarks
EMediaTrackType  

Constants

Name Type Remarks Include Path
PreviewSettingsTabId const FName The name of the preview settings tab MetaHumanToolkitBase.h
TimelineTabId const FName The name of the sequencer tab MetaHumanToolkitBase.h

Functions

Public

Overridden from FBaseAssetToolkit

Name Remarks Include Path Unreal Specifiers

virtual void CreateWidgets()

   MetaHumanToolkitBase.h  

Overridden from FAssetEditorToolkit

Name Remarks Include Path Unreal Specifiers

virtual void PostInitAssetEditor()

   MetaHumanToolkitBase.h  

Overridden from IAssetEditorInstance

Name Remarks Include Path Unreal Specifiers

virtual bool IsPrimaryEditor()

   MetaHumanToolkitBase.h  

Overridden from IToolkit

Name Remarks Include Path Unreal Specifiers

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

   MetaHumanToolkitBase.h  

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

   MetaHumanToolkitBase.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& InCollector
)

   MetaHumanToolkitBase.h  

virtual FString GetReferencerName()

   MetaHumanToolkitBase.h  

Overridden from FNotifyHook

Name Remarks Include Path Unreal Specifiers

virtual void NotifyPostChange ( const FPropertyChangedEvent& InPropertyChangedEvent,
FProperty* InPropertyThatChanged
)

   MetaHumanToolkitBase.h  

Overridden from FEditorUndoClient

Name Remarks Include Path Unreal Specifiers

virtual void PostRedo ( bool bInSuccess
)

   MetaHumanToolkitBase.h  

virtual void PostUndo ( bool bInSuccess
)

   MetaHumanToolkitBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void BindCommands()

 Override to bind commands that are specific to a MetaHuman toolkit MetaHumanToolkitBase.h  

bool ChannelContainsKey ( UMetaHumanMovieSceneMediaTrack* InMediaTrack,
const FFrameNumber& InFrameTime
) const

 Returns true if the given media track has a key in the given frame time MetaHumanToolkitBase.h  

void ClearMediaTracks()

 Removes all media tracks from sequencer MetaHumanToolkitBase.h  

void CreateDepthMeshComponent ( UCameraCalibration* InCameraCalibration
)

 Creates the depth mesh visualization component using the information from the given camera calibration MetaHumanToolkitBase.h  

void DestroyDepthMeshComponent()

 Destroys the depth mesh component MetaHumanToolkitBase.h  

FFrameNumber GetCurrentFrameNumber()

 Returns the current frame number in sequencer MetaHumanToolkitBase.h  

TRange< int32 > GetSequencerPlaybackRange()

 Get the current sequencer playback range MetaHumanToolkitBase.h  

virtual TSharedRef< SWidget > GetViewportExtraContentWidget()

 Override to return a extra widget to be displayed in the bottom of the viewport MetaHumanToolkitBase.h  

virtual void HandleDepthMapVisibilityChanged ( bool bInDepthMapVisibility
)

 Called when mesh depth map visibility changes. MetaHumanToolkitBase.h  

void HandleDepthMeshMaterialCompiled ( UMaterialInterface* InMaterialInterface
)

 Called when depth mesh material is compiled. Used to invalidate the scene capture components MetaHumanToolkitBase.h  

virtual void HandleFootageDepthDataChanged ( float InNear,
float InFar
)

 Called when footage depth data changes. MetaHumanToolkitBase.h  

virtual void HandleGetViewABMenuContents ( EABImageViewMode InViewMode,
FMenuBuilder& InMenuBuilder
)

 Override to customize the menus to control the visibility of components in the views A and B MetaHumanToolkitBase.h  

void HandleMapChanged ( UWorld* InNewWorld,
EMapChangeType InMapChangeType
)

 Called when level is changed MetaHumanToolkitBase.h  

virtual void HandleMeshDepthDataChanged ( float InNear,
float InFar
)

 Called when mesh depth data changes. MetaHumanToolkitBase.h  

virtual void HandleSequencerGlobalTimeChanged()

 Called when the global time in sequencer changes MetaHumanToolkitBase.h  

virtual void HandleSequencerKeyAdded ( FMovieSceneChannel* InChannel,
const TArray< struct FKeyAddOrDeleteEventItem >& InItems
)

 Called when a key is added through the sequencer UI MetaHumanToolkitBase.h  

virtual void HandleSequencerKeyRemoved ( FMovieSceneChannel* InChannel,
const TArray< struct FKeyAddOrDeleteEventItem >& InItems
)

 Called when a key is removed from the sequencer UI MetaHumanToolkitBase.h  

virtual void HandleSequencerMovieSceneDataChanged ( enum class EMovieSceneDataChangeType InDataChangeType
)

 Called when sequencer triggers a movie scene data changed event MetaHumanToolkitBase.h  

virtual void HandleUndoOrRedoTransaction ( const FTransaction* InTransaction
)

 Handles an Undo or Redo transaction. The base implementation does nothing by default MetaHumanToolkitBase.h  

virtual bool IsTimelineEnabled()

 Override to control if timeline widget is enabled MetaHumanToolkitBase.h  

void SetDepthMeshTexture ( UTexture* InDepthTexture
)

 Uses the given texture as input for the depth mesh component MetaHumanToolkitBase.h  

void SetMediaTrack ( TSubclassOf< class UMovieSceneAudioTrack > InTrackClass,
USoundBase* InAudio,
FTimecode InTimecode,
FFrameNumber InStartFrameOffset
)

   MetaHumanToolkitBase.h  

void SetMediaTrack ( EMediaTrackType InTrackType,
TSubclassOf< class UMetaHumanMovieSceneMediaTrack > InTrackClass,
UImgMediaSource* InImageSequence,
FTimecode InTimecode,
FFrameNumber InStartFrameOffset
)

 Set or create a media track with the given image sequence MetaHumanToolkitBase.h  

TSharedRef< SDockTab > SpawnTab_PreviewSettings ( const FSpawnTabArgs& InArgs
)

   MetaHumanToolkitBase.h  

TSharedRef< SDockTab > SpawnTab_Sequencer ( const FSpawnTabArgs& InArgs
)

 Spawns the sequencer tab MetaHumanToolkitBase.h  

Overridden from FBaseAssetToolkit

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< FEditorViewportClient > CreateEditorViewportClient()

   MetaHumanToolkitBase.h  

virtual AssetEditorViewportFactoryFunction GetViewportDelegate()

   MetaHumanToolkitBase.h  

virtual TSharedRef< SDockTab > SpawnTab_Details ( const FSpawnTabArgs& InArgs
)

   MetaHumanToolkitBase.h  

virtual TSharedRef< SDockTab > SpawnTab_Viewport ( const FSpawnTabArgs& InArgs
)

   MetaHumanToolkitBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page