1. Epic GamesDeveloper
  3. UPCGSettings

UPCGSettings

Base class for settings-as-data in the PCG framework

API > API/Plugins > API/Plugins/PCG

Base class for settings-as-data in the PCG framework

   
Name UPCGSettings
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/PCGSettings.h
Include Path #include "PCGSettings.h"

Syntax

UCLASS (MinimalAPI, Abstract, BlueprintType, ClassGroup=(Procedural))  
class UPCGSettings : public UPCGSettingsInterface

Inheritance Hierarchy

Derived Classes

UPCGSettings derived class hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDumpCookedHLSL bool [EXPERIMENTAL] Note: This variable is subject to change without deprecation. PCGSettings.h
  • EditAnywhere
  • Category="GPU"
  • AdvancedDisplay
  • Meta=(ToolTip="Dump the cooked HLSL into the log after it is generated.", EditCondition="bExecuteOnGPU", EditConditionHides)
bDumpDataDescriptions bool [EXPERIMENTAL] Note: This variable is subject to change without deprecation. PCGSettings.h
  • EditAnywhere
  • Category="GPU"
  • AdvancedDisplay
  • Meta=(ToolTip="Dump the data descriptions of input/output pins to the log.", EditCondition="bExecuteOnGPU", EditConditionHides)
bExecutionDependencyRequired bool If enabled, the execution dependency pin will require to be connected for execution (as any other required pin) and will be used for culling. PCGSettings.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • AdvancedDisplay
  • Meta=(EditCondition="CanUseExecutionDependencyPinForCulling()", EditConditionHides)
bExposeToLibrary bool   PCGSettings.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=AssetInfo
  • AssetRegistrySearchable
bPrintShaderDebugValues bool [EXPERIMENTAL] Note: This variable is subject to change without deprecation. PCGSettings.h
  • EditAnywhere
  • Category="GPU"
  • AdvancedDisplay
  • Meta=(ToolTip="Enable use of 'WriteDebugValue(uint Index, float Value)' function in your kernel. Allows you to write float values to a buffer for logging on the CPU.", EditCondition="bExecuteOnGPU", EditConditionHides)
Category FText   PCGSettings.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=AssetInfo
  • AssetRegistrySearchable
DataVersion int32 The version number of the data after load and after any data migration. PCGSettings.h  
DebugBufferSize int [EXPERIMENTAL] Note: This variable is subject to change without deprecation. PCGSettings.h
  • EditAnywhere
  • Category="GPU"
  • AdvancedDisplay
  • Meta=(ToolTip="Size (in number of floats) of the shader debug print buffer.", EditCondition="bExecuteOnGPU && bPrintShaderDebugValues", EditConditionHides)
Description FText   PCGSettings.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=AssetInfo
  • AssetRegistrySearchable
DeterminismSettings FPCGDeterminismSettings   PCGSettings.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Debug
  • AdvancedDisplay
  • Meta=(DisplayName="Determinism", NoResetToDefault)
OriginalSettings const UPCGSettings * Holds the original settings used to duplicate this object if it was overridden. PCGSettings.h  
Seed int   PCGSettings.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(EditCondition="UseSeed()", EditConditionHides, PCG_Overridable)
UserDataVersion int32 If a custom version guid was provided through GetUserCustomVersionGuid(), this field will hold the version number after load and after any data migration. PCGSettings.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedCrc FPCGCrc The cached Crc for these settings. PCGSettings.h  
CachedElement FPCGElementPtr   PCGSettings.h  
CacheLock FCriticalSection   PCGSettings.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual FName AdditionalTaskName()

   PCGSettings.h  

virtual void AddStaticCreatedStrings ( TArray< FString >& InOutStringTable
) const

   PCGSettings.h  

TArray< FPCGPinProperties > AllInputPinProperties()

 Return the concatenation of InputPinProperties, ExecutionDependencyPin, and FillOverridableParamsPins PCGSettings.h  
For symmetry reason, do the same with output pins. PCGSettings.h  

virtual void ApplyDeprecation ( UPCGNode* InOutNode
)

 Any final migration/recovery that can be done after pins are finalized. PCGSettings.h  

virtual void ApplyDeprecationBeforeUpdatePins ( UPCGNode* InOutNode,
TArray< TObjectPtr< UPCGPin > >& InputPins,
TArray< TObjectPtr< UPCGPin > >& OutputPins
)

 UpdatePins will kick off invalid edges, so this is useful for moving edges around in case of pin changes. PCGSettings.h  

virtual void ApplyPreconfiguredSettings ( const FPCGPreConfiguredSettingsInfo& PreconfigureInfo
)

   PCGSettings.h  

