UPCGClusterSettings | Unreal Engine 5.6 Documentation

API > API/Plugins > API/Plugins/PCG

Given a desired number of clusters (categories), find the best fit cluster for each point by distance, using one of various clustering algorithms.


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

Syntax

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

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UPCGData → UPCGSettingsInterface → UPCGSettings → UPCGClusterSettings

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UPCGClusterSettings ( const FObjectInitializer& ObjectInitializer )		Elements/PCGClusterElement.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
Algorithm	EPCGClusterAlgorithm	Mathematical algorithm for selecting clusters.	Elements/PCGClusterElement.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(PCG_Overridable)
bOutputFinalCentroidElementCount	bool	Output the element count for each of the final centroids.	Elements/PCGClusterElement.h	EditAnywhere BlueprintReadWrite Category=Settings AdvancedDisplay Meta=(EditCondition="bOutputFinalCentroids", EditConditionHides, PCG_Overridable)
bOutputFinalCentroids	bool	Output the final location of the centroids or gaussians.	Elements/PCGClusterElement.h	EditAnywhere BlueprintReadWrite Category=Settings AdvancedDisplay
ClusterAttribute	FPCGAttributePropertyOutputNoSourceSelector	Cluster IDs will be written to this attribute on the main output.	Elements/PCGClusterElement.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(PCG_Overridable)
FinalCentroidElementCountAttribute	FPCGAttributePropertyOutputNoSourceSelector	Final centroid element count will be written to this attribute on the Final Centroid output.	Elements/PCGClusterElement.h	EditAnywhere BlueprintReadWrite Category=Settings AdvancedDisplay Meta=(EditCondition="bOutputFinalCentroidElementCount", EditConditionHides, PCG_Overridable)
MaxIterations	int32	A limit on the number of iterations to run on each algorithm, if it doesn't otherwise converge.	Elements/PCGClusterElement.h	EditAnywhere BlueprintReadWrite Category=Settings AdvancedDisplay Meta=(ClampMin="1", PCG_Overridable)
NumClusters	int32	Number of clusters (segments) to group the points into.	Elements/PCGClusterElement.h	EditAnywhere BlueprintReadWrite Category=Settings DisplayName="Clusters" Meta=(ClampMin="1", PCG_Overridable)
Tolerance	double	For EM, the maximum allowed difference between the last two iterations' "Log Likelihood"which converges from positive infinity to 0 in relation to point-to-cluster probabilities.	Elements/PCGClusterElement.h	EditAnywhere BlueprintReadWrite Category=Settings AdvancedDisplay Meta=(ClampMin="0.0001", EditCondition="Algorithm == EPCGClusterAlgorithm::EM", EditConditionHides, PCG_Overridable)

Functions

Public

Overridden from UPCGSettings

Name	Remarks	Include Path
virtual FName GetDefaultNodeName()		Elements/PCGClusterElement.h
virtual FText GetDefaultNodeTitle()		Elements/PCGClusterElement.h
virtual FText GetNodeTooltipText()		Elements/PCGClusterElement.h
virtual EPCGSettingsType GetType()		Elements/PCGClusterElement.h
virtual bool UseSeed ()	By default, settings do not use a seed.	Elements/PCGClusterElement.h

Protected

Overridden from UPCGSettings

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

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Public

Functions

Public

Overridden from UPCGSettings

Protected

Overridden from UPCGSettings