1. Epic GamesDeveloper
  3. UTG_Pin

UTG_Pin

Pin is a struct referencing: the Node where it belongs and the ArgumentHash to the corresponding Argument in the Signature The [Edge(s)](API\Runtime\InteractiveToolsFramework\EMeshSelectionElementType) connecting to this pin, aka the other pinId to which this pin is connected.

API > API/Plugins > API/Plugins/TextureGraph

Pin is a struct referencing: the Node where it belongs and the ArgumentHash to the corresponding Argument in the Signature The Edge(s) connecting to this pin, aka the other pinId to which this pin is connected. The Var containing the default value for this pin

Pins are stored in the Graph. Created when instancing a Node.

   
Name UTG_Pin
Type class
Header File /Engine/Plugins/TextureGraph/Source/TextureGraph/Public/TG_Pin.h
Include Path #include "TG_Pin.h"

Syntax

UCLASS (MinimalAPI)  
class UTG_Pin : public UObject

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ConformerFunctor FTG_Evaluation::VarConformer   TG_Pin.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AliasName FName   TG_Pin.h
  • Setter
  • Getter
Argument FTG_Argument   TG_Pin.h  
ConvertedVar FTG_Var When an InputVarConverterKey is installed, then we host the result of the conversion as var value here this member is not saved and updated on every evaluation It is only useful during the evaluation to capture the value passed in and converted from a connected pin TG_Pin.h
  • Transient
Edges TArray< FTG_Id >   TG_Pin.h  
Id FTG_Id Id member is assigned by TG_Graph at creation, potentially modified during a remap. TG_Pin.h  
InputVarConverterKey FName Input var ConverterKey is indicating that the Pin is fed from a Pin/Var which is compatible BUT requires a conversion during evaluation. TG_Pin.h  
SelfVar FTG_Var SelfVar is the Var owned by this pin containing the value. TG_Pin.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ConnectionNeedsConversion()

 In the case the pin is an input, and is connected and the feeding pin var needs a conversion This implies that during the evaluation, the feeding Var is Converted into the SelfVar which is then input in the expression TG_Pin.h  

FTG_Var * EditConvertedVar()

 EditConvertedVar returns the internal Var used to input its value in the pin's expression AFTER conversion Should only be accessed by the Graph Evaluation TG_Pin.h  

FTG_Var * EditSelfVar()

   TG_Pin.h  

void FromString ( const FString& InValueStr,
bool bIsTweaking
)

 Set the self var value from string Used by UI to assign pin default value This is the same as the selfvar setter TG_Pin.h  

FName GetAliasName()

   TG_Pin.h  

FTG_Argument GetArgument()

   TG_Pin.h  

FName GetArgumentCPPTypeName()

   TG_Pin.h  

FTG_Name GetArgumentName()

   TG_Pin.h  

FTG_ArgumentType GetArgumentType()

   TG_Pin.h  

const TArray< FTG_Id > & GetEdges()

   TG_Pin.h  

FString GetEvaluatedVarValue()

 Useful for the UI: access the current value of this pin as passed to the evaluation if it is an input or received from the evaluation if it is an output if output pin: the selfVar else if input pin: if NOT connected: the selfVar else if connected with a conversion: the convertedVar else if connected without conversion: the Var from the connected pin This is MEANT TO BE USED for UI purpose !!!! TG_Pin.h  

FProperty * GetExpressionProperty()

 Access the FProperty associated to this pin in the Expression::Class of the node A valid FProperty is returned if it exists, null otherwise TG_Pin.h  

FTG_Id GetId()

   TG_Pin.h  

FName GetInputVarConverterKey()

   TG_Pin.h  

FTG_Id GetNodeId()

   TG_Pin.h  

UTG_Node * GetNodePtr()

   TG_Pin.h  

const FTG_Var * GetSelfVar()

   TG_Pin.h  

FTG_Id GetSelfVarId()

   TG_Pin.h  

bool GetValue ( FString& OutValue
) const

 String getter only on a FString argument. TG_Pin.h  

bool GetValue ( FLinearColor& OutValue
) const

 Color or Vector getter only on a vector or color argument. TG_Pin.h  

bool GetValue ( FVector4f& OutValue
) const

   TG_Pin.h  