virtual void ApplyStructuralDeprecation ( UPCGNode* InOutNode
)

 If settings require structural changes, this will apply them PCGSettings.h  

virtual bool CanCullTaskIfUnwired ()

 True if we can safely cull this node & task if it has unwired non-advanced inputs. PCGSettings.h  

virtual bool CanDynamicallyTrackKeys()

 Derived classes must implement this to communicate that they might have dynamic dependencies. PCGSettings.h  

bool CanUseExecutionDependencyPinForCulling()

 Returns whether the execution dependency pin can be configured to be used for culling. PCGSettings.h  

virtual bool CanUserEditTitle()

 Returns whether the user can directly interact with the node name PCGSettings.h  

virtual int ComputeKernelThreadCount ( const UPCGDataBinding* Binding
) const

   PCGSettings.h  

bool ComputeOutputPinDataDesc ( const FName& OutputPinLabel,
const UPCGDataBinding* InBinding,
FPCGDataCollectionDesc& OutDesc
) const

   PCGSettings.h  

virtual bool ComputeOutputPinDataDesc ( const UPCGPin* OutputPin,
const UPCGDataBinding* InBinding,
FPCGDataCollectionDesc& OutDesc
) const

   PCGSettings.h  

virtual bool ConvertNode ( const FPCGPreconfiguredInfo& ConversionInfo
)

 Convert this owning node into the corresponding target. Returns true upon success. PCGSettings.h  

virtual void CreateAdditionalInputDataInterfaces ( FPCGGPUCompilationContext& InOutContext,
UObject* InObjectOuter,
TArray< TObjectPtr< class UComputeDataInterface > >& OutDataInterfaces
) const

   PCGSettings.h  

virtual void CreateAdditionalOutputDataInterfaces ( FPCGGPUCompilationContext& InOutContext,
UObject* InObjectOuter,
TArray< TObjectPtr< class UComputeDataInterface > >& OutDataInterfaces
) const

   PCGSettings.h  

virtual void CreateAdditionalOutputDataInterfaces ( TArray< TObjectPtr< class UComputeDataInterface > >& OutDataInterfaces
) const

   PCGSettings.h  

virtual void CreateKernels ( FPCGGPUCompilationContext& InOutContext,
UObject* InObjectOuter,
TArray< UPCGComputeKernel* >& OutKernels,
TArray< FPCGKernelEdge >& OutEdges
) const

 [EXPERIMENTAL] Create the GPU kernels and kernel edges that should execute for this node. PCGSettings.h  

virtual UPCGNode * CreateNode()

   PCGSettings.h  
Internal functions, should not be used by any user. PCGSettings.h  

virtual TArray< FPCGPinProperties > DefaultOutputPinProperties()

   PCGSettings.h  

virtual bool DisplayExecuteOnGPUSetting ()

 [EXPERIMENTAL] Whether to display GPU execution option in node settings UI. PCGSettings.h  

virtual bool DoesOutputPinRequireElementCounters ( const UPCGPin* OutputPin
) const

   PCGSettings.h  

virtual bool DoesPinSupportPassThrough ( UPCGPin* InPin
) const

 By default, the first non-Advanced pin that supports pass-through will be selected. PCGSettings.h  

virtual FString GetAdditionalTitleInformation()

 Derived classes can implement this to expose additional information or context, such as an asset in use by the node. PCGSettings.h  

const FPCGCrc & GetCachedCrc()

   PCGSettings.h  

virtual bool GetCompactNodeIcon ( FName& OutCompactNodeIcon
) const

 Returns the icon to use instead of text in compact node form PCGSettings.h  

virtual TArray< FPCGPreconfiguredInfo > GetConversionInfo()

 The predefined parameters defining the conversion. PCGSettings.h  

virtual FString GetCookedKernelSource ( const UPCGComputeGraph* InComputeGraph
) const

   PCGSettings.h  

virtual EPCGDataType GetCurrentPinTypes ( const UPCGPin* InPin
) const

 Returns the current pin types, which can either be the static types from the pin properties, or a dynamic type based on connected edges. PCGSettings.h  

virtual void GetDataLabels ( FName InPinLabel,
TArray< FString >& OutDataLabels
) const

   PCGSettings.h  

virtual FName GetDefaultNodeName()

   PCGSettings.h  

virtual FText GetDefaultNodeTitle()

   PCGSettings.h  

FPCGElementPtr GetElement()

 TODO: check if we need this to be virtual, we don't really need if we're always caching. PCGSettings.h  
Override this class to provide an UObject to jump to in case of double click on node ie. returning a blueprint instance will open the given blueprint in its editor. PCGSettings.h  

