1. Epic GamesDeveloper
  3. URigVMPin

URigVMPin

The Pin represents a single connector / pin on a node in the RigVM model.

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

Inheritance Hierarchy

References

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

Syntax

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

Remarks

The Pin represents a single connector / pin on a node in the RigVM model. Pins can be connected based on rules. Pins also provide access to a 'PinPath', which essentially represents . separated list of names to reach the pin within the owning graph. PinPaths are unique. In comparison to the EdGraph Pin the URigVMPin supports the concept of 'SubPins', so child / parent relationships between pins. A FVector Pin for example might have its X, Y and Z components as SubPins. Array Pins will have its elements as SubPins, and so on. A URigVMPin is owned solely by a URigVMNode.

Constructors

  Type Name Description
Public function   Default constructor.

Functions

  Type Name Description
Public function Const bool

CanBeBoundToVariable ( const FRigVMExternalVariable& InExternalVariable,
const FString& InSegmentPath
)

 Returns true if the pin can be bound to a given variable.
Public function Static bool

CanLink ( const URigVMPin* InSourcePin,
const URigVMPin* InTargetPin,
FString* OutFailureReason,
const FRigVMByteCode* InByteCode,
ERigVMPinDirection InUserLinkDirection,
bool bInAllowWildcard,
bool bEnableTypeCasting
)

 Returns true is the two provided source and target Pins can be linked to one another.
Public function Const FString

ClampDefaultValueFromMetaData ( const FString& InDefaultValue
)

 Returns the default value clamped with the limit meta values defined by the UPROPERTY in URigVMUnitNodes.
Public function Const UFunction BlueprintCallable, Category bool Returns true if any of the subpins is a wildcard.
Public function Const UFunction BlueprintCallable, Category URigVMLink *

FindLinkForPin ( const URigVMPin* InOtherPin
)

 Returns the link that represents the connection between this pin and InOtherPin.
Public function Const UFunction BlueprintCallable, Category URigVMPin *

FindSubPin ( const FString& InPinPath
)

 Returns a SubPin given a name / path or nullptr.
Public function Const UFunction BlueprintCallable, Category int32 Returns the absolute index of the Pin within the node / parent Pin.
Public function Const UFunction BlueprintCallable, Category FString Returns the C++ data type of an element of the Pin array.
Public function Const UFunction BlueprintCallable, Category int32 Returns the number of elements within an array Pin.
Public function Const FString Returns the variable bound to this pin (or NAME_None)
Public function Const URigVMVariableNode *  
Public function Const const FString

GetBoundVariablePath ( const FPinOverride& InOverride
)

 Returns the variable bound to this pin (or NAME_None)
Public function Const const FString Returns the variable bound to this pin (or NAME_None)
Public function Const UFunction BlueprintCallable, Category FString Returns the C++ data type of the pin.
Public function Const UFunction BlueprintCallable, Category UObject * Returns the struct of the data type of the Pin, or nullptr otherwise.
Public function Const UFunction BlueprintCallable, Category FName Returns the name of a custom widget to be used for editing the Pin.
Public function Const TSharedPtr< FStructOnScope >

GetDecoratorInstance ( bool bUseDefaultValueFromPin
)

 Returns the decorator backing up this pin.
Public function Const UFunction BlueprintCallable, Category FString Returns the default value of the Pin as a string.
Public function Const FString

GetDefaultValue ( const FPinOverride& InOverride
)

 Returns the default value with an additional override ma.
Public function Static FString

GetDefaultValueForArray ( TConstArrayView< FString > InDefaultValues
)

 Joins a collection of element DefaultValues into a default value for an array of those elements.
Public function Const UFunction BlueprintCallable, Category ERigVMPinDirection Returns the direction of the pin.
Public function Const UFunction BlueprintCallable, Category FName Returns the display label of the pin.
Public function Const UFunction BlueprintCallable, Category UEnum *

GetEnum ()

 Returns the enum of the data type of the Pin, or nullptr otherwise.
