1. Epic GamesDeveloper
  3. URigVMNode

URigVMNode

The Node represents a single statement within a Graph.

API > API/Plugins > API/Plugins/RigVMDeveloper > API/Plugins/RigVMDeveloper/RigVMModel

Inheritance Hierarchy

References

   
Module RigVMDeveloper
Header /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMModel/RigVMNode.h
Include #include "RigVMModel/RigVMNode.h"

Syntax

UCLASS (BlueprintType)  
class URigVMNode : public UObject

Remarks

The Node represents a single statement within a Graph. Nodes can represent values such as Variables / Parameters, they can represent Function Invocations or Control Flow logic statements (such as If conditions of For loops). Additionally Nodes are used to represent Comment statements. Nodes contain Pins to represent parameters for Function Invocations or Value access on Variables / Parameters.

Variables

  Type Name Description
Protected variable UProperty Transient bool bHaltedAtThisNode  
Protected variable UProperty Transient bool bHasBreakpoint  
Protected variable FString LastAffectedPinCategory  
Protected variable UProperty FLinearColor NodeColor  
Protected variable UProperty FString NodeTitle  
Protected variable UProperty TArray< FString > PinCategories  
Protected variable UProperty TMap< FString, bool > PinCategoryExpansion  
Protected variable UProperty FVector2D Position  
Protected variable UProperty Transient FName PreviousName  
Protected variable UProperty FVector2D Size  
Protected variable UProperty TMap< FString, FRigVMTraitDefaultValueStruct > TraitDefaultValues Root trait pin store their default value in a separate property bag so that things like soft object ptr can be used and tracked in a uproperty
Protected variable UProperty TArray< FString > TraitRootPinNames  

Constructors

  Type Name Description
Public function   Default constructor.

Destructors

  Type Name Description
Public function Virtual   Default destructor.

Functions

  Type Name Description
Protected function Virtual Const bool

AllowsLinksOn ( const URigVMPin* InPin
)

  
Public function Virtual Const UFunction BlueprintPure, Category bool Returns true if the node can be upgraded
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if this node can only exist once in a graph.
Public function Virtual Const bool  
Public function Const UFunction BlueprintCallable, Category bool  
Public function Virtual Const UFunction BlueprintCallable, Category URigVMLibraryNode *  
Public function Const UFunction BlueprintCallable, Category URigVMPin *

FindPin ( const FString& InPinPath
)

 Returns a Pin given it's partial pin path below this node (for example: "Color.R")
Public function Const UFunction BlueprintCallable, Category URigVMPin *

FindRootPinByName ( const FName& InPinName
)

 Returns a root pin given its name.
Public function Const URigVMPin *

FindTrait ( const FName& InName,
const FString& InSubPinPath
)

  
Public function Const URigVMPin *

FindTrait ( const URigVMPin* InTraitPin
)

  
Public function Virtual Const UFunction BlueprintPure, Category TArray< URigVMPin * >  
Public function Virtual Const UFunction BlueprintPure, Category TArray< URigVMPin * >  
Public function Const UFunction BlueprintCallable, Category TArray< URigVMPin * > Returns all of the Pins of this Node (including SubPins).
Public function Virtual Const FString

GetCategoryForPin ( const FString& InPinPath
)

 Returns the category for a pin
Public function Virtual Const const TArray< FName > & Returns the names of the control flow blocks of this node
Public function Virtual Const FString  
Public function Virtual Const FName

GetDisplayNameForPin ( const FString& InPinPath
)

 Returns the display name for a pin
Public function Static FName

GetDisplayNameForProperty ( const FProperty* InProperty,
const FString& InRemainingPath
)

 Returns the display name within a property
Public function Static FName

GetDisplayNameForStructMember ( const UStruct* InStruct,
const FString& InPath
)

 Returns the display name for a struct member
Public function Virtual Const UFunction BlueprintCallable, Category FName Returns the name of the event.
Public function Virtual Const UFunction BlueprintPure, Category URigVMPin *  
Public function Const UFunction BlueprintCallable, Category URigVMGraph * Returns the Graph of this Node.
Public function Const UFunction BlueprintCallable, Category int32 Returns the graph nesting depth of this node.
Public function Virtual Const int32

GetIndexInCategoryForPin ( const FString& InPinPath
)

 Returns the index of a pin within a category
Public function Const UFunction BlueprintCallable, Category URigVMInjectionInfo * Returns the injection info of this Node (or nullptr)
Public function Const double  
Public function Const double Returns the accumulated duration of all of instructions for this node.
Public function Const const TArray< int32 > &

GetInstructionsForVM ( const FRigVMExtendedExecuteContext& Context,
URigVM* InVM,
const FRigVMASTProxy& InProxy
)

 Returns the indices of associated instructions for this node.
