1. Epic GamesDeveloper
  3. UPCGSettings

UPCGSettings

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

API > API/Plugins > API/Plugins/PCG

Inheritance Hierarchy

References

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

Syntax

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

Remarks

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

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool bDumpCookedHLSL [EXPERIMENTAL] Note: This variable is subject to change without deprecation.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool bDumpDataDescriptions [EXPERIMENTAL] Note: This variable is subject to change without deprecation.
Protected variable UProperty Category, EditAnywhere, Meta bool bExecuteOnGPU [EXPERIMENTAL] Note: This variable is subject to change without deprecation.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite assetregistrysearchable bool bExposeToLibrary  
Protected variable bool bHasAnyOverridableHardReferences We need to make sure that if we have hard references that are overridable, and they are overriden by paths on objects that are not yet loaded, that we are loading it on the main thread.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool bPrintShaderDebugValues [EXPERIMENTAL] Note: This variable is subject to change without deprecation.
Protected variable UProperty Meta Transient bool bUseSeed  
Protected variable UProperty TArray< FPCGSettingsOverridableParam > CachedOverridableParams Needs to be serialized since property metadata (used to populate this array) is not available at runtime.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite assetregistrysearchable FText Category  
Public variable int32 DataVersion The version number of the data after load and after any data migration.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta int DebugBufferSize [EXPERIMENTAL] Note: This variable is subject to change without deprecation.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite assetregistrysearchable FText Description  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite FPCGDeterminismSettings DeterminismSettings  
Public variable const UPCGSettings * OriginalSettings Holds the original settings used to duplicate this object if it was overridden.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite int Seed  
Public variable int32 UserDataVersion If a custom version guid was provided through GetUserCustomVersionGuid(), this field will hold the version number after load and after any data migration.

Functions

  Type Name Description
Public function Virtual Const FName  
Public function Virtual Const void

AddStaticCreatedStrings ( TArray< FString >& InOutStringTable
)

 [EXPERIMENTAL] Add any strings emitted by this node that are known statically at compile time.
Public function Const TArray< FPCGPinProperties > Return the concatenation of InputPinProperties and FillOverridableParamsPins
Public function Const TArray< FPCGPinProperties > For symmetry reason, do the same with output pins.
Public function Virtual void

ApplyDeprecation ( UPCGNode* InOutNode
)

 Any final migration/recovery that can be done after pins are finalized.
Public function 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.
Public function Virtual void  
Public function Virtual void If settings require structural changes, this will apply them
Protected function Const UFunction BlueprintCallable, Category displayname int32

BP_GetTypeUnionOfIncidentEdges ( const FName& PinLabel
)

 BP version since EPCGDataType is uint32 and BP only supports uint8 enums.
Public function Virtual Const bool True if we can safely cull this node & task if it has unwired non-advanced inputs.
Public function Virtual Const bool Derived classes must implement this to communicate that they might have dynamic dependencies.
Protected function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Passthrough for the simpler method, to avoid modifying the child settings already overriding this method.
Protected function Virtual Const bool

CanEditChange ( const FEditPropertyChain& InPropertyChain
)

 We need the more complex function (with PropertyChain) to detect child properties in structs, if they are overridable.
Public function Virtual Const bool Returns whether the user can directly interact with the node name
Public function Virtual Const int

ComputeKernelThreadCount ( const UPCGDataBinding* Binding
)

 [EXPERIMENTAL] Compute how many threads should be dispatched to execute this node on the GPU.
Public function Virtual Const bool

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

 [EXPERIMENTAL] Compute a description of data that will be output from OutputPinLabel/OutputPin.
Public function Const bool

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

 [EXPERIMENTAL] Compute a description of data that will be output from OutputPinLabel/OutputPin.
Public function Virtual Const void

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

 [EXPERIMENTAL] Create additional input data interfaces to marshal any required input data.
Public function Virtual Const void

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

 [EXPERIMENTAL] Create additional output data interfaces to marshal any required output data.
Public function Virtual Const void  
Protected function Virtual Const FPCGElementPtr  
Public function Virtual Const UPCGNode *  
Public function Virtual Const TArray< FPCGPinProperties > Internal functions, should not be used by any user.
Public function Virtual Const TArray< FPCGPinProperties >  
Protected function Const TArray< FPCGPinProperties > Methods to remove boilerplate code across settings
Protected function Const TArray< FPCGPinProperties >  
Protected function void Method that can be called to dirty the cache data from this settings objects if the operator== does not allow to detect changes
Public function Virtual Const UFunction bool [EXPERIMENTAL] Whether to display GPU execution option in node settings UI.
Public function Virtual Const bool By default, the first non-Advanced pin that supports pass-through will be selected.
Protected function Const void Iterate over OverridableParams to automatically add param pins to the list.
Protected function Virtual Const void There is a weird issue where the BP class is not set correctly in some Server cases.
Protected function Virtual Const TArray< FPCGSettingsOverridableParam > Can be overridden to add more custom params (like in BP).
Public function Virtual Const FString Derived classes can implement this to expose additional information or context, such as an asset in use by the node.
Public function Const const FPCGCrc & Get the Crc value precomputed for these settings.
Protected function Virtual Const EPCGChangeType

GetChangeTypeForProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Gets the change impact for a given property.
Protected function Virtual Const EPCGChangeType

GetChangeTypeForProperty ( const FName& InPropertyName
)

 Gets the change impact for a given property.
Public function Virtual Const bool

GetCompactNodeIcon ( FName& OutCompactNodeIcon
)

 Returns the icon to use instead of text in compact node form
Public function Virtual Const FString

GetCookedKernelSource ( const TMap< FName, FPCGKernelAttributeIDAndType >& GlobalAttributeLookupTable
)

 [EXPERIMENTAL] Produces the node specific portion of kernel shader source text, including the main entry point.