Public function Const void

GetExposedPinChain ( TArray< const URigVMPin* >& OutExposedPins
)

 Populates an array of pins which will be reduced to the same operand in the VM.
Public function Const UFunction BlueprintCallable, Category URigVMGraph * Returns the graph of this Pin.
Public function Const const TArray< URigVMInjectionInfo * > Returns the injected nodes this pin contains.
Public function Const UFunction BlueprintCallable, Category TArray< URigVMPin * >

GetLinkedSourcePins ( bool bRecursive
)

 Returns all of the linked source Pins, using this Pin as the target.
Public function Const UFunction BlueprintCallable, Category TArray< URigVMPin * >

GetLinkedTargetPins ( bool bRecursive
)

 Returns all of the linked target Pins, using this Pin as the source.
Public function Const UFunction BlueprintCallable, Category const TArray< URigVMLink * > & Returns all of the links linked to this Pin.
Public function Const UFunction BlueprintCallable, Category URigVMNode *

GetNode ()

 Returns the node of this Pin.
Public function Const UFunction BlueprintCallable, Category URigVMPin * Returns the original pin for a pin on an injected node. This can be used to determine where a link
Public function Const UFunction BlueprintCallable, Category URigVMPin * Returns the parent Pin - or nullptr if the Pin is nested directly below a node.
Public function Const UFunction BlueprintCallable, Category URigVMPin * Returns the pin to be used for a link.
Public function Const UFunction BlueprintCallable, Category int32 Returns the index of the Pin within the node / parent Pin.
Public function Const UFunction BlueprintCallable, Category FString

GetPinPath ( bool bUseNodePath
)

 Returns a .
Public function Const UFunction BlueprintCallable, Category URigVMPin * Returns the top-most parent Pin, so for example for "Node.Transform.Translation.X" this returns the Pin for "Node.Transform".
Public function Const UFunction BlueprintCallable, Category UScriptStruct * Returns the struct of the data type of the Pin, or nullptr otherwise.
Public function Const UFunction BlueprintCallable, Category FString

GetSegmentPath ( bool bIncludeRootPin
)

 Returns a .
Public function Const UFunction BlueprintCallable, Category TArray< URigVMLink * >

GetSourceLinks ( bool bRecursive
)

 Returns all of the source pins using this Pin as the target.
Public function Const uint32  
Public function Const UFunction BlueprintCallable, Category FString

GetSubPinPath ( const URigVMPin* InParentPin,
bool bIncludeParentPinName
)

 Returns a .
Public function Const UFunction BlueprintCallable, Category const TArray< URigVMPin * > & Returns all of the SubPins of this one.
Public function Const UFunction BlueprintCallable, Category TArray< URigVMLink * >

GetTargetLinks ( bool bRecursive
)

 Returns all of the target links, using this Pin as the source.
Public function Const FRigVMTemplateArgumentType Returns the argument type this pin would represent within a template.
Public function Const UFunction BlueprintCallable, Category FText Returns the tooltip of this pin.
Public function Const TRigVMTypeIndex Returns the argument type index this pin would represent within a template.
Public function Const bool Returns true if this pin has injected nodes.
Public function Const bool Returns true if this pin has injected nodes.
Public function Const UFunction BlueprintCallable, Category bool

IsArray ()

 Returns true if the data type of the Pin is an array.
Public function Const UFunction BlueprintCallable, Category bool Returns true if the Pin is a SubPin within an array.
Public function Const bool Returns true if this pin is bound to an external variable.
Public function Const bool Returns true if this pin is bound to an input argument.
Public function Const bool Returns true if this pin is bound to a local variable.
Public function Const bool Returns true if this pin is bound to a variable.
Public function Const bool

IsBoundToVariable ( const FPinOverride& InOverride
)

 Returns true if this pin is bound to a variable.