Public function Const const TArray< int32 > &

GetInstructionsForVM ( URigVM* InVM,
const FRigVMASTProxy& InProxy
)

  
Protected function Virtual Const TArray< int32 >  
Public function Virtual Const int32  
Public function Virtual Const int32 Returns the number of visited / run instructions for this node.
Public function Const const FString &  
Public function Const UFunction BlueprintCallable, Category TArray< URigVMNode * > Returns a list of Nodes connected as sources to this Node as the target.
Public function Const UFunction BlueprintCallable, Category TArray< URigVMNode * > Returns a list of Nodes connected as targets to this Node as the source.
Public function Const UFunction BlueprintCallable, Category TArray< URigVMLink * > Returns all links to any pin on this node.
Public function Virtual Const UFunction BlueprintPure, Category FName

GetNextAggregateName ( const FName& InLastAggregatePinName
)

  
Public function Virtual Const UFunction BlueprintCallable, Category FLinearColor Returns the color of this node - used for UI.
Public function Const UFunction BlueprintCallable, Category int32 Returns the current index of the Node within the Graph.
Public function Virtual Const UFunction BlueprintCallable, Category FRigVMNodeLayout

GetNodeLayout ( bool bIncludeEmptyCategories
)

 Returns the pin UI layout for this node.
Public function Const UFunction BlueprintCallable, Category FString

GetNodePath ( bool bRecursive
)

 Returns the a .
Public function Virtual Const UFunction BlueprintCallable, Category FString Returns the title of this Node - used for UI.
Public function Virtual Const UFunction BlueprintPure, Category URigVMPin *  
Protected function Virtual Const FString  
Public function Const FString Returns the default value for a given pin.
Public function Virtual Const UFunction BlueprintCallable, Category const TArray< URigVMPin * > & Returns all of the top-level orphaned Pins of this Node.
Public function Const UFunction BlueprintCallable, Category TArray< FString >

GetParentPinCategories ( const FString InCategory,
bool bOnlyExisting,
bool bIncludeSelf
)

 Returns all parent categories of a given.
Public function Const UFunction BlueprintCallable, Category FString