Public function Virtual Const EPCGDataType

GetCurrentPinTypes ( const UPCGPin* InPin
)

 Returns the current pin types, which can either be the static types from the pin properties, or a dynamic type based on connected edges.
Public function Virtual Const FName  
Public function Virtual Const FText  
Public function Const FPCGElementPtr TODO: check if we need this to be virtual, we don't really need if we're always caching.
Public function Virtual Const UObject * 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.
Public function Virtual Const void

GetKernelAttributeKeys ( TArray< FPCGKernelAttributeKey >& OutKeys
)

 [EXPERIMENTAL] Get a list of the attributes read or written by this node.
Public function Virtual Const TArray< FText > 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.
Public function Virtual Const FLinearColor  
Public function Virtual Const FText  
Public function Virtual Const bool

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

 Can override to add a custom icon next to the pin label (and an optional tooltip).
Public function Virtual Const bool

GetPinLabelStyle ( const UPCGPin* InPin,
FName& OutLabelStyle
)

 Can override the label style for a pin. Return false if no override is available.
Public function Virtual Const TArray< FPCGPreConfiguredSettingsInfo > Return preconfigured info that will be filled in the editor palette action, allowing to create pre-configured settings
Public function Const PRAGMA_ENABLE_DEPRECATION_WARNINGS int

GetSeed ( const UPCGComponent* InSourceComponent
)

 Get the seed, combined with optional PCGComponent seed.
Public function Const uint64 Returns Original UID when this is a duplicated settings so we can compare successive executions for reuse cases.
Public function Virtual Const void

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

 Derived classes must implement this to communicate dependencies that are known statically.
Public function Virtual Const EPCGSettingsType

GetType ()

  
Protected function Virtual Const uint32 Can be overriden by child class if they ever got renamed to avoid changing the default seed for this one.
Public function Const EPCGDataType

GetTypeUnionOfIncidentEdges ( const FName& PinLabel
)

 Bitwise union of the allowed types of each incident edge on pin.
Protected function Virtual FGuid An additional custom version number that external system users can use to track versions.
Public function Virtual Const bool 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.
Public function Const bool  
Public function Virtual Const bool If the node has any dynamic pins that can change based on input or settings
Public function Virtual Const bool Display generated title line as primary title (example: BP nodes display the blueprint name as the primary title).
Public function Virtual Const bool

HasOverridableParam ( FName InParamName
)

 Checks if a label matches an overridable param
Public function Virtual Const bool Check if we have some override. Can be overriden to force params pin for example
Protected function void Called after intialization to construct the list of all overridable params.
Public function Virtual Const TArray< FPCGPinProperties > Returns an array of all the input pin properties. You should not add manually a "params" pin, it is handled automatically by FillOverridableParamsPins.
Public function Virtual Const bool 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.
Public function Virtual Const bool

IsKernelValid ( FPCGContext* InContext,
bool bQuiet
)

 [EXPERIMENTAL] Performs validation and returns true if this node is suitable for deployment to the GPU.
Public function Virtual Const bool

IsPinStaticallyActive ( const FName& OutputPinLabel
)

 True if we know prior to execution that the given pin will be active (not on inactive branch).
Public function Virtual Const bool Returns true if InPin is in use by node (assuming node enabled).
Public function Virtual Const bool

IsPropertyOverriddenByPin ( const FProperty* InProperty
)

 Returns true if the given property is overridden by graph parameters
Public function Virtual Const bool

IsPropertyOverriddenByPin ( FName PropertyName
)

 Returns true if the base property, given by name, is overridden by graph parameters
Public function Virtual Const bool

IsPropertyOverriddenByPin ( const TArrayView< const FName >& PropertyNameChain
)

 Returns true if the property, given by chain of property names, is overridden by graph parameters
Protected function Virtual Const bool

IsStructuralProperty ( const FName& InPropertyName
)

  
Public function Virtual Const bool If there are preconfigured info, we can skip the default settings and only expose pre-configured actions in the editor palette
Public function Virtual Const bool Returns true if only the first input edge is used from the primary pin when the node is disabled.
Public function void

OnOverrideSettingsDuplicated ( bool bSkippedPostLoad
)

  
Protected function 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
Public function Virtual Const TArray< FPCGPinProperties >  
Public function Virtual Const bool Whether this node can deactivate its output pins during execution, which can dynamically cull downstream nodes.
Public function Virtual Const const TArray< FPCGSettingsOverridableParam > & Overridable param section.
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void Perform post-operations when an editor node is copied
Public function Virtual void

PostSaveRoot ( FObjectPostSaveRootContext ObjectSaveContext
)

  
Public function Virtual Const bool Check if we need to hook the output of the pre-task to this.
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function Virtual Const bool Puts node title on node body, reducing overall node size
Public function Virtual Const bool GPU section.
Public function Virtual Const UFunction PRAGMA_DISABLE_DEPRECATION_WARNINGS bool

UseSeed ()

 By default, settings do not use a seed.

Overridden from UPCGSettingsInterface

  Type Name Description
Public function Virtual Const const UPCGSettings *  
Public function Virtual UPCGSettings *  

Overridden from UPCGData

  Type Name Description
Public function Virtual Const void

AddToCrc ( FArchiveCrc32& Ar,
bool bFullDataCrc
)

 Adds this data to Crc. Fallback implementation writes object instance UID.
Public function Virtual Const EPCGDataType  

Operators

  Type Name Description
Public function Const bool

operator== ( const UPCGSettings& Other
)

  

Deprecated Variables

  Type Name Description
Public variable UProperty EPCGSettingsExecutionMode ExecutionMode_DEPRECATED  
Public variable UProperty TSet< FString > TagsAppliedOnOutput_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page