1. Epic GamesDeveloper
  3. UPCGGraph

UPCGGraph

API > API/Plugins > API/Plugins/PCG

Inheritance Hierarchy

References

   
Module PCG
Header /Engine/Plugins/Experimental/PCG/Source/PCG/Public/PCGGraph.h
Include #include "PCGGraph.h"

Syntax

class UPCGGraph : public UPCGGraphInterface

Variables

  Type Name Description
Protected variable bool bDebugFlagAppliesToIndividualComponents When true the Debug flag in the graph editor will display debug information contextually for the selected debug object.
Public variable bool bExposeToLibrary  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite assetregistrysearchable bool bLandscapeUsesMetadata  
Protected variable bool bUseHierarchicalGeneration  
Public variable FText Category  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite assetregistrysearchable FText Description  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere TArray< TObjectPtr< UObject > > ExtraEditorNodes Extra data to hold information that is useful only in editor (like comments)
Protected variable EPCGHiGenGrid HiGenGridSize  
Protected variable TObjectPtr< UPCGNode > InputNode Add input/output nodes.
Protected variable TArray< TObjectPtr< UPCGNode > > Nodes  
Protected variable TMap< const UPCGNode *, uint32 > NodeToGridSize Execution grid size for nodes.
Protected variable FRWLock NodeToGridSizeLock  
Protected variable TObjectPtr< UPCGNode > OutputNode  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere FInstancedPropertyBag UserParameters Parameters.

Constructors

  Type Name Description
Public function  

UPCGGraph ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category, Meta UPCGNode *

AddEdge ( UPCGNode* From,
const FName& FromPinLabel,
UPCGNode* To,
const FName& ToPinLabel
)

 Adds a directed edge in the graph. Returns the "To" node for easy chaining
Public function UFunction BlueprintCallable, Category bool

AddLabeledEdge ( UPCGNode* From,
const FName& InboundLabel,
UPCGNode* To,
const FName& OutboundLabel
)

 Creates an edge between two nodes/pins based on the labels.
Public function void

AddNode ( UPCGNode* InNode
)

  
Public function UPCGNode *

AddNode ( UPCGSettingsInterface* InSettings
)

 Creates a node using the given settings interface.
Public function UPCGNode *

AddNodeCopy ( UPCGSettings* InSettings,
UPCGSettings*& DefaultNodeSettings
)

 Creates a node and copies the input settings. Returns the created node.
Public function UFunction BlueprintCallable, Category, Meta UPCGNode *

AddNodeInstance ( UPCGSettings* InSettings
)

 Creates a node containing an instance to the given settings. Returns the created node.
Public function UPCGNode *

AddNodeOfType ( TSubclassOf< class UPCGSettings > InSettingsClass,
UPCGSettings*& DefaultNodeSettings
)

 Creates a default node based on the settings class wanted. Returns the newly created node.
Protected function Const uint32

CalculateNodeGridSizeRecursive_Unsafe ( const UPCGNode* InNode,
uint32 InDefaultGridSize
)

 Calculates node grid size. Not thread safe, called within write lock.
Public function Const UFunction BlueprintCallable, Category bool

Contains ( UPCGNode* Node
)

  
Public function Const bool  
Public function Static void

DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

  
Public function void  
Public function void  
Public function UFunction BlueprintCallable, Category void  
Public function void  
Public function void  
Public function void

ForEachNode ( const TFunction< void(UPCGNode*)>& Action
)

 Calls the lambda on every node in graph.
Public function Const EPCGHiGenGrid Default grid size for generation. For hierarchical generation, nodes outside of grid size graph ranges will generate on this grid.
Public function Const uint32  
Public function Const const TArray< TObjectPtr< UObject > > &  
Public function Const void

GetGridSizes ( PCGHiGenGrid::FSizeArray& OutGridSizes,
bool& bOutHasUnbounded
)

 Determine the relevant grid sizes by inspecting all HiGenGridSize nodes.
Public function Const UFunction BlueprintCallable, Category UPCGNode * Returns the graph input node
Public function Const uint32

GetNodeGenerationGridSize ( const UPCGNode* InNode,
uint32 InDefaultGridSize
)

 Size of grid on which this node should be executed.
Public function Const UFunction BlueprintCallable, Category const TArray< UPCGNode * > &  
Public function Const UFunction BlueprintCallable, Category UPCGNode * Returns the graph output node
Public function Const void

GetTrackedActorKeysToSettings ( FPCGActorSelectionKeyToSettingsMap& OutKeysToSettings,
TArray< TObjectPtr< const UPCGGraph >>& OutVisitedGraphs
)

  
Public function Const FPCGActorSelectionKeyToSettingsMap  
Public function Const bool  
Public function Const UFunction BlueprintCallable, Category bool  
Public function Const bool  
Protected function void

OnNodeAdded ( UPCGNode* InNode
)

  
Protected function void

OnNodeRemoved ( UPCGNode* InNode
)

  
Public function void

PostNodeUndo ( UPCGNode* InPCGNode
)

  
Public function void

PreNodeUndo ( UPCGNode* InPCGNode
)

  
Public function UFunction BlueprintCallable, Category TObjectPtr< UPCGNode >

ReconstructNewNode ( const UPCGNode* InNode
)

 Duplicate a given node by creating a new node with the same settings and properties, but without any edges and add it to the graph
Public function UFunction BlueprintCallable, Category bool

RemoveEdge ( UPCGNode* From,
const FName& FromLabel,
UPCGNode* To,
const FName& ToLabel
)

 Removes an edge in the graph. Returns true if an edge was removed.
Public function bool

RemoveInboundEdges ( UPCGNode* InNode,
const FName& InboundLabel
)

  
Public function UFunction BlueprintCallable, Category void

RemoveNode ( UPCGNode* InNode
)

 Removes a node from the graph.
Public function bool

RemoveOutboundEdges ( UPCGNode* InNode,
const FName& OutboundLabel
)

  
Public function void

SetExtraEditorNodes ( const TArray< TObjectPtr< const UObject >>& InNodes
)

  
Public function void  
Protected function bool

UserParametersCanRemoveProperty ( FGuid InPropertyID,
FName InPropertyName
)

  
Protected function bool  

Overridden from UPCGGraphInterface

  Type Name Description
Public function Virtual Const const UPCGGraph *  
Public function Virtual UPCGGraph * ~End UObject interface ~Begin UPCGGraphInterface interface
Public function Virtual Const const FInstancedPropertyBag *  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void ~Begin UObject interface
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

 This is called when a property is about to be modified externally

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page