bool GetValue ( FTG_Texture& OutValue
) const

 Texture value getter only on a Texture argument. TG_Pin.h  

bool GetValue ( FTG_VariantArray& OutValue
) const

 Texture value getter only on a Texture argument. TG_Pin.h  

bool GetValue ( FTG_Variant& OutValue
) const

 Variant value getter only if a Variant argument OR if the argument is one of the supported type by Variant (Scalar/Color/Vector/Texture) After getting the value, the next step is to check the type contained in the variant. TG_Pin.h  

bool GetValue ( float& OutValue
) const

 Scalar getter only on a scalar argument. TG_Pin.h  

bool GetValue ( bool& OutValue
) const

 Bool getter only on a boolean argument TG_Pin.h  
GetVarId returns the Id of the current valid Var for this Pin. TG_Pin.h  

bool HasAliasName()

   TG_Pin.h  

FTG_Hash Hash ()

   TG_Pin.h  

bool IsArgArray()

   TG_Pin.h  

bool IsArgBool()

   TG_Pin.h  

bool IsArgColor()

   TG_Pin.h  

bool IsArgObject ( UClass* InClass
) const

   TG_Pin.h  

bool IsArgScalar()

 Check the type of the argument's Var expected to be contained in the Pin's Var. TG_Pin.h  

bool IsArgString()

   TG_Pin.h  

bool IsArgTexture()

   TG_Pin.h  

bool IsArgTextureArray()

   TG_Pin.h  

bool IsArgVariant()

   TG_Pin.h  

bool IsArgVector()

   TG_Pin.h  

bool IsConnected()

   TG_Pin.h  

bool IsInput()

   TG_Pin.h  

bool IsNotConnectable()

   TG_Pin.h  

bool IsOutput()

   TG_Pin.h  

bool IsParam()

   TG_Pin.h  

bool IsPrivate()

   TG_Pin.h  

bool IsSetting()

   TG_Pin.h  

bool IsValid()

   TG_Pin.h  

bool IsValidSelfVar()

 Access the SelfVar of the Pin containing the currrent default value for the pin if an output pin, SelfVar contains the current result value produced by the node's expression by last evaluation if an input pin, SelfVar contains the current 'default' value of the pin used as expression input IF the pin is not connected. TG_Pin.h  

FString Log ( FString Tab
) const

   TG_Pin.h  

FString LogHead()

   TG_Pin.h  

FString LogTooltip()

   TG_Pin.h  

bool NeedsConformance()

   TG_Pin.h  

void SetAliasName ( FName InAliasName
)

   TG_Pin.h  

bool SetValue ( const FTG_TextureDescriptor& Value
)

   TG_Pin.h  
  TG_Pin.h  

bool SetValue ( FTG_Texture&
)

   TG_Pin.h  

bool SetValue ( const FVector4f& Value
)

   TG_Pin.h  

bool SetValue ( const FLinearColor& Value
)

   TG_Pin.h  

bool SetValue ( int32 Value
)

   TG_Pin.h  

bool SetValue ( bool bValue
)

   TG_Pin.h  

bool SetValue ( uint32 Value
)

   TG_Pin.h  

bool SetValue ( double Value
)

   TG_Pin.h  

bool SetValue ( float Value
)

 Setters for Scalar, Color, Vector, bool and String arguments These check that the arg is of the correct type TG_Pin.h  

bool SetValue ( const T& Value
)

 Template version of the setter works correctly as long as the selfvar contains exactly the specified type Use with care TG_Pin.h  

bool SetValue ( FString Value
)

   TG_Pin.h  

bool SetValue ( const float* Value,
size_t Count
)

   TG_Pin.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool Modify ( bool bAlwaysMarkDirty
)

   TG_Pin.h  

virtual void Serialize ( FArchive& Ar
)

 Override serialization for conditional serialization of SelfVar. TG_Pin.h  

Protected

Name Remarks Include Path Unreal Specifiers

void NotifyPinSelfVarChanged ( bool bIsTweaking
)

   TG_Pin.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   TG_Pin.h  

Static

Name Remarks Include Path Unreal Specifiers

static FTG_Hash Hash ( const UTG_Pin& Pin
)

 Hashing. TG_Pin.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page