Public function Const UFunction BlueprintPure, Category bool Returns true if this pin represents a decorator.
Public function Const UFunction BlueprintCallable, Category bool Returns true if the pin is defined as a constant value / literal.
Public function Const UFunction BlueprintCallable, Category bool Returns true if this pin represents a dynamic array.
Public function Const UFunction BlueprintCallable, Category bool

IsEnum ()

 Returns true if the data type of the Pin is a enum.
Public function Const UFunction BlueprintCallable, Category bool Returns true if the C++ data type is an execute context.
Public function Const UFunction BlueprintCallable, Category bool Returns true if the pin is currently expanded.
Public function Const UFunction BlueprintCallable, Category bool Returns true if this pin is an array that should be displayed as elements only.
Public function Const UFunction BlueprintCallable, Category bool  
Public function Const UFunction BlueprintCallable, Category bool

IsLazy ()

 Returns true if this pin's value may be executed lazily.
Public function Const bool

IsLinked ( bool bRecursive
)

 Returns true if the pin has any link.
Public function Const UFunction BlueprintCallable, Category bool

IsLinkedTo ( const URigVMPin* InPin
)

 Returns true if this Pin is linked to another Pin.
Public function Const bool Returns true if the pin has been orphaned.
Public function Const UFunction BlueprintCallable, Category bool Returns true if this data type is referenced counted.
Public function Const UFunction BlueprintCallable, Category bool Returns true if this pin is a root pin.
Public function Const UFunction BlueprintCallable, Category bool Returns true if the C++ data type is FString or FName.
Public function Const UFunction BlueprintCallable, Category bool Returns true if the data type of the Pin is a struct.
Public function Const UFunction BlueprintCallable, Category bool Returns true if the Pin is a SubPin within a struct.
Public function Const UFunction BlueprintCallable, Category bool Returns true if the data type of the Pin is a uobject.
Public function Const bool

IsValidDefaultValue ( const FString& InDefaultValue
)

 Returns true if the default value provided is valid.
Public function Const UFunction BlueprintCallable, Category bool Returns true if the C++ data type is unknown.
Public function Static FString

JoinPinPath ( const TArray< FString >& InParts
)

 Joins a PinPath from to segments, so for example ["Node", "Color", "R"] becomes "Node.Color.R".
Public function Static FString

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

 Joins a PinPath from to segments, so for example "Node.Color" and "R" becomes "Node.Color.R".
Public function Const bool

NameEquals ( const FString& InName,
bool bFollowCoreRedirectors
)

 Returns true if the name of this pin matches a given name
Public function Const UFunction BlueprintCallable, Category bool

RequiresWatch ( const bool bCheckExposedPinChain
)

 Returns true if the pin should be watched.
Public function Const UFunction BlueprintCallable, Category bool Returns true if this pin's subpins should be hidden in the UI.
Public function Const UFunction BlueprintCallable, Category bool Returns true if this pin is an array that should be displayed as elements only.
Public function Const bool Returns true if the pin should not show up on a node, but in the details panel.
Public function Static TArray< FString >

SplitDefaultValue ( const FString& InDefaultValue
)

 Splits the default value into name-value pairs.
Public function Static bool

SplitPinPath ( const FString& InPinPath,
TArray< FString >& Parts
)

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

SplitPinPathAtEnd ( const FString& InPinPath,
FString& Left,
FString& RightMost
)

 Splits a PinPath at the start, so for example "Node.Color.R" becomes "Node.Color" and "R".
Public function Static bool

SplitPinPathAtStart ( const FString& InPinPath,
FString& LeftMost,
FString& Right
)

 Splits a PinPath at the start, so for example "Node.Color.R" becomes "Node" and "Color.R".
Public function Const FRigVMExternalVariable Returns an external variable matching this pin's type.

Classes

  Type Name Description
Public struct FPinOverrideValue A struct to store a pin override value.  

Typedefs

Name Description
FPinOverride  
FPinOverrideMap A map used to override pin default values.

Constants

Name Description
EmptyPinOverride  
EmptyPinOverrideMap  
OrphanPinPrefix  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page