Skip to content

ISMPreviewEditorModule

Module: SMPreviewEditor

#include <ISMPreviewEditorModule.h>

Inherits from IModuleInterface

Description

class ISMPreviewEditorModule;

The public interface to this module

Public Functions

Name
ISMPreviewEditorModule & Get()
bool IsAvailable()
virtual TSharedPtr< FExtensibilityManager > GetMenuExtensibilityManager() const =0
virtual TSharedPtr< FExtensibilityManager > GetToolBarExtensibilityManager() const =0
virtual USMPreviewObject * CreatePreviewObject(UObject * Outer) =0
virtual USMPreviewObject * RecreatePreviewObject(USMPreviewObject * OriginalPreviewObject) =0
virtual void StartPreviewSimulation(USMBlueprint * StateMachineBlueprint) =0
virtual bool CanStartPreviewSimulation(USMBlueprint * StateMachineBlueprint) =0
virtual void StopPreviewSimulation(USMBlueprint * StateMachineBlueprint) =0
virtual bool IsPreviewRunning(USMBlueprint * StateMachineBlueprint) =0
virtual void DeleteSelection(TWeakPtr< FSMStateMachineBlueprintEditor > InBlueprintEditor) =0
virtual TSharedRef< SWidget > CreatePreviewEditorWidget(TWeakPtr< FSMStateMachineBlueprintEditor > InBlueprintEditor, const FName & InTabID) =0
virtual TSharedRef< SWidget > CreatePreviewViewportWidget(TWeakPtr< FSMStateMachineBlueprintEditor > InBlueprintEditor) =0
virtual TSharedRef< SWidget > CreateAdvancedSceneDetailsWidget(TWeakPtr< FSMStateMachineBlueprintEditor > InBlueprintEditor, TSharedPtr< SWidget > InViewportWidget) =0

Public Functions Documentation

function Get

static inline ISMPreviewEditorModule & Get()

Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.

Return: Returns singleton instance, loading the module on demand if needed

function IsAvailable

static inline bool IsAvailable()

Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.

Return: True if the module is loaded and ready to use

function GetMenuExtensibilityManager

virtual TSharedPtr< FExtensibilityManager > GetMenuExtensibilityManager() const =0

function GetToolBarExtensibilityManager

virtual TSharedPtr< FExtensibilityManager > GetToolBarExtensibilityManager() const =0

function CreatePreviewObject

virtual USMPreviewObject * CreatePreviewObject(
    UObject * Outer
) =0

function RecreatePreviewObject

virtual USMPreviewObject * RecreatePreviewObject(
    USMPreviewObject * OriginalPreviewObject
) =0

function StartPreviewSimulation

virtual void StartPreviewSimulation(
    USMBlueprint * StateMachineBlueprint
) =0

function CanStartPreviewSimulation

virtual bool CanStartPreviewSimulation(
    USMBlueprint * StateMachineBlueprint
) =0

function StopPreviewSimulation

virtual void StopPreviewSimulation(
    USMBlueprint * StateMachineBlueprint
) =0

function IsPreviewRunning

virtual bool IsPreviewRunning(
    USMBlueprint * StateMachineBlueprint
) =0

function DeleteSelection

virtual void DeleteSelection(
    TWeakPtr< FSMStateMachineBlueprintEditor > InBlueprintEditor
) =0

Deletes the current selection from preview.

function CreatePreviewEditorWidget

virtual TSharedRef< SWidget > CreatePreviewEditorWidget(
    TWeakPtr< FSMStateMachineBlueprintEditor > InBlueprintEditor,
    const FName & InTabID
) =0

function CreatePreviewViewportWidget

virtual TSharedRef< SWidget > CreatePreviewViewportWidget(
    TWeakPtr< FSMStateMachineBlueprintEditor > InBlueprintEditor
) =0

function CreateAdvancedSceneDetailsWidget

virtual TSharedRef< SWidget > CreateAdvancedSceneDetailsWidget(
    TWeakPtr< FSMStateMachineBlueprintEditor > InBlueprintEditor,
    TSharedPtr< SWidget > InViewportWidget
) =0