| UObjectBase
|
Module |
|
Header |
/Engine/Source/Developer/RigVMDeveloper/Public/RigVMModel/RigVMController.h |
Include |
#include "RigVMModel/RigVMController.h" |
class URigVMController : public UObject
The Controller is the sole authority to perform changes on the Graph. The Controller itself is stateless. The Controller offers a Modified event to subscribe to for user interface views - so they can be informed about any change that's happening within the Graph. The Controller routes all changes through the Graph itself, so you can have N Controllers performing edits on 1 Graph, and N Views subscribing to 1 Controller. In Python you can also subscribe to this event to be able to react to topological changes of the Graph there.
Name | Description | ||
---|---|---|---|
|
UnfoldStructDelegate |
A delegate that can be set to change the struct unfolding behaviour. |
Name | Description | |
---|---|---|
|
URigVMController() |
Default constructor. |
|
URigVMController ( |
Name | Description | |
---|---|---|
|
~URigVMController() |
Default destructor. |
Name | Description | ||
---|---|---|---|
|
AddArrayPin |
Adds an array element pin to the end of an array pin. |
|
|
URigVMCommen... |
AddCommentNode |
Adds a Comment Node to the edited Graph. |
|
URigVMRerout... |
AddFreeRerouteNode |
Adds a free Reroute Node. |
|
URigVMInject... |
AddInjectedNode |
Adds a Function / Struct Node to the edited Graph as an injected node StructNode represent a RIGVM_METHOD declaration on a USTRUCT. |
|
URigVMInject... |
AddInjectedNodeFromStructPath |
Adds a Function / Struct Node to the edited Graph as an injected node StructNode represent a RIGVM_METHOD declaration on a USTRUCT. |
|
AddLink |
Adds a link to the graph. This causes a LinkAdded modified event. |
|
|
URigVMParame... |
AddParameterNode |
Adds a Parameter Node to the edited Graph. |
|
URigVMParame... |
AddParameterNodeFromObjectPath |
Adds a Parameter Node to the edited Graph given a struct object path name. |
|
URigVMRerout... |
AddRerouteNodeOnLink ( |
Adds a Reroute Node on an existing Link to the edited Graph. |
|
URigVMRerout... |
AddRerouteNodeOnLinkPath |
Adds a Reroute Node on an existing Link to the edited Graph given the Link's string representation. |
|
URigVMRerout... |
AddRerouteNodeOnPin |
Adds a Reroute Node on an existing Pin to the editor Graph. |
|
URigVMStruct... |
AddStructNode ( |
Note: The functions below are scoped with WITH_EDITOR since we are considering to move this code into the runtime in the future. |
|
URigVMStruct... |
AddStructNodeFromStructPath |
Adds a Function / Struct Node to the edited Graph given its struct object path name. |
|
URigVMVariab... |
AddVariableNode |
Adds a Variable Node to the edited Graph. |
|
URigVMVariab... |
AddVariableNodeFromObjectPath |
Adds a Variable Node to the edited Graph given a struct object path name. |
|
BreakAllLinks |
Removes all links on a given pin from the graph. |
|
|
BreakLink |
Removes a link from the graph. This causes a LinkRemoved modified event. |
|
|
CancelUndoBracket() |
Cancels an undo bracket / scoped transaction. |
|
|
CanImportNodesFromText ( |
Exports the given nodes as text. |
|
|
ClearArrayPin |
Removes all (but one) array element pin from an array pin. |
|
|
ClearNodeSelection ( |
Deselects all currently selected nodes in the graph. |
|
|
CloseUndoBracket() |
Closes an undo bracket / scoped transaction. |
|
|
DetachLinksFromPinObjects() |
||
|
DuplicateArrayPin |
Duplicates an array element pin. This causes a PinArraySizeChanged modified event. |
|
|
URigVMNode &... |
EjectNodeFromPin |
Ejects the last injected node on a pin. |
|
EnableReporting ( |
Enables or disables the error reporting of this Controller. |
|
|
ExportNodesToText |
Exports the given nodes as text. |
|
|
ExportSelectedNodesToText() |
Exports the selected nodes as text. |
|
|
URigVMGraph ... |
GetGraph() |
Returns the currently edited Graph of this controller. |
|
GetPinDefaultValue ( |
Returns the default value of a pin given its pinpath. |
|
|
GetUniqueName |
Returns a unique name. |
|
|
ImportNodesFromText |
Exports the given nodes as text. |
|
|
InsertArrayPin |
Inserts an array element pin into an array pin. This causes a PinArraySizeChanged modified event. |
|
|
Notify ( |
Submits an event to the graph for broadcasting. |
|
|
FRigVMGraphM... |
OnModified() |
The Modified event used to subscribe to changes happening within the Graph. |
|
OpenUndoBracket ( |
Opens an undo bracket / scoped transaction for a series of actions to be performed as one step on the Undo stack. |
|
|
ReattachLinksToPinObjects() |
||
|
Redo() |
Re-does the last action on the stack. |
|
|
RemoveArrayPin |
Removes an array element pin from an array pin. This causes a PinArraySizeChanged modified event. |
|
|
RemoveNode ( |
Removes a node from the graph This causes a NodeRemoved modified event. |
|
|
RemoveNodeByName |
Removes a node from the graph given the node's name. This causes a NodeRemoved modified event. |
|
|
RenameParameter |
Renames a parameter in the graph. This causes a ParameterRenamed modified event. |
|
|
RenameVariable |
Renames a variable in the graph. This causes a VariableRenamed modified event. |
|
|
RepopulatePinsOnNode ( |
||
|
ResendAllNotifications() |
Resends all notifications. |
|
|
ResetPinDefaultValue |
Resets the default value of a pin given its pinpath. |
|
|
SelectNode ( |
Selects a single node in the graph. This causes a NodeSelected / NodeDeselected modified event. |
|
|
SelectNodeByName |
Selects a single node in the graph by name. |
|
|
SetArrayPinSize |
Sets the size of the array pin This causes a PinArraySizeChanged modified event. |
|
|
SetCommentText ( |
Sets the comment text of a comment node in the graph. |
|
|
SetCommentTextByName |
Sets the comment text of a comment node in the graph by name. |
|
|
SetExecuteContextStruct ( |
Sets the execute context struct type to use. |
|
|
SetGraph ( |
Sets the currently edited Graph of this controller. This causes a GraphChanged modified event. |
|
|
SetNodeColor ( |
Sets the color of a node in the graph. This causes a NodeColorChanged modified event. |
|
|
SetNodeColorByName ( |
Sets the color of a node in the graph by name. This causes a NodeColorChanged modified event. |
|
|
SetNodePosition ( |
Sets the position of a node in the graph. This causes a NodePositionChanged modified event. |
|
|
SetNodePositionByName |
Sets the position of a node in the graph by name. This causes a NodePositionChanged modified event. |
|
|
SetNodeSelection |
Selects the nodes given the selection This might cause several NodeDeselected modified event. |
|
|
SetNodeSize ( |
Sets the size of a node in the graph. This causes a NodeSizeChanged modified event. |
|
|
SetNodeSizeByName |
Sets the size of a node in the graph by name. This causes a NodeSizeChanged modified event. |
|
|
SetPinDefaultValue |
Sets the default value of a pin given its pinpath. |
|
|
SetPinExpansion |
Sets the pin to be expanded or not This causes a PinExpansionChanged modified event. |
|
|
SetPinIsWatched |
Sets the pin to be watched (or not) This causes a PinWatchedChanged modified event. |
|
|
SetRerouteCompactness ( |
Sets the compactness of a reroute node in the graph. |
|
|
SetRerouteCompactnessByName |
Sets the compactness of a reroute node in the graph by name. |
|
|
Undo() |
Un-does the last action on the stack. |