1. Epic GamesDeveloper
  3. URigVMLink

URigVMLink

The Link represents a connection between two Pins 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/RigVMLink.h
Include #include "RigVMModel/RigVMLink.h"

Syntax

UCLASS&40;BlueprintType&41;  
class URigVMLink : public UObject

Remarks

The Link represents a connection between two Pins within a Graph. The Link can be accessed on the Graph itself - or through the URigVMPin::GetLinks() method.

Constructors

  Type Name Description
Public function   Default constructor.

Functions

  Type Name Description
Public function bool

Detach ()

  
Public function Const UFunction BlueprintCallable, Category URigVMGraph * Returns the Link's owning Graph/.
Public function Const UFunction BlueprintCallable, Category int32 Returns the graph nesting depth of this link.
Public function Const UFunction BlueprintCallable, Category int32 Returns the current index of this Link within its owning Graph.
Public function Const UFunction BlueprintCallable, Category URigVMPin *

GetOppositePin ( const URigVMPin* InPin
)

 Returns the opposite Pin of this Link given one of its edges (or nullptr)
Public function Const UFunction BlueprintCallable, Category FString Returns a string representation of the Link, for example: "NodeA.Color.R -> NodeB.Translation.X" note: can be split again using SplitPinPathRepresentation
Public function Static FString

GetPinPathRepresentation ( const FString& InSourcePinPath,
const FString& InTargetPinPath
)

 Returns a string representation of the Link given the two pin paths for example: "NodeA.Color.R -> NodeB.Translation.X" note: can be split again using SplitPinPathRepresentation
Public function Const UFunction BlueprintCallable, Category URigVMNode * Returns the source Node of this Link (or nullptr)
Public function Const UFunction BlueprintCallable, Category URigVMPin * Returns the source Pin of this Link (or nullptr)
Public function Const FString Returns the source pin's path pin of this Link.
Public function Const UFunction BlueprintCallable, Category URigVMNode * Returns the target Node of this Link (or nullptr)
Public function Const UFunction BlueprintCallable, Category URigVMPin * Returns the target Pin of this Link (or nullptr)
Public function Const FString Returns the target pin's path pin of this Link.
Public function bool

SetSourceAndTargetPinPaths ( const FString& InSourcePinPath,
const FString& InTargetPinPath
)

 Sets the target pin's path pin of this Link.
Public function bool

SetSourcePinPath ( const FString& InPinPath
)

 Sets the source pin's path pin of this Link.
Public function bool

SetTargetPinPath ( const FString& InPinPath
)

 Sets the target pin's path pin of this Link.
Public function Static bool

SplitPinPathRepresentation ( const FString& InString,
FString& OutSource,
FString& OutTarget
)

 Splits a pin path representation of a link for example: "NodeA.Color.R -> NodeB.Translation.X" into its two pin paths
Public function void  
Public function Const void  

Overridden from UObject

  Type Name Description
Public function Virtual void Serialization override.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page