Link Search Menu Expand Document

Pick Closest Cluster

PCGEx | Cluster : Pick Closest

The Pick Closest Cluster node filters clusters based on their proximity to target points, allowing selection, omission, or tagging of the closest clusters.

Vtx
Endpoints of the input Edges
Edges
Edges associated with the input Vtxs
In Targets
Target points used to test for proximity
Vtx
Endpoints of the output Edges
Edges
Edges associated with the output Vtxs

Table of content

The Pick Closest Cluster nodes lets you select clusters within the available one based on proximity to a target point. Each target point will select a single cluster based on proxmimity.

details/clusters-pick-closest-clusters/lead.png

Properties


Property Description
Search Mode Whether to validate closest distance for the closest Vtx or the closest Edge.
Pick Mode Defines how many clusters will get picked.
-Only Best selects only the best pick, even if multiple targets have the same pick. The first best (bestest best) pick will be accounted for for forwarding.
-Next Best guarantees each target will pick a cluster, unless there are less clusters than there are targets.
Action Defines how the selection will be processed.
-Keep keeps the selected clusters, and omits unselected ones from the output.
-Omit remove the selected clusters from the output.
-Tag tags the data based on whether they’re selected or not.
Keep Tag Tag to add to the data if it’s selected.
Omit Tag Tag to add to the data if it’s not selected.

Target Attributes to Tags


Since this node merges multiple inputs together, “Carry over” settings lets you pick-and-choose which attributes & tags carry over to the new data.

Property Description
Enabled Whether attribute forwarding is enabled or not.
Preserve Attributes Default Value If enabled, the node will attempt to create attributes on the data in a way that preserve the original, underlying default value of the attribute.
This can be critical in order to identify which data originally belonged to which, as well as properly initializing flags to a desirable default.

Note that the filters look for a single valid match amongst the list; you cannot create and/or conditions.

Filter Details

Property Description
Filter Mode Chooses how the filter operates.
- All let everything pass.
- Exclude filters out the result of the filter.
- Include only allows the items that pass the filters.
Matches Lets you define a list of checks pairs: a string value, and a Match Mode.
Comma Separated Names Easy to override, lets you specify a list of comma-separated names.
The only caveat is that you can only pick a unique match mode used for each entry.
Comma Separated Names Filter Which filter will be used along the Comma Separated Names.
Preserve PCGEx Data Most of the time you’ll want to leave it to its default value. It ensures PCGEx/ prefixed data are not captured by the filter.

Filter Modes

Mode Description
Equals Checks for strict equality of the filtered value and the associated string.
Contains Checks if the filtered value contains the associated string.
Starts With Checks if the filtered value is prefixed with the associated string.
Ends With Checks if the filtered value is suffixed with the associated string.

Target Forwarding


Since this node merges multiple inputs together, “Carry over” settings lets you pick-and-choose which attributes & tags carry over to the new data.

Property Description
Enabled Whether attribute forwarding is enabled or not.
Preserve Attributes Default Value If enabled, the node will attempt to create attributes on the data in a way that preserve the original, underlying default value of the attribute.
This can be critical in order to identify which data originally belonged to which, as well as properly initializing flags to a desirable default.

Note that the filters look for a single valid match amongst the list; you cannot create and/or conditions.

Filter Details

Property Description
Filter Mode Chooses how the filter operates.
- All let everything pass.
- Exclude filters out the result of the filter.
- Include only allows the items that pass the filters.
Matches Lets you define a list of checks pairs: a string value, and a Match Mode.
Comma Separated Names Easy to override, lets you specify a list of comma-separated names.
The only caveat is that you can only pick a unique match mode used for each entry.
Comma Separated Names Filter Which filter will be used along the Comma Separated Names.
Preserve PCGEx Data Most of the time you’ll want to leave it to its default value. It ensures PCGEx/ prefixed data are not captured by the filter.

Filter Modes

Mode Description
Equals Checks for strict equality of the filtered value and the associated string.
Contains Checks if the filtered value contains the associated string.
Starts With Checks if the filtered value is prefixed with the associated string.
Ends With Checks if the filtered value is suffixed with the associated string.