Navigation
API > API/Plugins > API/Plugins/RigVMDeveloper
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.
| Name | URigVMLink |
| Type | class |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMModel/RigVMLink.h |
| Include Path | #include "RigVMModel/RigVMLink.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class URigVMLink : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → URigVMLink
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
URigVMLink() |
Default constructor. | RigVMModel/RigVMLink.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| SourcePin | URigVMPin * | RigVMModel/RigVMLink.h | ||
| SourcePinPath | FString | RigVMModel/RigVMLink.h | ||
| TargetPin | URigVMPin * | RigVMModel/RigVMLink.h | ||
| TargetPinPath | FString | RigVMModel/RigVMLink.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool Detach() |
RigVMModel/RigVMLink.h | ||
URigVMGraph * GetGraph() |
Returns the Link's owning Graph/. | RigVMModel/RigVMLink.h |
|
int32 GetGraphDepth() |
Returns the graph nesting depth of this link. | RigVMModel/RigVMLink.h |
|
int32 GetLinkIndex() |
Returns the current index of this Link within its owning Graph. | RigVMModel/RigVMLink.h |
|
| Returns the opposite Pin of this Link given one of its edges (or nullptr) | RigVMModel/RigVMLink.h |
|
|
| Returns a string representation of the Link, for example: "NodeA.Color.R -> NodeB.Translation.X" note: can be split again using SplitPinPathRepresentation | RigVMModel/RigVMLink.h |
|
|
URigVMNode * GetSourceNode() |
Returns the source Node of this Link (or nullptr) | RigVMModel/RigVMLink.h |
|
URigVMPin * GetSourcePin() |
Returns the source Pin of this Link (or nullptr) | RigVMModel/RigVMLink.h |
|
FString GetSourcePinPath() |
Returns the source pin's path pin of this Link. | RigVMModel/RigVMLink.h | |
URigVMNode * GetTargetNode() |
Returns the target Node of this Link (or nullptr) | RigVMModel/RigVMLink.h |
|
URigVMPin * GetTargetPin() |
Returns the target Pin of this Link (or nullptr) | RigVMModel/RigVMLink.h |
|
FString GetTargetPinPath() |
Returns the target pin's path pin of this Link. | RigVMModel/RigVMLink.h | |
| Sets the target pin's path pin of this Link. | RigVMModel/RigVMLink.h | ||
bool SetSourcePinPath
(
const FString& InPinPath |
Sets the source pin's path pin of this Link. | RigVMModel/RigVMLink.h | |
bool SetTargetPinPath
(
const FString& InPinPath |
Sets the target pin's path pin of this Link. | RigVMModel/RigVMLink.h | |
void UpdatePinPaths() |
RigVMModel/RigVMLink.h | ||
void UpdatePinPointers() |
RigVMModel/RigVMLink.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Serialize
(
FArchive& Ar |
Serialization override. | RigVMModel/RigVMLink.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FString GetPinPathRepresentation
(
const FString& InSourcePinPath, |
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 | RigVMModel/RigVMLink.h | |
| Splits a pin path representation of a link for example: "NodeA.Color.R -> NodeB.Translation.X" into its two pin paths | RigVMModel/RigVMLink.h |