GetParentPinCategory ( const FString InCategory,
bool bOnlyExisting
)

 Returns the parent pin category of the given category (or an empty string in case there's no parent)
Public function Virtual Const UFunction BlueprintCallable, Category TArray< FString > Returns all user defined categories on this node.
Public function Static int32

GetPinCategoryDepth ( const FString& InCategory
)

 Returns the depth of the category (starting with 0 for "Foo" and 2 for "Foo|Bar|Waldo")
Public function Const UFunction BlueprintCallable, Category FString

GetPinCategoryName ( const FString InCategory
)

 Returns the name of pin category.
Public function Virtual Const UFunction BlueprintCallable, Category const TArray< URigVMPin * > &

GetPins ()

 Returns all of the top-level Pins of this Node.
Public function Const UFunction BlueprintCallable, Category TArray< URigVMPin * >

GetPinsForCategory ( FString InCategory
)

 Returns all pins for a given category.
Public function Const UFunction BlueprintCallable, Category FVector2D Returns the 2d position of this node - used for UI.
Public function Const UFunction BlueprintCallable, Category FName Returns the name of the node prior to the renaming.
Public function Const UFunction BlueprintCallable, Category URigVMGraph * Returns the top level / root Graph of this Node.
Public function Virtual Const UFunction BlueprintPure, Category URigVMPin *  
Public function Const UFunction BlueprintCallable, Category FVector2D

GetSize ()

 Returns the 2d size of this node - used for UI.
Public function Virtual Const uint32  
Public function Const UFunction BlueprintCallable, Category TArray< FString >

GetSubPinCategories ( const FString InCategory,
bool bOnlyExisting,
bool bRecursive
)

 Returns all sub user defined categories of a given parent category.
Public function Virtual Const UFunction BlueprintCallable, Category TArray< FRigVMUserWorkflow >

GetSupportedWorkflows ( ERigVMUserWorkflowType InType,
const UObject* InSubject
)

 Returns all supported workflows of the node
Public function Virtual Const UFunction BlueprintCallable, Category FText Returns the tooltip of this node.
Protected function Virtual Const FText

GetToolTipTextForPin ( const URigVMPin* InPin
)

  
Public function Const TSharedPtr< FStructOnScope >

GetTraitInstance ( const FName& InName,
bool bUseDefaultValueFromPin
)

  
Public function Const TSharedPtr< FStructOnScope >

GetTraitInstance ( const URigVMPin* InTraitPin,
bool bUseDefaultValueFromPin
)

  
Public function Const const TArray< FString > &  
Public function Const UFunction BlueprintPure, Category TArray< URigVMPin * >  
Public function Const UScriptStruct *

GetTraitScriptStruct ( const FName& InName
)

  
Public function Const UScriptStruct *

GetTraitScriptStruct ( const URigVMPin* InTraitPin
)

  
Public function Virtual Const FRigVMStructUpgradeInfo  
Public function Const UFunction BlueprintCallable, Category bool  
Public function Virtual Const UFunction BlueprintCallable, Category bool

HasInputPin ( bool bIncludeIO
)

 Returns true if the node has any input pins.
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if the node has any io pins.
Public function Virtual Const UFunction BlueprintCallable, Category bool

HasLazyPin ( bool bOnlyConsiderPinsWithLinks
)

 Returns true if the node has any lazily evaluating pins.
Public function Virtual Const bool Allows the node to support non-native pins
Public function Const UFunction BlueprintPure, Category bool Returns true if the node has orphaned pins - which leads to a compiler error.
Public function Virtual Const UFunction BlueprintCallable, Category bool

HasOutputPin ( bool bIncludeIO
)

 Returns true if the node has any output pins.
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if the node has any pins of the provided direction.
Public function Const bool Returns true if this node has an unknown type pin.
Protected function Virtual void  
Public function Virtual Const UFunction BlueprintPure, Category bool  
Public function Virtual Const const bool

IsControlFlowBlockSliced ( const FName& InBlockName
)

 Returns true if a control flow block requires slicing
Public function Const UFunction BlueprintPure, Category bool Return true if this node is a control flow node
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if the node is defined as non-varying.
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if the node is defined as non-varying.
Public function Virtual Const UFunction BlueprintCallable, Category bool

IsEvent ()

 Returns true if this Node is the beginning of a scope.
Public function Const UFunction BlueprintCallable, Category bool Returns true if this is an injected node.
Public function Virtual Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintCallable, Category bool

IsLinkedTo ( URigVMNode* InNode
)

 Returns true if this Node is linked to another given node through any of the Nodes' Pins.
Public function Const UFunction BlueprintPure, Category bool Return true if this node is a loop node
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if this Node has side effects or internal state.
Public function Virtual Const bool  
Public function Const UFunction BlueprintCallable, Category bool Returns all pins for a given category.
Public function Virtual Const UFunction BlueprintCallable, Category bool

IsPure ()

 Returns true if this Node has no side-effects and no internal state.
Public function Const UFunction BlueprintCallable, Category bool Returns true if this Node is currently selected.
Public function Const bool

IsTraitPin ( const URigVMPin* InTraitPin
)

  
Public function Const UFunction BlueprintPure, Category bool

IsTraitPin ( FName InName
)

  
Public function Const UFunction BlueprintCallable, Category bool Returns true if this should be visible in the UI.
Public function Virtual Const bool Returns true if the node is within a loop
Public function Static FString

JoinNodePath ( const TArray< FString >& InParts
)

 Joins a NodePath from to segments, so for example ["CollapseNodeA", "CollapseNodeB", "CollapseNodeC"] becomes "CollapseNodeA|CollapseNodeB|CollapseNodeC".
Public function Static FString

JoinNodePath ( const FString& Left,
const FString& Right
)

 Joins a NodePath from to segments, so for example "CollapseNodeA" and "CollapseNodeB|CollapseNodeC" becomes "CollapseNodeA|CollapseNodeB|CollapseNodeC".
Public function void

Serialize ( FArchive& Ar
)

  
Public function UFunction BlueprintCallable, Category void

SetExecutionIsHaltedAtThisNode ( const bool bValue
)

  
Public function UFunction BlueprintCallable, Category void

SetHasBreakpoint ( const bool bValue
)

  
Protected function Virtual Const bool  
Public function Static bool

SplitNodePath ( const FString& InNodePath,
TArray< FString >& Parts
)

 Splits a NodePath into all segments, so for example "Node.Color.R" becomes ["Node", "Color", "R"].
Public function Static bool

SplitNodePathAtEnd ( const FString& InNodePath,
FString& Left,
FString& RightMost
)

 Splits a NodePath at the end, so for example "CollapseNodeA|CollapseNodeB|CollapseNodeC" becomes "CollapseNodeA|CollapseNodeB" and "CollapseNodeC".
Public function Static bool

SplitNodePathAtStart ( const FString& InNodePath,
FString& LeftMost,
FString& Right
)

 Splits a NodePath at the start, so for example "CollapseNodeA|CollapseNodeB|CollapseNodeC" becomes "CollapseNodeA" and "CollapseNodeB|CollapseNodeC".
Protected function void  

Constants

Name Description
EmptyInstructionArray  
NodeColorName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page