Navigation
| Name | RigVMDeveloper |
| Type | Runtime |
| Part of Plugins | RigVM |
| Location | /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/ |
| Module Build Rules | RigVMDeveloper.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FFunctionCompilationScope | |
| FOnRigVMBreakpointAdded | |
| FOnRigVMCompiledEvent | |
| FOnRigVMExternalVariablesChanged | |
| FOnRigVMGraphImported | |
| FOnRigVMLocalizeFunctionDialogRequested | |
| FOnRigVMNodeDoubleClicked | |
| FOnRigVMPostEditChangeChainProperty | |
| FOnRigVMRefreshEditorEvent | |
| FOnRigVMReportCompilerMessage | |
| FOnRigVMRequestInspectMemoryStorage | |
| FOnRigVMRequestInspectObject | |
| FOnRigVMVariableDroppedEvent | |
| FRigVMAssignExprAST | An abstract syntax tree assign expression represents the assignment of one expression to another. |
| FRigVMASTProxy | A proxy which describes an occurence of a subject within a graph. |
| FRigVMBlockExprAST | An abstract syntax tree block expression represents a sequence of child expressions to be executed in order. |
| FRigVMBlueprintCompiler | |
| FRigVMBlueprintCompilerContext | |
| FRigVMBlueprintCompileScope | |
| FRigVMCachedValueExprAST | An abstract syntax tree cached value expression represents the reference to a variable which needs to be calculated by a call extern expression. |
| FRigVMCallExternExprAST | An abstract syntax tree call extern expression represents the invocation of an extern function. |
| FRigVMCallstack | A stack describing the model object which led to this invocation. |
| FRigVMCompileSettingsDuringLoadGuard | |
| FRigVMControllerCompileBracketScope | |
| FRigVMControllerNotifGuard | |
| FRigVMCopyExprAST | An abstract syntax tree copy expression represents the an assignment of one expression to another which causes / requires a copy operation. |
| FRigVMDefaultValueTypeGuard | |
| FRigVMEntryExprAST | An abstract syntax tree entry expression represents an entry point for a function or an event in an event graph. |
| FRigVMExitExprAST | An abstract syntax tree exit expression represents the exit out of an entry expression. |
| FRigVMExprAST | Base class for an expression within an abstract syntax tree. |
| FRigVMExternalVarExprAST | An abstract syntax tree external variable expression represents the reference of unowned / external memory. |
| FRigVMFunctionDragDropAction | DragDropAction class for drag and dropping an item from the My Blueprints tree (e.g., variable or function) |
| FRigVMGraphModifiedDynamicEvent | A dynamic delegate for subscribing / reacting to graph modifications (used for Python integration). |
| FRigVMInlineFunctionExprAST | |
| FRigVMInvokeEntryExprAST | An abstract syntax tree entry expression represents an invocation of an entry point. |
| FRigVMLiteralExprAST | An abstract syntax tree literal expression represents the definition of const memory for a single variable - vs a var expression which is mutable. |
| FRigVMLocalVariableNameValidator | FRigVMLocalVariableNameValidator. |
| FRigVMNameValidator | FRigVMNameValidator. |
| FRigVMNodeExprAST | An abstract syntax tree node expression represents any expression which references a node from the RigVM model. |
| FRigVMNoOpExprAST | An abstract syntax tree no-op expression represents an expression which is relevant for the structure of the tree (for grouping for example) but which itself has no operation connected to it. |
| FRigVMParserAST | The abstract syntax tree parser is the main object to parse a RigVM model graph. |
| FRigVMPinDefaultValueImportErrorContext | |
| FRigVMUserWorkflowProvider | |
| FRigVMVarExprAST | An abstract syntax tree var expression represents the definition of mutable memory for a single variable. |
| TRigVMModelCachedValue | A cached value which relies on a version providing object. |
| UDEPRECATED_RigVMArrayNode | The Array Node represents one of a series available array operations such as SetNum, GetAtIndex etc. |
| UDEPRECATED_RigVMBranchNode | A branch node is used to branch between two blocks of execution |
| UDEPRECATED_RigVMIfNode | A if node is used to pick between two values |
| UDEPRECATED_RigVMSelectNode | A select node is used to select between multiple values |
| URigVMActionStack | The Action Stack can be used to track actions happening on a Graph. |
| URigVMAggregateNode | The Aggregate Node contains a subgraph of nodes with aggregate pins (2in+1out or 1out+2in) connected to each other. |
| URigVMBlueprint | |
| URigVMBuildData | The Build Data is used to store transient / intermediate build information for the RigVM graph to improve the user experience. |
| URigVMClientExternalModelHost | |
| URigVMClientHost | |
| URigVMCollapseNode | The Collapse Node is a library node which stores the function and its nodes directly within the node itself. |
| URigVMCommentNode | Comment Nodes can be used to annotate a Graph by adding colored grouping as well as user provided text. |
| URigVMCompiler | |
| URigVMController | The Controller is the sole authority to perform changes on the Graph. |
| URigVMControllerSettings | Default settings for the RigVM Controller |
| URigVMDispatchNode | The Struct Node represents a Function Invocation of a RIGVM_METHOD declared on a USTRUCT. |
| URigVMEdGraph | |
| URigVMEdGraphNode | Base class for RigVM editor side nodes |
| URigVMEdGraphSchema | |
| URigVMEditorSideObject | |
| URigVMEnumNode | The Enum Node represents a constant enum value for use within the graph. |
| URigVMExternalDependencyManager | |
| URigVMFunctionEntryNode | The Function Entry node is used to provide access to the input pins of the library node for links within. |
| URigVMFunctionInterfaceNode | The Function Interface node is is used as the base class for both the entry and return nodes. |
| URigVMFunctionLibrary | The Function Library is a graph used only to store the sub graphs used for functions. |
| URigVMFunctionReferenceNode | The Function Reference Node is a library node which references a library node from a separate function library graph. |
| URigVMFunctionReturnNode | The Function Return node is used to provide access to the output pins of the library node for links within. |
| URigVMGraph | The Graph represents a Function definition using Nodes as statements. |
| URigVMInjectionInfo | The Injected Info is used for injecting a node on a pin. |
| URigVMInvokeEntryNode | The Invoke Entry Node is used to invoke another entry from the the currently running entry. |
| URigVMLibraryNode | The Library Node represents a function invocation of a function specified somewhere else. |
| URigVMLink | The Link represents a connection between two Pins within a Graph. |
| URigVMNode | The Node represents a single statement within a Graph. |
| URigVMParameterNode | The Parameter Node represents an input or output argument / parameter of the Function / Graph. |
| URigVMPin | The Pin represents a single connector / pin on a node in the RigVM model. |
| URigVMRerouteNode | A reroute node is used to visually improve the data flow within a Graph. |
| URigVMSchema | The Schema is used to determine which actions are allowed on a graph. |
| URigVMTemplateNode | The Template Node represents an unresolved function. |
| URigVMUnitNode | The Struct Node represents a Function Invocation of a RIGVM_METHOD declared on a USTRUCT. |
| URigVMUserWorkflowRegistry | |
| URigVMVariableNode | The Variable Node represents a mutable value / local state within the the Function / Graph. |
Structs
| Name | Remarks |
|---|---|
| FGuardSkipDirtyBlueprintStatus | |
| FRigStructScope | |
| FRigVMActionKey | The action key is used for serializing and storing an action in the stack, or within another action. |
| FRigVMActionNodeContent | A tuple access to sub actions, merge functionality as well as undo and redo base implementations. |
| FRigVMActionWrapper | The action wrapper is used to extract an action from a serialized key. |
| FRigVMAddExposedPinAction | An action exposing a pin as a parameter |
| FRigVMAddFunctionVariantTagAction | An action adding a tag to a function variant |
| FRigVMAddLinkAction | An action adding a new link to the graph. |
| FRigVMAddLocalVariableAction | An action to add a local variable. |
| FRigVMAddTraitAction | An action to add a trait to a node |
| FRigVMASTLinkDescription | A structure to describe a link between two proxies |
| FRigVMBaseAction | The base action is the base struct for all actions, and provides access to sub actions, merge functionality as well as undo and redo base implementations. |
| FRigVMBlueprintUtils | |
| FRigVMBreakLinkAction | An action removing a link from the graph. |
| FRigVMChangeLocalVariableDefaultValueAction | An action to change the default value of a local variable. |
| FRigVMChangeLocalVariableTypeAction | An action to change the type of a local variable. |
| FRigVMChangeNodePinCategoriesAction | An action setting a pin's category in the graph. |
| FRigVMChangePinTypeAction | An action changing a pin type |
| FRigVMClient | A management struct containing graphs and controllers. |
| FRigVMClientPatchResult | A struct describing the result of a backwards compatibility patch. |
| FRigVMCodeGenerator | |
| FRigVMCollapseNodesAction | An action to collapse a selection of nodes |
| FRigVMCompilerWorkData | |
| FRigVMCompileSettings | |
| FRigVMController_BulkEditResult | |
| FRigVMController_CommonTypePerTemplate | |
| FRigVMCreateFunctionVariantAction | An action creating a function variant |
| FRigVMEdGraphDisplaySettings | |
| FRigVMEdGraphSchemaAction_Event | |
| FRigVMEdGraphSchemaAction_LocalVar | |
| FRigVMEdGraphSchemaAction_PromoteToExposedPin | |
| FRigVMEdGraphSchemaAction_PromoteToVariable | |
| FRigVMEjectNodeFromPinAction | An action ejecting a node from a pin |
| FRigVMExpandNodeAction | An action to expand a library node into its content |
| FRigVMExternalDependency | |
| FRigVMFunctionReferenceArray | |
| FRigVMGraphParameterDescription | The parameter description is used to convey information about unique parameters within a Graph. |
| FRigVMGraphVariableDescription | The variable description is used to convey information about unique variables within a Graph. |
| FRigVMImportFromTextAction | An action importing nodes and links from text |
| FRigVMInjectNodeIntoPinAction | An action injecting a node into a pin |
| FRigVMInsertArrayPinAction | An action inserting a new array pin in the graph. |
| FRigVMMarkFunctionPublicAction | An action marking a function as public/private. |
| FRigVMOldPublicFunctionArg | |
| FRigVMOldPublicFunctionData | |
| FRigVMParserASTSettings | The settings to apply during the parse of the abstract syntax tree. |
| FRigVMPinConnectionResponse | Struct used to extend the response to a connection request to include breaking parents/children |
| FRigVMPinInfo | |
| FRigVMPinInfoArray | |
| FRigVMPromoteNodeAction | An action to promote a function to collapse node or vice versa |
| FRigVMPythonSettings | |
| FRigVMReferenceNodeData | |
| FRigVMRemoveArrayPinAction | An action removing an array pin from the graph. |
| FRigVMRemoveExposedPinAction | An action exposing a pin as a parameter |
| FRigVMRemoveFunctionVariantTagAction | An action removing a tag from a function variant |
| FRigVMRemoveLocalVariableAction | An action to remove a local variable. |
| FRigVMRemoveNodesAction | An action removing one or more nodes from the graph. |
| FRigVMRemoveTraitAction | An action to remove a trait from a node |
| FRigVMRenameExposedPinAction | An action renaming an exposed in the graph. |
| FRigVMRenameLocalVariableAction | An action to rename a local variable. |
| FRigVMRenameNodeAction | An action renaming a node in the graph. |
| FRigVMRenameVariableAction | An action renaming a variable in the graph. |
| FRigVMReplaceNodesAction | An action to add store / restore a single node |
| FRigVMSearchTags | Const values for Find-in-Blueprints to tag searchable data |
| FRigVMSetCommentTextAction | An action setting a comment node's text in the graph. |
| FRigVMSetNodeCategoryAction | An action setting a node's category in the graph. |
| FRigVMSetNodeColorAction | An action setting a node's color in the graph. |
| FRigVMSetNodeDescriptionAction | An action setting a node's description in the graph. |
| FRigVMSetNodeKeywordsAction | An action setting a node's keywords in the graph. |
| FRigVMSetNodePositionAction | An action setting a node's position in the graph. |
| FRigVMSetNodeSelectionAction | An action selecting or deselecting a node in the graph. |
| FRigVMSetNodeSizeAction | An action setting a node's size in the graph. |
| FRigVMSetNodeTitleAction | An action setting a node's title in the graph. |
| FRigVMSetPinCategoryAction | An action setting a pin's category in the graph. |
| FRigVMSetPinCategoryExpansionAction | An action to change the expansion on a pin's category in the graph. |
| FRigVMSetPinDefaultValueAction | An action setting a pin's default value in the graph. |
| FRigVMSetPinDisplayNameAction | An action setting a pin's display name in the graph. |
| FRigVMSetPinExpansionAction | An action setting a pin's expansion state in the graph. |
| FRigVMSetPinIndexAction | An action to reorder pins on a node |
| FRigVMSetPinIndexInCategoryAction | An action setting a pin's index within a category. |
| FRigVMSetPinWatchAction | An action setting a pin's watch state in the graph. |
| FRigVMSetRemappedVariableAction | An action to remap a variable inside of a function reference node renaming a node in the graph. |
| FRigVMStringTag | |
| FRigVMStringWithTag | |
| FRigVMTemplatePreferredType | |
| FRigVMTraitDefaultValueStruct |
Interfaces
| Name | Remarks |
|---|---|
| IRigVMClientExternalModelHost | Interface that allows access to externally-hosted models. |
| IRigVMClientHost | Interface that allows an object to host a rig VM client. Used by graph edting code to interact with the controller. |
| IRigVMEditorSideObject | Interface that allows a UI graph to identify itself against a model graph. |
| IRigVMExternalDependencyManager | Interface to deal with mapping external dependencies. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FRigVMCompiler_GetFunctionCompilationData | TBaseDelegate_OneParam< const FRigVMFunctionCompilationData *, const FRigVMGraphFunctionHeader &Header > | RigVMCompiler/RigVMCompiler.h | |
| FRigVMController_CheckPinCompatibilityDelegate | TBaseDelegate_TwoParams< bool, URigVMPin *, URigVMPin * > | RigVMModel/RigVMController.h | |
| FRigVMController_ConfigureWorkflowOptionsDelegate | TBaseDelegate_OneParam< void, URigVMUserWorkflowOptions *InOutOptions > | RigVMModel/RigVMController.h | |
| FRigVMController_GetByteCodeDelegate | TBaseDelegate_NoParams< const FRigVMByteCode * > | RigVMModel/RigVMController.h | |
| FRigVMController_GetExternalVariablesDelegate | TBaseDelegate_OneParam< TArray< FRigVMExternalVariable >, URigVMGraph * > | RigVMModel/RigVMController.h | |
| FRigVMController_IsDependencyCyclicDelegate | TBaseDelegate_TwoParams< bool, const FRigVMGraphFunctionHeader &Dependent, const FRigVMGraphFunctionHeader &Dependency > | RigVMModel/RigVMController.h | |
| FRigVMController_OnBulkEditProgressDelegate | TBaseDelegate_FiveParams< void, TSoftObjectPtr< URigVMFunctionReferenceNode >, ERigVMControllerBulkEditType, ERigVMControllerBulkEditProgress, int32, int32 > | RigVMModel/RigVMController.h | |
| FRigVMController_PinPathRemapDelegate | TBaseDelegate_TwoParams< FString, const FString &, bool > | RigVMModel/RigVMController.h | |
| FRigVMController_RequestBreakLinksDialogDelegate | TBaseDelegate_OneParam< bool, TArray< URigVMLink * > > | RigVMModel/RigVMController.h | |
| FRigVMController_RequestBulkEditDialogDelegate | TBaseDelegate_TwoParams< FRigVMController_BulkEditResult, URigVMLibraryNode *, ERigVMControllerBulkEditType > | RigVMModel/RigVMController.h | |
| FRigVMController_RequestJumpToHyperlinkDelegate | TBaseDelegate_OneParam< void, const UObject *InSubject > | RigVMModel/RigVMController.h | |
| FRigVMController_RequestLocalizeFunctionDelegate | TBaseDelegate_OneParam< bool, FRigVMGraphFunctionIdentifier & > | RigVMModel/RigVMController.h | |
| FRigVMController_RequestNewExternalVariableDelegate | TBaseDelegate_ThreeParams< FName, FRigVMGraphVariableDescription, bool, bool > | RigVMModel/RigVMController.h | |
| FRigVMController_RequestPinTypeSelectionDelegate | TBaseDelegate_OneParam< TRigVMTypeIndex, const TArray< TRigVMTypeIndex > &Types > | RigVMModel/RigVMController.h | |
| FRigVMController_ShouldStructUnfoldDelegate | TBaseDelegate_OneParam< bool, const UStruct * > | RigVMModel/RigVMController.h | |
| FRigVMEdGraphNodeClicked | TMulticastDelegate_OneParam< void, URigVMEdGraphNode * > | EdGraph/RigVMEdGraph.h | |
| FRigVMGetFocusedGraph | TBaseDelegate_NoParams< URigVMGraph * > | RigVMModel/RigVMClient.h | |
| FRigVMGraphModifiedEvent | TMulticastDelegate_ThreeParams< void, ERigVMGraphNotifType, URigVMGraph *, UObject * > | A delegate for subscribing / reacting to graph modifications. | RigVMModel/RigVMNotifications.h |
| FRigVMOnBreakLinksDialogRequestedDelegate | TBaseDelegate_OneParam< bool, TArray< URigVMLink * > > | RigVMBlueprint.h | |
| FRigVMOnBulkEditDialogRequestedDelegate | TBaseDelegate_FourParams< FRigVMController_BulkEditResult, URigVMBlueprint *, URigVMController *, URigVMLibraryNode *, ERigVMControllerBulkEditType > | RigVMBlueprint.h | |
| FRigVMOnPinTypeSelectionRequestedDelegate | TBaseDelegate_OneParam< TRigVMTypeIndex, const TArray< TRigVMTypeIndex > & > | RigVMBlueprint.h | |
| FRigVMPinDefaultValueOverride | TMap< FRigVMASTProxy, FString > | RigVMCompiler/RigVMASTProxy.h | |
| FRigVMPinProxyPair | TPair< FRigVMASTProxy, FRigVMASTProxy > | RigVMCompiler/RigVMASTProxy.h | |
| URigVMFunctionLibrary_GetFunctionHostObjectPath | TBaseDelegate_NoParams< const FSoftObjectPath > | RigVMModel/RigVMFunctionLibrary.h |
Enums
Public
| Name | Remarks |
|---|---|
| ECanCreateConnectionResponse_Extended | Extra operations that can be performed on pin connection |
| ERigVMControllerBulkEditProgress | |
| ERigVMControllerBulkEditType | |
| ERigVMGraphNotifType | The Graph Notification Type is used to differentiate between all of the changes that can happen within a graph. |
| ERigVMLoadType | |
| ERigVMNodeDefaultValueOverrideState::Type | |
| ERigVMPinDefaultValueType | |
| ERigVMTagDisplayMode | |
| RigVMPythonUtils::EPythonizeNameCase | How should PythonizeName adjust the final name? |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CVarRigVMEnablePinOverrides | TAutoConsoleVariable< bool > | RigVMModel/RigVMPin.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint32 GetTypeHash
(
const FRigVMPinInfoArray& InPins |
RigVMModel/RigVMController.h | ||
FString RigVMPythonUtils::EnumValueToPythonString
(
int64 Value |
RigVMPythonUtils.h | ||
FString RigVMPythonUtils::EnumValueToPythonString
(
UEnum* Enum, |
RigVMPythonUtils.h | ||
FString RigVMPythonUtils::LinearColorToPythonString
(
const FLinearColor& Color |
RigVMPythonUtils.h | ||
void RigVMPythonUtils::Print
(
const FString& BlueprintTitle, |
RigVMPythonUtils.h | ||
void RigVMPythonUtils::PrintPythonContext
(
const FString& InBlueprintName |
RigVMPythonUtils.h | ||
FString RigVMPythonUtils::PythonizeName
(
FStringView InName, |
RigVMPythonUtils.h | ||
FString RigVMPythonUtils::TransformToPythonString
(
const FTransform& Transform |
RigVMPythonUtils.h | ||
FString RigVMPythonUtils::Vector2DToPythonString
(
const FVector2D& Vector |
RigVMPythonUtils.h |