Navigation
API > API/Plugins > API/Plugins/RigVMEditor > API/Plugins/RigVMEditor/Editor
Inheritance Hierarchy
- IBlueprintEditor
- FGCObject
- FNotifyHook
- FTickableEditorObject
- FEditorUndoClient
- FNoncopyable
- FBlueprintEditor
- FRigVMEditor
- IControlRigEditor
References
| Module | RigVMEditor |
| Header | /Engine/Plugins/Runtime/RigVM/Source/RigVMEditor/Public/Editor/RigVMEditor.h |
| Include | #include "Editor/RigVMEditor.h" |
Syntax
class FRigVMEditor : public FBlueprintEditor
Variables
| Type | Name | Description | |
|---|---|---|---|
| URigVMController * | ActiveController | ||
| TArray< FName > | LastEventQueue | ||
| TSharedPtr< FExtender > | MenuExtender | The extender to pass to the level editor to extend it's window menu | |
| FDelegateHandle | PropertyChangedHandle | ||
| TSharedPtr< FExtender > | ToolbarExtender | Toolbar extender |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FRigVMEditor () |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | BindCommands () |
||
| void | Update the name lists for use in name combo boxes | ||
| bool | |||
| bool | CanHideItem () |
||
| void | ClearDetailObject
(
bool bChangeUISelectionState |
||
| void | |||
| TSharedPtr< FApplicationMode > | |||
| void | CreateEmptyGraphContent
(
URigVMController* InController |
Allows the editor to fill an empty graph | |
| bool | |||
| bool | |||
| bool | DetailViewShowsStruct
(
UScriptStruct* InStruct |
||
| void | ExtendMenu () |
Extend menu | |
| void | Extend toolbar | ||
| void | FillToolbar
(
FToolBarBuilder& ToolbarBuilder, |
Fill the toolbar with content | |
| void | |||
| void | GenerateEventQueueMenuContent
(
FMenuBuilder& MenuBuilder |
||
| TSharedRef< SWidget > | |||
| TSharedRef< SWidget > | |||
| TArray< FName > | |||
| UClass * | Returns the class to use for detail wrapper objects (UI shim layer) | ||
| const FName | |||
| const FName | |||
| TArray< FName > | |||
| int32 | |||
| FSlateIcon | GetEventQueueIcon
(
const TArray< FName >& InEventQueue |
||
| FSlateIcon | |||
| FText | |||
| int32 | |||
| FSlateIcon | GetExecutionModeIcon
(
const ERigVMEditorExecutionModeType InExecutionMode |
||
| FSlateIcon | |||
| FText | |||
| URigVMController * | |||
| URigVMGraph * | |||
| TSharedPtr< SGraphEditor > | GetGraphEditor
(
UEdGraph* InEdGraph |
||
| UObject * | |||
| URigVMBlueprint * | Returns the blueprint being edited | ||
| URigVMHost * | GetRigVMHost () |
Returns the currently debugged / viewed host | |
| bool & | |||
| TSharedRef< SBorder > | GetToolbox () |
Get the toolbox hosting widget | |
| const TArray< TStrongObjectPtr< URigVMDetailsViewWrapperObject > > & | |||
| void | HandleBreakpointActionRequested
(
const ERigVMBreakpointAction BreakpointAction |
||
| void | |||
| FActionMenuContent | HandleCreateGraphActionMenu
(
UEdGraph* InGraph, |
Wraps the normal blueprint editor's action menu creation callback | |
| void | Handle hiding items in the graph | ||
| void | HandleJumpToHyperlink
(
const UObject* InSubject |
||
| void | HandleModifiedEvent
(
ERigVMGraphNotifType InNotifType, |
||
| void | HandleRefreshEditorFromBlueprint
(
URigVMBlueprint* InBlueprint |
||
| void | |||
| void | HandleVariableDroppedFromBlueprint
(
UObject* InSubject, |
||
| void | HandleVMCompiledEvent
(
UObject* InCompiledObject, |
||
| void | HandleVMExecutedEvent
(
URigVMHost* InHost, |
||
| void | HandleVMExecutionHalted
(
const int32 InstructionIndex, |
||
| void | InitRigVMEditor
(
const EToolkitMode::Type Mode, |
Edits the specified asset(s) | |
| bool | |||
| bool | |||
| bool | |||
| FRigVMEditorClosed & | |||
| void | OnGraphImported
(
UEdGraph* InEdGraph |
||
| void | OnGraphNodeClicked
(
URigVMEdGraphNode* InNode |
||
| void | OnNodeDoubleClicked
(
URigVMBlueprint* InBlueprint, |
||
| void | OnNodeTitleCommitted
(
const FText& NewText, |
||
| FPreviewHostUpdated & | |||
| void | OnPropertyChanged
(
UObject* InObject, |
||
| bool | OnRequestBreakLinksDialog
(
TArray< URigVMLink* > InLinks |
||
| FRigVMController_BulkEditResult | OnRequestBulkEditDialog
(
URigVMBlueprint* InBlueprint, |
||
| void | OnRequestLocalizeFunctionDialog
(
FRigVMGraphFunctionIdentifier& InFunction, |
||
| TRigVMTypeIndex | OnRequestPinTypeSelectionDialog
(
const TArray< TRigVMTypeIndex >& InTypes |
||
| void | OnWrappedPropertyChangedChainEvent
(
URigVMDetailsViewWrapperObject* InWrapperObject, |
||
| void | PostTransaction
(
bool bSuccess, |
||
| void | RedoAction () |
Redo Action | |
| void | |||
| void | SetDetailObjects
(
const TArray< UObject* >& InObjects, |
||
| void | SetDetailObjects
(
const TArray< UObject* >& InObjects |
||
| void | |||
| void | SetDetailViewForGraph
(
URigVMGraph* InGraph |
||
| void | |||
| void | SetEventQueue
(
TArray< FName > InEventQueue |
||
| void | SetEventQueue
(
TArray< FName > InEventQueue, |
||
| void | SetExecutionMode
(
const ERigVMEditorExecutionModeType InExecutionMode |
||
| void | SetHaltedNode
(
URigVMNode* Node |
||
| void | SetHost
(
URigVMHost* InHost |
||
| void | |||
| void | |||
| void | |||
| void | UndoAction () |
Undo Action | |
| bool | UpdateDefaultValueForVariable
(
FBPVariableDescription& InVariable, |
||
| void | Once the log is collected update the graph | ||
| void | Push a newly compiled/opened host to the editor | ||
| void | UpdateRigVMHost_PreClearOldHost
(
URigVMHost* InPreviousHost |
||
| void | Update stale watch pins |
Overridden from FBlueprintEditor
| Type | Name | Description | |
|---|---|---|---|
| bool | Checks if adding a local variable is allowed in the focused graph | ||
| bool | CanCopyNodes () |
||
| bool | |||
| bool | |||
| bool | |||
| void | Compile () |
Called when Compile button is clicked | |
| void | |||
| void | Create Default Commands | ||
| void | CreateDefaultTabContents
(
const TArray< UBlueprint* >& InBlueprints |
Creates the widgets that go into the tabs (note: does not create the tabs themselves) | |
| TSharedRef< SGraphEditor > | CreateGraphEditorWidget
(
TSharedRef< FTabInfo > InTabInfo, |
Create new graph editor widget for the supplied document container. | |
| void | |||
| void | FocusInspectorOnGraphSelection
(
const TSet< class UObject* >& NewSelection, |
||
| UBlueprint * | Returns a pointer to the Blueprint object we are currently editing, as long as we are editing exactly one | ||
| FString | GetCustomDebugObjectLabel
(
UObject* ObjectBeingDebugged |
Can be overloaded to customize the labels in the debug filter | |
| void | GetCustomDebugObjects
(
TArray< FCustomDebugObject >& DebugList |
Adds to a list of custom objects for debugging beyond what will automatically be found/used | |
| TSubclassOf< UEdGraphSchema > | Whenever new graphs need to be created it will use this schema by default. | ||
| FGraphAppearanceInfo | GetGraphAppearance
(
UEdGraph* InGraph |
Get the graph appearance of a specific graph, GetCurrentGraphAppearance() uses the currently focused graph. | |
| FText | GetGraphDecorationString
(
UEdGraph* InGraph |
Called by a graph title bar to get any extra information the editor would like to display | |
| void | HandleSetObjectBeingDebugged
(
UObject* InObject |
Handle when the debug object is changed in the UI | |
| bool | Returns true if able to compile | ||
| bool | IsEditable
(
UEdGraph* InGraph |
Returns whether a graph is editable or not | |
| bool | Overridable function for determining if the current mode can script | ||
| bool | Returns true if the parent class is native and the link to it's header can be shown | ||
| bool | IsSectionVisible
(
NodeSectionID::Type InSectionID |
Called to see if the new document menu items is visible for this type. | |
| void | NewDocument_OnClicked
(
ECreatedDocumentType GraphType |
Called when New Function button is clicked | |
| bool | OnActionMatchesName
(
FEdGraphSchemaAction* InAction, |
Function used by the SMyBlueprint to determine if an action matches a name. | |
| void | OnActiveTabChanged
(
TSharedPtr< SDockTab > PreviouslyActive, |
||
| void | Adds a new local variable to the focused function graph | ||
| void | OnBlueprintChangedImpl
(
UBlueprint* InBlueprint, |
Called when the Blueprint we are editing has changed | |
| void | Create comment node on graph | ||
| void | OnCreateGraphEditorCommands
(
TSharedPtr< FUICommandList > GraphEditorCommandsList |
Allow derived editors to add command mappings. | |
| void | OnFinishedChangingProperties
(
const FPropertyChangedEvent& PropertyChangedEvent |
Delegate for changing property | |
| bool | If returns true only the custom debug list will be used | ||
| void | OnPasteNewLocalVariable
(
const FBPVariableDescription& VariableDescription |
Pastes a new local variable to the focused function graph | |
| void | OnSelectedNodesChangedImpl
(
const TSet< class UObject* >& NewSelection |
Called when the selection changes in the GraphEditor | |
| FReply | OnSpawnGraphNodeByShortcut
(
FInputChord InChord, |
Handles spawning a graph node in the current graph using the passed in chord | |
| void | |||
| void | |||
| void | PasteNodes () |
||
| bool | |||
| bool | SelectLocalVariable
(
const UEdGraph* Graph, |
Selects a local variable to load in the details panel. | |
| void | SetupGraphEditorEvents
(
UEdGraph* InGraph, |
Setup all the events that the graph editor can handle | |
| bool | Other types of BP editors that don't use BP VM/function libs can choose to not load BP function libraries, for example: Control Rig Blueprints. | ||
| bool | TransactionObjectAffectsBlueprint
(
UObject* InTransactedObject |
Overridden from IBlueprintEditor
| Type | Name | Description | |
|---|---|---|---|
| bool | |||
| void | JumpToHyperlink
(
const UObject* ObjectReference, |
||
| void |
Overridden from FAssetEditorToolkit
| Type | Name | Description | |
|---|---|---|---|
| void | InitToolMenuContext
(
FToolMenuContext& MenuContext |
Add context objects for menus and toolbars | |
| void | OnToolkitHostingFinished
(
const TSharedRef< class IToolkit >& Toolkit |
Called when another toolkit (such as a ed mode toolkit) is no longer being hosted in this asset editor toolkit. | |
| void | OnToolkitHostingStarted
(
const TSharedRef< class IToolkit >& Toolkit |
Called when another toolkit (such as a ed mode toolkit) is being hosted in this asset editor toolkit. | |
| void | Called when "Save" is clicked for this asset | ||
| void | Called when "Save As" is clicked for this asset |
Overridden from IToolkit
| Type | Name | Description | |
|---|---|---|---|
| FText | Returns the localized name of this toolkit type (typically just " |
||
| FName | Returns the invariant name of this toolkit type, used for establishing the context for help, documentation and tutorials | ||
| FName | Returns the invariant name of this toolkit type | ||
| FText | Returns the localized tooltip text of this toolkit | ||
| FLinearColor | |||
| FString | Returns the localize prefix string to use for tab labels in world-centric mode. |
Overridden from FGCObject
| Type | Name | Description | |
|---|---|---|---|
| void | AddReferencedObjects
(
FReferenceCollector& Collector |
Pure virtual that must be overloaded by the inheriting class. |
Overridden from FNotifyHook
| Type | Name | Description | |
|---|---|---|---|
| void | NotifyPostChange
(
const FPropertyChangedEvent& PropertyChangedEvent, |
||
| void | NotifyPreChange
(
FProperty* PropertyAboutToChange |
Overridden from FTickableObjectBase
| Type | Name | Description | |
|---|---|---|---|
| TStatId | GetStatId () |
Return the stat id to use for this tickable | |
| void | Tick
(
float DeltaTime |
Pure virtual that must be overloaded by the inheriting class. |
Overridden from FEditorUndoClient
| Type | Name | Description | |
|---|---|---|---|
| void | PostRedo
(
bool bSuccess |
Signal that client should run any PostRedo code | |
| void | PostUndo
(
bool bSuccess |
Signal that client should run any PostUndo code |
Classes
| Type | Name | Description | |
|---|---|---|---|
| FPreviewHostUpdated |
Enums
| Type | Name | Description | |
|---|---|---|---|
| ERigVMEditorExecutionModeType |