Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Developer > RigVMDeveloper > RigVMModel > URigVMGraph

Light Theme

Dark Theme

URigVMGraph

The Graph represents a Function definition using Nodes as statements.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

URigVMGraph

References

Module	RigVMDeveloper
Header	/Engine/Source/Developer/RigVMDeveloper/Public/RigVMModel/RigVMGraph.h
Include	#include "RigVMModel/RigVMGraph.h"

Syntax

class URigVMGraph : public UObject

Remarks

The Graph represents a Function definition using Nodes as statements. Graphs can be compiled into a URigVM using the FRigVMCompiler. Graphs provide access to its Nodes, Pins and Links.

Constructors

	Name	Description
	URigVMGraph()	Default constructor.

Functions

	Name	Description
bool	CanLink ( URigVMPin* InSourcePin, URigVMPin* InTargetPin, FString* OutFailureReason )
void	ClearAST ( bool bClearDiagnostics, bool bClearRuntime )
URigVMLink &...	FindLink ( const FString& InLinkPinPathRepres... )	Returns a link given its string representation, for example "NodeA.Color.R -> NodeB.Translation.X"
URigVMNode &...	FindNode ( const FString& InNodePath )	Returns a Node given its path (or nullptr).
URigVMNode &...	FindNodeByName ( const FName& InNodeName )	Returns a Node given its name (or nullptr).
URigVMPin &#...	FindPin ( const FString& InPinPath )	Returns a Pin given its path, for example "Node.Color.R".
TSharedPtr< ...	GetDiagnosticsAST ( bool bForceRefresh )
const TArray...	GetLinks()	Returns all of the Links within this Graph.
const TArray...	GetNodes()	Returns all of the Nodes within this Graph.
TArray< FRig...	GetParameterDescriptions()	Returns a list of unique Parameter descriptions within this Graph.
TSharedPtr< ...	GetRuntimeAST ( const FRigVMParserASTSettings& InS..., bool bForceRefresh )
const TArray...	GetSelectNodes()	Returns the names of all currently selected Nodes.
TArray< FRig...	GetVariableDescriptions()	Returns a list of unique Variable descriptions within this Graph.
bool	IsNodeSelected ( const FName& InNodeName )	Returns true if a Node with a given name is selected.
FRigVMGraphM...	OnModified()	Returns the modified event, which can be used to subscribe to changes happening within the Graph.
void	PrepareCycleChecking ( URigVMPin* InPin, bool bAsInput )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss