Link Search Menu Expand Document

Find point on Bounds

PCGEx | Cluster : Find point on Bounds

Find a point in each cluster that is the closest to a bound-relative position.

The Find point on Bounds node find the point inside either edge or vtx points that is closest to that cluster’ bounds. This is especially useful to use as a seed to find outer contours of individual clusters.


Vtx
Endpoints of the input Edges
Edges
Edges associated with the input Vtxs
Out
Points found. One dataset per input cluster.

Table of content


The Find point on Bounds node for cluster extract the single closest Vtx point to a target position that is relative to the cluster’ AABB.
In other words, it’s a very reliable way to find a point that can be used as a seed for the Find Contours node and grab the perimeter of a cluster.

details/clusters-find-point-on-bounds/lead.png

Properties


Property Description
Search Mode Whether to validate closest distance for the closest Vtx or the closest Edge.
Output Mode Whether to output a single dataset per cluster, or a single consolidated list.
UVW The bound-relative position to start searching from. 1,1,1 will be top left corner of the bounding box; while -1,-1,-1 will be located in the opposite corner.
Offset Offset the output point by a distance, away from the center of the bounding box.
Carry Over Settings See below.
Quiet Attribute Mismatch Warning When using Merged output, some attribute may share the same name but not the same type, which will throw a warning. You can disable the warning by enabling this option.

Carry Over Settings


“Carry over” settings lets you pick-and-choose which attributes & tags carry over to the new data.

Property Description
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.
Attributes Lets you pick and choose which attributes to keep or dismiss.
Tags Lets you pick and choose which attributes to keep or dismiss.

Both Attributes & Tags share the same string-based filters.

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.

Cluster Output Settings

See Working with Clusters - Cluster Output Settings.