virtual void GetKernelAttributeKeys ( TArray< struct FPCGKernelAttributeKey >& OutKeys
) const

   PCGSettings.h  

virtual TArray< FText > GetNodeTitleAliases()

 List of extra aliases that will be added to the node list in the Editor.Useful when we rename a node, but we still want the user to find the old one. PCGSettings.h  

virtual FLinearColor GetNodeTitleColor()

   PCGSettings.h  

virtual FText GetNodeTooltipText()

   PCGSettings.h  

virtual bool GetPinExtraIcon ( const UPCGPin* InPin,
FName& OutExtraIcon,
FText& OutTooltip
) const

 Can override to add a custom icon next to the pin label (and an optional tooltip). PCGSettings.h  

virtual bool GetPinLabelStyle ( const UPCGPin* InPin,
FName& OutLabelStyle
) const

 Can override the label style for a pin. Return false if no override is available. PCGSettings.h  

virtual TArray< FPCGPreConfiguredSettingsInfo > GetPreconfiguredInfo()

 Return preconfigured info that will be filled in the editor palette action, allowing to create pre-configured settings PCGSettings.h  

int GetSeed ( const IPCGGraphExecutionSource* InExecutionSource
) const

 Get the seed, combined with optional ExecutionSource seed. PCGSettings.h  

FPCGCrc GetSettingsCrc()

   PCGSettings.h  

uint64 GetStableUID()

 Returns Original UID when this is a duplicated settings so we can compare successive executions for reuse cases. PCGSettings.h  

virtual void GetStaticTrackedKeys ( FPCGSelectionKeyToSettingsMap& OutKeysToSettings,
TArray< TObjectPtr< const UPCGGraph > >& OutVisitedGraphs
) const

 Derived classes must implement this to communicate dependencies that are known statically. PCGSettings.h  

virtual EPCGSettingsType GetType()

   PCGSettings.h  

EPCGDataType GetTypeUnionOfIncidentEdges ( const FName& PinLabel
) const

 Bitwise union of the allowed types of each incident edge on pin. PCGSettings.h  

virtual bool GroupPreconfiguredSettings()

 If there are preconfigured info, decide if they are grouped in the palette in a folder with the node name, or if they are not grouped. PCGSettings.h  

bool HasAnyOverridableHardReferences()

   PCGSettings.h  

virtual bool HasDynamicPins()

 If the node has any dynamic pins that can change based on input or settings PCGSettings.h  

virtual bool HasFlippedTitleLines()

 Display generated title line as primary title (example: BP nodes display the blueprint name as the primary title). PCGSettings.h  

virtual bool HasOverridableParam ( FName InParamName
) const

 Checks if a label matches an overridable param PCGSettings.h  

virtual bool HasOverridableParams()

 Check if we have some override. Can be overriden to force params pin for example PCGSettings.h  

virtual TArray< FPCGPinProperties > InputPinProperties()

 Returns an array of all the input pin properties. You should not add manually a "params" pin, it is handled automatically by FillOverridableParamsPins. PCGSettings.h  

virtual bool IsInputPinRequiredByExecution ( const UPCGPin* InPin
) const

 By default a node does not specify any pin requirements, and will execute if it has no non-advanced pins or if it has any active connection to any pin. PCGSettings.h  

virtual bool IsKernelValid ( FPCGContext* InContext,
bool bQuiet
) const

   PCGSettings.h  

virtual bool IsPinStaticallyActive ( const FName& OutputPinLabel
) const

 True if we know prior to execution that the given pin will be active (not on inactive branch). PCGSettings.h  

virtual bool IsPinUsedByNodeExecution ( const UPCGPin* InPin
) const

 Returns true if InPin is in use by node (assuming node enabled). PCGSettings.h  

virtual bool IsPropertyOverriddenByPin ( const FProperty* InProperty
) const

 Returns true if the given property is overridden by graph parameters PCGSettings.h  

virtual bool IsPropertyOverriddenByPin ( FName PropertyName
) const

 Returns true if the base property, given by name, is overridden by graph parameters PCGSettings.h  

virtual bool IsPropertyOverriddenByPin ( const TArrayView< const FName >& PropertyNameChain
) const

 Returns true if the property, given by chain of property names, is overridden by graph parameters PCGSettings.h  

virtual bool OnlyExposePreconfiguredSettings()

 If there are preconfigured info, we can skip the default settings and only expose pre-configured actions in the editor palette PCGSettings.h  

virtual bool OnlyPassThroughOneEdgeWhenDisabled()

 Returns true if only the first input edge is used from the primary pin when the node is disabled. PCGSettings.h  

void OnOverrideSettingsDuplicated ( bool bSkippedPostLoad
)

   PCGSettings.h  

