1. Epic GamesDeveloper
  3. UPCGGraph

UPCGGraph

API > API/Plugins > API/Plugins/PCG

Inheritance Hierarchy

References

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

Syntax

UCLASS (BlueprintType, ClassGroup=(Procedural), HideCategories=(Object))  
class UPCGGraph : public UPCGGraphInterface

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere bool bDebugFlagAppliesToIndividualComponents When true the Debug flag in the graph editor will display debug information contextually for the selected debug object.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite assetregistrysearchable bool bExposeToLibrary  
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite bool bIsEditorOnly Sets whether this graph is marked as editor-only; note that the IsEditorOnly call depends on the local graph value and the value in all subgraphs, recursively.
Public variable UProperty Category, EditAnywhere bool bLandscapeUsesMetadata  
Protected variable UProperty Category, EditAnywhere bool bUseHierarchicalGeneration  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite assetregistrysearchable FText Category  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite assetregistrysearchable FText Description  
Protected variable UProperty TArray< TObjectPtr< UObject > > ExtraEditorNodes Extra data to hold information that is useful only in editor (like comments)
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FPCGRuntimeGenerationRadii GenerationRadii  
Protected variable UProperty Category, EditAnywhere, Meta EPCGHiGenGrid HiGenGridSize  
Protected variable UProperty Category, Meta BlueprintReadOnly visibleanywhere TObjectPtr< UPCGNode > InputNode Add input/output nodes.
Protected variable UProperty Category, Meta BlueprintReadOnly visibleanywhere TArray< TObjectPtr< UPCGNode > > Nodes  
Protected variable TMap< const UPCGNode *, uint32 > NodeToGridSize Execution grid size for nodes.
Protected variable FRWLock NodeToGridSizeLock  
Protected variable UProperty Category, Meta BlueprintReadOnly visibleanywhere TObjectPtr< UPCGNode > OutputNode  
Protected variable TObjectPtr< UPCGEditorGraph > PCGEditorGraph Editor graph created from PCG Editor but owned by this, reference is collected using AddReferencedObjects.
Protected variable UProperty Category, EditAnywhere, Meta FInstancedPropertyBag UserParameters Parameters.

Constructors

  Type Name Description
Public function  

UPCGGraph ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category 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 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 UFunction BlueprintCallable, Category, Meta UPCGNode *

AddNodeCopy ( const UPCGSettings* InSettings,
UPCGSettings*& DefaultNodeSettings
)

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

AddNodeInstance ( UPCGSettings* InSettings
)

 Creates a node containing an instance to the given settings. Returns the created node.
Public function UFunction BlueprintCallable, Category, Meta UPCGNode *

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

 Creates a default node based on the settings class wanted. Returns the newly created node.
Public function UPCGNode *

AddNodeOfType ( T*& DefaultNodeSettings
)

  
Public function void

AddNodes ( TArray< UPCGNode* >& InNodes
)

  
Protected function void  
Public function Static void

AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

  
Public function void

AddUserParameters ( const TArray< FPropertyBagPropertyDesc >& InDescs,
const UPCGGraph* InOptionalOriginalGraph
)

 Add new user parameters using an array of descriptors.
Public function Virtual void  
Protected function Const uint32

CalculateNodeGridSizeRecursive_Unsafe ( const UPCGNode* InNode,
uint32 InDefaultGridSize
)

 Calculates node grid size. Not thread safe, must be called within write lock.
Public function Const bool

Contains ( const UPCGGraph* InGraph
)

 Returns true if the current graph contains a subgraph node using statically the specified graph, recursively.
Public function Const bool

Contains ( UPCGNode* Node
)

 Returns true if the current graph contains directly the specified node.
Public function Const bool  
Public function Static void

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

  
Public function void  
Public function void  
Public function void

EnableInspection ( const FPCGStack& InInspectedStack
)

  
Public function void  
Public function Const UPCGNode *

FindNodeWithSettings ( const UPCGSettingsInterface* InSettings,
bool bRecursive
)

 Returns the node with the given settings in the graph, if any
Public function UFunction BlueprintCallable, Category void  
Public function Const bool

ForEachNode ( TFunctionRef< bool(UPCGNode*)> Action
)

 Calls the lambda on every node in the graph or until the Action call returns false
Public function Const bool Calls the lambda on every node (going through subgraphs too) or until the Action call returns false
Protected function Const bool

ForEachNodeRecursively_Internal ( TFunctionRef< bool(UPCGNode*)> Action,
TSet< const UPCGGraph* >& VisitedGraphs
)

  
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 const TArray< UPCGNode * > &  
Public function Const UFunction BlueprintCallable, Category UPCGNode * Returns the graph output node
Public function Const void

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

  
Public function Const FPCGSelectionKeyToSettingsMap  
Public function Virtual Const bool  
Protected function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Protected function void

OnNodeAdded ( UPCGNode* InNode,
bool bNotify
)

 Internal function to react to add/remove nodes.
Protected function void

OnNodeRemoved ( UPCGNode* InNode,
bool bNotify
)

  
Protected function void

OnNodesAdded ( TArrayView< UPCGNode* > InNodes,
bool bNotify
)

  
Protected function void

OnNodesRemoved ( TArrayView< UPCGNode* > InNodes,
bool bNotify
)

  
Public function void  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void ~Begin UObject interface
Public function void

PostNodeUndo ( UPCGNode* InPCGNode
)

  
Public function Virtual void

PreEditChange ( FProperty* InProperty
)

  
Public function void

PreNodeUndo ( UPCGNode* InPCGNode
)

  
Public function bool Instruct the graph compiler to cache the relevant permutations of this graph.
Public function bool Trigger a recompilation of the relevant permutations of this graph and check for change in the compiled tasks.
Public function 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 void

RemoveExtraEditorNode ( const UObject* InNode
)

  
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 UFunction BlueprintCallable, Category void

RemoveNodes ( TArray< UPCGNode* >& InNodes
)

 Bulk removal of nodes, to avoid notifying the world everytime.
Protected function void  
Public function bool

RemoveOutboundEdges ( UPCGNode* InNode,
const FName& OutboundLabel
)

  
Public function void

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

  
Public function void  
Protected function UFunction blueprintinternaluseonly bool

UserParametersCanRemoveProperty ( FGuid InPropertyID,
FName InPropertyName
)

  
Protected function UFunction blueprintinternaluseonly bool

UserParametersIsPinTypeAccepted ( FEdGraphPinType InPinType,
bool bIsChild
)

  

Overridden from UPCGGraphInterface

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

OnGraphParametersChanged ( EPCGGraphParameterEvent InChangeType,
FName InChangedPropertyName
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page