1. Epic GamesDeveloper
  3. UCustomizableObjectNode

UCustomizableObjectNode

Base class of all Customizable Object nodes.

API > API/Plugins > API/Plugins/CustomizableObjectEditor > API/Plugins/CustomizableObjectEditor/MuCOE > API/Plugins/CustomizableObjectEditor/MuCOE/Nodes

Inheritance Hierarchy

References

   
Module CustomizableObjectEditor
Header /Engine/Plugins/Experimental/Mutable/Source/CustomizableObjectEditor/Classes/MuCOE/Nodes/CustomizableObjectNode.h
Include #include "MuCOE/Nodes/CustomizableObjectNode.h"

Syntax

UCLASS&40;Abstract&41;  
class UCustomizableObjectNode : public UEdGraphNode

Remarks

Base class of all Customizable Object nodes.

The Customizable Object node system is build on top of the following premises. To avoid breaking this system, these premise must be hold!

PREMISES:

A node can only be modified when a node is reconstructed (i.e., inside the ReconstructNode, AllocateDefaultPins functions). Exceptionally, a pin can also be created inside the BeginConstruct. We consider that a node has been modified if one of the following things happen:

  • Creation, destruction and modification of pins.
  • Modification of any data that would modify any pin.

Variables

  Type Name Description
Public variable FDestroyNodeDelegate DestroyNodeDelegate  
Public variable FNodeConnectionListChangedDelegate NodeConnectionListChangedDelegate  
Public variable FPinConnectionListChangedDelegate PinConnectionListChangedDelegate  
Public variable UProperty FPostEditChangePropertyDelegate PostEditChangePropertyDelegate  
Public variable FPostEditChangePropertyRegularDelegate PostEditChangePropertyRegularDelegate  
Public variable FPostReconstructNodeDelegate PostReconstructNodeDelegate  
Public variable FRemapPinsDelegate RemapPinsDelegate  

Functions

  Type Name Description
Public function Virtual void  
Protected function void Attach data to a given pin.
Protected function Virtual void Specialization of AllocateDefaultPins UEdGraphNode function.
Public function Virtual void Add backwards compatible code here.
Public function Virtual void Called at the beginning of the node lifecycle.
Public function Virtual void

BeginPostDuplicate ( bool bDuplicateForPIE
)

 Custom post duplicate function.
Public function Virtual void Called when a new connection is perform.
Public function Virtual Const bool

CanConnect ( const UEdGraphPin* InOwnedInputPin,
const UEdGraphPin* InOutputPin,
bool& bOutIsOtherNodeBlocklisted,
bool& bOutArePinsCompatible
)

 Check if two pins can be connected.
Public function Virtual Const bool

CanPinBeHidden ( const UEdGraphPin& Pin
)

 Return true if a pin can be hidden. Override it to have a custom behaivour.
Protected function Virtual Const UCustomizableObjectNodeRemapPinsByName * Creates and returns a remap pins by name action.
Protected function Virtual Const UCustomizableObjectNodeRemapPinsByPosition * Creates and returns a remap pins by position action.
Protected function Virtual Const UCustomizableObjectNodeRemapPins * Creates and returns the node default node remap pins action.
Public function UEdGraphPin *

CustomCreatePin ( EEdGraphPinDirection Direction,
const FName& Type,
const FName& Name,
bool bIsArray
)

 Wrapper of the pin creation method, to cope with multiple Unreal Engine versions.
Public function UEdGraphPin *

CustomCreatePin ( EEdGraphPinDirection Direction,
const FName& Type,
const FName& Name,
UCustomizableObjectNodePinData* PinData
)

 Create pin with attached data.
Public function Virtual TSharedPtr< SWidget > Returns pin custom details. Override if required.
Public function Virtual bool Virtual implementation of RemovePin.
Public function Const TArray< UEdGraphPin * > Gets all non orphan pins this node owns.
Public function Const TArray< UEdGraphPin * > Gets all orphan pins this node owns.
Public function Const UCustomizableObjectGraph * Get the CustomizableObject graph that owns this node.
Public function Const TSharedPtr< class ICustomizableObjectEditor >  
Public function Const void

GetInputPins ( TArray< class UEdGraphPin* >& OutInputPins
)

  
Public function Const int32

GetLOD ()

 Return the LOD which this node belongs to.
Public function Const UEdGraphPin *

GetOutputPin ( int32 OutputIndex
)

  
Public function Const void

GetOutputPins ( TArray< class UEdGraphPin* >& OutOutputPins
)

  
Public function Const TArray< UCustomizableObjectNodeObject * >

GetParentObjectNodes ( int LOD
)

 Get all parent Object nodes of this node which are parents of this node.
Public function Const T &

GetPinData ( const UEdGraphPin& Pin
)

 Given a pin which has attached data, get the typed pin data.
Public function Const UCustomizableObjectNodePinData *

GetPinData ( const UEdGraphPin& Pin
)

 See GetPinData(const FEdGraphPinReference&).
Public function Virtual Const FString  
Public function Virtual Const bool Used during compilation process to cache the node for all LODs, or generate it specifically for each of them.
Public function Virtual bool  
Public function Virtual Const bool  
Public function Virtual Const bool If returns true, only a single link can go out of every output pin. False by default.
Public function Virtual void Add post load work here.
Public function Virtual Const bool  
Public function Virtual void Specialization of ReconstructNode UEdGraphNode function.
Protected function Virtual void

RemapPins ( const TMap< UEdGraphPin*, UEdGraphPin* >& PinsToRemap
)

 Allows to perform work when remapping a pin.
Protected function Virtual void

RemapPinsData ( const TMap< UEdGraphPin*, UEdGraphPin* >& PinsToRemap
)

  
Public function void  
Public function Virtual void  
Public function void

SetPinHidden ( UEdGraphPin& Pin,
bool bHidden
)

 Set a pin to be hidden or not.
Public function void

SetPinHidden ( const TArray< UEdGraphPin* >& Pins,
bool bHidden
)

 Set an array of pins to be hidden or not.
Public function void  
Public function Virtual Const bool

ShouldAddToContextMenu ( FText& OutCategory
)

 Subclasses should override this to return true and set OutCategory if this node should be auto-added to the right-click context menu in the graph editor.
Public function Virtual Const bool

ShouldBreakExistingConnections ( const UEdGraphPin* InputPin,
const UEdGraphPin* OutputPin
)

 When creating a new connection, break all previous connections. This method can be overridden.
Public function Virtual void

UpdateReferencedNodeId ( const FGuid& NewGuid
)

 Used to replace Ids of referenced nodes by their new ids after duplicating the CustomizableObject.

Overridden from UEdGraphNode

  Type Name Description
Public function Virtual void Allocates the default pins using the empty remap pins action. Usually called from CreateNode.
Public function Virtual void Autowire a newly created node.
Public function Virtual void Destroy the specified node
Public function Virtual void Called when something external to this node has changed the connection list of any of the pins in the node
Public function Virtual void Called when the connection list of one of the pins of this node is changed in the editor
Public function Virtual void Reconstructs the node using its default remap pins action.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public struct FAttachedErrorDataView    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page