FAutoClusterDataflowNode | Unreal Engine 5.6 Documentation

API > API/Plugins > API/Plugins/GeometryCollectionNodes

Automatically group pieces of a fractured Collection into a specified number of clusters


Name	FAutoClusterDataflowNode
Type	struct
Header File	/Engine/Plugins/Experimental/GeometryCollectionPlugin/Source/GeometryCollectionNodes/Public/Dataflow/GeometryCollectionClusteringNodes.h
Include Path	#include "Dataflow/GeometryCollectionClusteringNodes.h"

Syntax

USTRUCT (Meta=(DataflowGeometryCollection))  
struct FAutoClusterDataflowNode : public FDataflowNode

Inheritance Hierarchy

FSharedFromThisBase → TSharedFromThis → FDataflowNode → FAutoClusterDataflowNode

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FAutoClusterDataflowNode ( const UE::Dataflow::FNodeParameters& InParam, FGuid InGuid )		Dataflow/GeometryCollectionClusteringNodes.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
AutoCluster	bool	If true, bones will only be added to the same cluster if they are physically connected (either directly, or via other bones in the same cluster)	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category=AutoCluster Meta=(DisplayName="Enforce Cluster Connectivity")
AvoidIsolated	bool	If true, prevent the creation of clusters with only a single child.	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category=AutoCluster
bPreferConvexity	bool	Whether to favor clusters that have a convex shape. (Note: Does not support ByGrid clustering.)	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category=AutoCluster Meta=(EditCondition="ClusterSizeMethod != EClusterSizeMethodEnum::Dataflow_ClusterSizeMethod_ByGrid")
bRandomizeColor	bool	Randomize color per connection	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category="Debug Draw"
CenterColor	FLinearColor		Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category="Debug Draw - Sphere Covering"
CenterSize	float		Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category="Debug Draw - Sphere Covering"
ClusterFraction	float	Choose the number of Voronoi sites used for clustering as a fraction of the number of child bones to process	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category=ClusterSize Meta=(DataflowInput, UIMin=0.f, UIMax=0.5f, EditCondition="ClusterSizeMethod == EClusterSizeMethodEnum::Dataflow_ClusterSizeMethod_ByFractionOfInput")
ClusterGridDepth	int	Choose the number of cluster sites to distribute along the Y axis	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category=ClusterSize Meta=(DataflowInput, ClampMin="1", UIMax="20", EditCondition="ClusterSizeMethod == EClusterSizeMethodEnum::Dataflow_ClusterSizeMethod_ByGrid")
ClusterGridHeight	int	Choose the number of cluster sites to distribute along the Z axis	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category=ClusterSize Meta=(DataflowInput, ClampMin="1", UIMax="20", EditCondition="ClusterSizeMethod == EClusterSizeMethodEnum::Dataflow_ClusterSizeMethod_ByGrid")
ClusterGridWidth	int	Choose the number of cluster sites to distribute along the X axis	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category=ClusterSize Meta=(DataflowInput, ClampMin="1", UIMax="20", EditCondition="ClusterSizeMethod == EClusterSizeMethodEnum::Dataflow_ClusterSizeMethod_ByGrid")
ClusterSites	int32	Use a Voronoi diagram with this many Voronoi sites as a guide for deciding cluster boundaries	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category=ClusterSize Meta=(DataflowInput, UIMin=2, UIMax=5000, EditCondition="ClusterSizeMethod == EClusterSizeMethodEnum::Dataflow_ClusterSizeMethod_ByNumber")
ClusterSizeMethod	EClusterSizeMethodEnum	How to choose the size of the clusters to create	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category=ClusterSize
Collection	FManagedArrayCollection	Fractured GeometryCollection to cluster	Dataflow/GeometryCollectionClusteringNodes.h	Meta=(DataflowInput, DataflowOutput, DataflowPassthrough="Collection", DataflowIntrinsic)
Color	FLinearColor		Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category="Debug Draw"
ColorRandomSeed	int32	Random seed	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category="Debug Draw" Meta=(ClampMin="0", EditCondition="bRandomizeColor==true", EditConditionHides)
ConcavityTolerance	float	If > 0, cube root of maximum concave volume to add per cluster (ignoring concavity of individual parts)	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category=AutoCluster Meta=(EditCondition="bPreferConvexity && ClusterSizeMethod != EClusterSizeMethodEnum::Dataflow_ClusterSizeMethod_ByGrid")
DriftIterations	int	For a grid distribution, optionally iteratively recenter the grid points to the center of the cluster geometry (technically: applying K-Means iterations) to balance the shape and distribution of the clusters	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category=ClusterSize Meta=(DisplayName="Grid Drift Iterations", ClampMin="0", UIMax="5", EditCondition="ClusterSizeMethod == EClusterSizeMethodEnum::Dataflow_ClusterSizeMethod_ByGrid")
EnforceSiteParameters	bool	If true, make sure the site parameters are matched as close as possible ( bEnforceConnectivity can make the number of site larger than the requested input may produce without it )	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category=AutoCluster Meta=(EditCondition="AutoCluster == true")
LineWidthMultiplier	float		Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category="Debug Draw" Meta=(ClampMin="0.1", ClampMax="10.0")
MinimumSize	float	If a cluster has volume less than this value (in cm) cubed, then the auto-cluster process will attempt to merge it into a neighboring cluster.	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category=ClusterSize Meta=(DataflowInput, ClampMin="0")
SiteSize	float	Choose the Edge-Size of the cube used to groups bones under a cluster (in cm).	Dataflow/GeometryCollectionClusteringNodes.h	EditAnywhere Category=ClusterSize Meta=(DataflowInput, DisplayName="Cluster Size", UIMin=".01", UIMax="100", ClampMin=".0001", ClampMax="10000", EditCondition="ClusterSizeMethod == EClusterSizeMethodEnum::Dataflow_ClusterSizeMethod_BySize")
TransformSelection	FDataflowTransformSelection	Bone selection for the clustering	Dataflow/GeometryCollectionClusteringNodes.h	Meta=(DataflowInput, DisplayName="TransformSelection", DataflowIntrinsic)

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
DATAFLOW_NODE_DEFINE_INTERNAL ( FAutoClusterDataflowNode, "AutoCluster", "GeometryCollection\|Cluster", "" )		Dataflow/GeometryCollectionClusteringNodes.h
FGeometryCollection::StaticType()		Dataflow/GeometryCollectionClusteringNodes.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Protected

Functions

Public