Link Search Menu Expand Document

πŸ– Adjacency

PCGEx | Cluster Filter : Adjacency

Check if adjacent node meet specific conditions

The Adjacency filter performs numeric comparisons on each connection of a Vtx, allowing precise control over success criteria based on the number of passed comparisons, offering the flexibility to test either discrete or relative connections.


Filter
A single cluster filter definition

Table of content


The adjacency filter does a simple numeric comparison on each individual connections of a Vtx, and offer fine grained control over what qualifies as a β€œsuccess”, based on how many connections passed the comparison or not. What makes it equally useful and tricky to set-up is its ability to test against either a discrete number of connection, or relative ones.

details/flag-nodes/filter-adjacency-lead.png

Properties


Property Description
Settings Β 
Priority Defines the order in which this flag operation will be processed.
See Flag Nodes
Adjacency Settings Defines how to deal with the number of adjacent nodes as a criteria to the filter success.
Covered in more depth later in this page
Compare Against Β 
Operand A Constant TBD
Operand A Attribute TBD
Comparison How to compare Operand A against Operand B
See Numeric comparisons.
Operand B Source TBD
Operand B (Neighbor) TBD
Tolerance Comparison tolerance, for non-strict comparison modes.

Adjacency

Property Description
Settings Β 
Mode The mode lets you choose how to set the flags value, as a user.
- Direct is probably the most useful, as it can be set using an override pin.
- Individual lets you use an array where you can set individual bits by their position (index), and whether they’re true or false.
- Composite lets you set individual bits using dropdowns.

Mode : All

This mode consolidate all the connections’ values into a single one to test against.

Consolidation Β 
Individual Test individual neighbors one by one
Individual Test against averaged value of all neighbors
Individual Test against the Min value of all neighbors
Individual Test against the Max value of all neighbors
Individual Test against the Sum value of all neighbors

DOC TBD

Mode : Some

This mode test individual connections, but only some of them are required to pass for the entire filter to be considered a success.
How that β€œsome” is defined relies on a comparison against a threshold: how many neighbors pass the test vs. how many neighbors there are.

Threshold Settings Β 
Threshold Comparison TBD
Threshold Type TBD
Threshold Source TBD
Discrete Threshold TBD
Relative Threshold TBD
Threshold Attribute TBD
Threshold Source TBD
Rounding TBD
Threshold Tolerance TBD

DOC TBD