UPCGSpatialNoiseSettings | Unreal Engine 5.6 Documentation

Various fractal noises that can be used to filter points


Name	UPCGSpatialNoiseSettings
Type	class
Header File	/Engine/Plugins/PCG/Source/PCG/Public/Elements/PCGSpatialNoise.h
Include Path	#include "Elements/PCGSpatialNoise.h"

Syntax

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

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UPCGData → UPCGSettingsInterface → UPCGSettings → UPCGSpatialNoiseSettings

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UPCGSpatialNoiseSettings()		Elements/PCGSpatialNoise.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
Brightness	float		Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(PCG_Overridable)
bTiling	bool	If true, will generate results that tile along the bounding box size of the	Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(PCG_Overridable)
bVoronoiOrientSamplesToCellEdge	bool	If true it will orient the output points to point towards the cell edges, which can be used for effects.	Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(EditCondition="Mode == PCGSpatialNoiseMode::Voronoi2D", EditConditionHides, PCG_Overridable)
Contrast	float		Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(PCG_Overridable)
EdgeBlendCurveIntensity	float	Will makes the falloff harsher or softer	Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(EditCondition="Mode == PCGSpatialNoiseMode::EdgeMask2D", EditConditionHides, ClampMin="0", PCG_Overridable)
EdgeBlendCurveOffset	float	Adjust the center point of the curve (where x = curve(x) crosses over)	Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(EditCondition="Mode == PCGSpatialNoiseMode::EdgeMask2D", EditConditionHides, ClampMin="0", PCG_Overridable)
EdgeBlendDistance	float	If > 0, we blend to a tiling edge value	Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(EditCondition="Mode == PCGSpatialNoiseMode::EdgeMask2D", EditConditionHides, PCG_Overridable)
EdgeMask2DMode	PCGSpatialNoiseMask2DMode		Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(EditCondition="Mode == PCGSpatialNoiseMode::EdgeMask2D", EditConditionHides, PCG_Overridable)
Iterations	int32	This is how many times the fractal method recurses. A higher number will mean more detail	Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(ClampMin="1", ClampMax="100", EditCondition="Mode != PCGSpatialNoiseMode::Voronoi2D", EditConditionHides, PCG_Overridable)
Mode	PCGSpatialNoiseMode	The noise method used.	Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(PCG_Overridable)
RandomOffset	FVector	Adds a random amount of offset up to this amount.	Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(PCG_Overridable)
TiledVoronoiEdgeBlendCellCount	int32	How many cells around the edge will tile	Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(EditCondition="Mode == PCGSpatialNoiseMode::Voronoi2D && bTiling", EditConditionHides, PCG_Overridable)
TiledVoronoiResolution	int32	The cell resolution of the tiled voronoi (across the bounds)	Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(EditCondition="Mode == PCGSpatialNoiseMode::Voronoi2D && bTiling", EditConditionHides, PCG_Overridable, ClampMin="1")
Transform	FTransform	This will apply a transform to the points before calculating noise	Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(EditCondition="Mode != PCGSpatialNoiseMode::Voronoi2D \|\| !bTiling", EditConditionHides, PCG_Overridable)
ValueTarget	FPCGAttributePropertyOutputNoSourceSelector	The output attribute name to write, if not 'None'.	Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(PCG_Overridable)
VoronoiCellIDTarget	FPCGAttributePropertyOutputNoSourceSelector	The output attribute name to write the voronoi cell id, if not 'None'.	Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(EditCondition="Mode == PCGSpatialNoiseMode::Voronoi2D", EditConditionHides, PCG_Overridable)
VoronoiCellRandomness	double	The less random this is, the more it returns to being a grid	Elements/PCGSpatialNoise.h	BlueprintReadWrite EditAnywhere Category=Settings Meta=(ClampMin="0.0", ClampMax="1.0", EditCondition="Mode == PCGSpatialNoiseMode::Voronoi2D", EditConditionHides, PCG_Overridable)

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
bForceNoUseSeed	bool	Private field to fix a deprecation issue related to seed usage between UE 5.3 and UE 5.4.	Elements/PCGSpatialNoise.h

Functions

Public

Overridden from UPCGSettings

Name	Remarks	Include Path
virtual void ApplyDeprecation ( UPCGNode* InOutNode )	Any final migration/recovery that can be done after pins are finalized.	Elements/PCGSpatialNoise.h
virtual FName GetDefaultNodeName()		Elements/PCGSpatialNoise.h
virtual FText GetDefaultNodeTitle()		Elements/PCGSpatialNoise.h
virtual EPCGSettingsType GetType()		Elements/PCGSpatialNoise.h
virtual bool UseSeed ()	By default, settings do not use a seed.	Elements/PCGSpatialNoise.h

Protected

Overridden from UPCGSettings

Name	Remarks	Include Path
virtual FPCGElementPtr CreateElement()		Elements/PCGSpatialNoise.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.	Elements/PCGSpatialNoise.h
virtual TArray< FPCGPinProperties > OutputPinProperties()		Elements/PCGSpatialNoise.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Public

Protected

Functions

Public

Overridden from UPCGSettings

Protected

Overridden from UPCGSettings