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

Inheritance Hierarchy

References

   
Module TextureGraph
Header /Engine/Plugins/Experimental/TextureGraph/Source/TextureGraph/Public/TG_Pin.h
Include #include "TG_Pin.h"

Syntax

UCLASS ()  
class UTG_Pin : public UObject

Remarks

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.

Variables

  Type Name Description
Public variable FTG_Evaluation::VarConformer ConformerFunctor  

Functions

  Type Name Description
Public function Const bool 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
Public function FTG_Var * 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
Public function FTG_Var *  
Public function Const FName  
Public function Const FTG_Argument  
Public function Const FName  
Public function Const FTG_Name  
Public function Const FTG_ArgumentType  
Public function Const const TArray< FTG_Id > &  
Public function Const FString 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 !!!!
Public function Const FProperty * Access the FProperty associated to this pin in the Expression::Class of the node A valid FProperty is returned if it exists, null otherwise
Public function Const FTG_Id

GetId ()

  
Public function Const FName  
Public function Const FTG_Id  
Public function Const UTG_Node *  
Public function Const const FTG_Var *  
Public function Const FTG_Id  
Public function Const bool

GetValue ( FVector4f& OutValue
)

  
Public function Const bool

GetValue ( FTG_Texture& OutValue
)

 Texture value getter only on a Texture argument.
Public function Const bool

GetValue ( FTG_Variant& OutValue
)

 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.
Public function Const bool

GetValue ( float& OutValue
)

 Scalar getter only on a scalar argument.
Public function Const bool

GetValue ( FLinearColor& OutValue
)

 Color or Vector getter only on a vector or color argument.
Public function Const FTG_Id GetVarId returns the Id of the current valid Var for this Pin.
Public function Const bool  
Public function Static FTG_Hash

Hash ( const UTG_Pin& Pin
)

 Hashing.
Public function Const FTG_Hash

Hash ()

  
Public function Const bool  
Public function Const bool

IsArgObject ( UClass* InClass
)

  
Public function Const bool Check the type of the argument's Var expected to be contained in the Pin's Var.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsInput ()

  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsParam ()

  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsValid ()

  
Public function Const bool 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.
Public function Const FString

Log ( FString Tab
)

  
Public function Const FString

LogHead ()

  
Public function Const FString  
Public function Const bool  
Protected function void

NotifyPinSelfVarChanged ( bool bIsTweaking
)

  
Public function void

SetAliasName ( FName InAliasName
)

  
Public function 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
Public function bool

SetValue ( const FTG_TextureDescriptor& Value
)

  
Public function bool  
Public function bool

SetValue ( const FVector4f& Value
)

  
Public function void

SetValue ( 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
Public function bool

SetValue ( int32 Value
)

  
Public function bool

SetValue ( uint32 Value
)

  
Public function bool

SetValue ( double Value
)

  
Public function bool

SetValue ( float Value
)

 Setters for Scalar, Color, Vector arguments.
Public function bool

SetValue ( const FLinearColor& Value
)

  
Public function bool

SetValue ( const float* Value,
size_t Count
)

  

Overridden from UObject

  Type Name Description
Public function Virtual bool

Modify ( bool bAlwaysMarkDirty
)

 Note that the object will be modified.
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Override serialization for conditional serialization of SelfVar.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page