virtual TArray< FPCGPinProperties > OutputPinProperties()

   PCGSettings.h  

virtual bool OutputPinsCanBeDeactivated()

 Whether this node can deactivate its output pins during execution, which can dynamically cull downstream nodes. PCGSettings.h  
Overridable param section. PCGSettings.h  

virtual void PostPaste()

 Perform post-operations when an editor node is copied PCGSettings.h  

virtual bool RequiresDataFromPreTask ()

 Check if we need to hook the output of the pre-task to this. PCGSettings.h  

virtual bool ShouldDrawNodeCompact()

 Puts node title on node body, reducing overall node size PCGSettings.h  

virtual bool ShouldExecuteOnGPU ()

 GPU section. PCGSettings.h  

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS bool UseSeed ()

 By default, settings do not use a seed. PCGSettings.h  

Overridden from UPCGSettingsInterface

Name Remarks Include Path Unreal Specifiers

virtual UPCGSettings * GetSettings ()

   PCGSettings.h  

virtual const UPCGSettings * GetSettings ()

   PCGSettings.h  

Overridden from UPCGData

Name Remarks Include Path Unreal Specifiers

virtual void AddToCrc ( FArchiveCrc32& Ar,
bool bFullDataCrc
) const

 Adds this data to Crc. PCGSettings.h  

virtual EPCGDataType GetDataType()

   PCGSettings.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditUndo()

   PCGSettings.h  

virtual void PostInitProperties()

   PCGSettings.h  

virtual void PostLoad()

   PCGSettings.h  

virtual void PostSaveRoot ( FObjectPostSaveRootContext ObjectSaveContext
)

   PCGSettings.h  

virtual void Serialize ( FArchive& Ar
)

   PCGSettings.h  

Protected

Name Remarks Include Path Unreal Specifiers

int32 BP_GetTypeUnionOfIncidentEdges ( const FName& PinLabel
) const

 BP version since EPCGDataType is uint32 and BP only supports uint8 enums. PCGSettings.h
  • BlueprintCallable
  • Category="Settings|DynamicPins"
  • DisplayName="Get Type Union Of Incident Edges"

virtual FPCGElementPtr CreateElement()

   PCGSettings.h  

TArray< FPCGPinProperties > DefaultPointInputPinProperties()

 Methods to remove boilerplate code across settings PCGSettings.h  

TArray< FPCGPinProperties > DefaultPointOutputPinProperties()

   PCGSettings.h  

void DirtyCache()

 Method that can be called to dirty the cache data from this settings objects if the operator== does not allow to detect changes PCGSettings.h  

void FillOverridableParamsPins ( TArray< FPCGPinProperties >& OutPins
) const

 Iterate over OverridableParams to automatically add param pins to the list. PCGSettings.h  
There is a weird issue where the BP class is not set correctly in some Server cases. PCGSettings.h  

virtual TArray< FPCGSettingsOverridableParam > GatherOverridableParams()

 Can be overridden to add more custom params (like in BP). PCGSettings.h  

virtual EPCGChangeType GetChangeTypeForProperty ( FPropertyChangedEvent& PropertyChangedEvent
) const

 Gets the change impact for a given property. PCGSettings.h  

virtual EPCGChangeType GetChangeTypeForProperty ( const FName& InPropertyName
) const

 Gets the change impact for a given property. PCGSettings.h  

virtual uint32 GetTypeNameHash ()

 Can be overriden by child class if they ever got renamed to avoid changing the default seed for this one. PCGSettings.h  
An additional custom version number that external system users can use to track versions. PCGSettings.h  

virtual bool HasExecutionDependencyPin ()

 Execution Dependency section. PCGSettings.h  

void InitializeCachedOverridableParams ( bool bReset
)

 Called after intialization to construct the list of all overridable params. PCGSettings.h  

virtual bool IsStructuralProperty ( const FName& InPropertyName
) const

   PCGSettings.h  

virtual void OnOverrideSettingsDuplicatedInternal ( bool bSkippedPostLoad
)

 Can be overriden by child class if some fixup code needs to run after duplication in the context of FPCGContext::InitializeSettings PCGSettings.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

 Passthrough for the simpler method, to avoid modifying the child settings already overriding this method. PCGSettings.h  

virtual bool CanEditChange ( const FEditPropertyChain& InPropertyChain
) const

 We need the more complex function (with PropertyChain) to detect child properties in structs, if they are overridable. PCGSettings.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   PCGSettings.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const UPCGSettings& Other
) const

   PCGSettings.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
ExecutionMode_DEPRECATED EPCGSettingsExecutionMode   PCGSettings.h  
TagsAppliedOnOutput_DEPRECATED TSet< FString >   PCGSettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page