Link Search Menu Expand Document

Sanitize Clusters

PCGEx | Cluster : Sanitize

Ensure clusters are clean and complete

The Sanitize Clusters ensures clusters are pathfinding-friendly. Fix broken connections, create new clusters as needed. Customize settings for isolated points, edge positions, and cluster sizes.


Vtx
Endpoints of the input Edges
Edges
Edges associated with the input Vtxs
Vtx
Endpoints of the output Edges
Edges
Edges associated with the output Vtxs

Table of content


The Sanitize Cluster is an imperative post-processing node when you “manually” remove Vtx or Edge from datasets. It ensure that the cluster data is properly usable inside PCGEx’ ecosystem of cluster-related nodes.

As mentionned in the Working with Clusters page, Vtx and Edge points are storing critical attributes & informations about the topology of a cluster. Sanitize removes Edges which Vtx have been removed, as well as prune Vtx that aren’t participating to any Edge.
Additionally, if a cluster that was previously a bit interconnected topology has been split into smaller groups, this will be reflected in the Edges output with additional point datasets.

Note that all cluster nodes output sanitized clusters by design, so there is no need to use this node after “official” PCGEx operations. Rule of thumb is, if a node has a ‘Cluster Output Settings’ in its detail panel, it’s generating clean clusters.

details/clusters-sanitize-clusters/lead.png


Cluster Output Settings

See Working with Clusters.

Property Description
Edge Position If enabled, edge point’ position will be the result of that value used as a lerp between its start and end Vtx point.
Pruning  
Min Vtx Count If enabled, only ouputs clusters that have more ( > ) Vtx than the specified number.
Max Vtx Count If enabled, only ouputs clusters that have less ( < ) Vtx than the specified number.
Min Edge Count If enabled, only ouputs clusters that have more ( > ) Edge than the specified number.
Max Edge Count If enabled, only ouputs clusters that have less ( < ) Edge than the specified number.
Misc  
Refresh Edge Seed If enabled, Edge points gets a fresh seed.
Build and Cache Cluster If enabled, pre-build and cache cluster along with the point data.
This has a slight memory cost associated to it, but can offer tremendous performance improvement.
If disabled, cluster processors that comes down the line have to rebuild clusters from point data, which is very costly as they are also tested for errors and possible disconnections in the process.
Expand Clusters If enabled, also build & cache another layer of cache data.
This can have a significant memory cost, as well as a minimal performance overhead, but can greatly improve certain specific operations down the line.