package proximity

Import Path
	github.com/pancsta/d2/d2layouts/d2talalayout/internal/proximity (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 2 packages

Involved Source Files

	    common_uncle.go
	    herding.go
	  d hubs.go
		Package proximity discovers layout relationships between nearby nodes.

	    nears.go
Package-Level Functions (total 8)

	 func AddHubs(ctx context.Context, graph *layoutgraph.Graph) error
		AddHubs discovers nodes that have both a leaf spoke and another connection
		within the same containing layout group.

	 func ApplyVirally(ctx context.Context, herdOrder []*layoutgraph.Node, herds map[*layoutgraph.Node][]*layoutgraph.Node) error
		ApplyVirally propagates each known herd orientation through its ordered groups.

	 func AssignHerds(ctx context.Context, graph *layoutgraph.Graph, root *layoutgraph.Node, abductions []*layoutgraph.EdgeAbduction) error
		AssignHerds chooses a shared container side for siblings whose external
		cousins should remain mutually accessible during placement.

	 func AssignNears(ctx context.Context, graph *layoutgraph.Graph, root *layoutgraph.Node, abductions []*layoutgraph.EdgeAbduction) error
		AssignNears marks otherwise unconnected siblings that share an external
		neighbor so placement keeps them close together.

	 func CanUseBothSides(node *layoutgraph.Node, orientation geo.Orientation) bool
		CanUseBothSides reports whether node is long enough perpendicular to
		orientation to host herd members on both parallel sides.

	 func CommonUncleSiblings(graph *layoutgraph.Graph) map[*layoutgraph.Node]layoutgraph.Nodes
		CommonUncleSiblings finds siblings that connect to the same node at their
		parent's level. Placement uses the largest such set as a proximity hint.

	 func GroupSheep(ctx context.Context, graph *layoutgraph.Graph, root *layoutgraph.Node, abductions []*layoutgraph.EdgeAbduction) (map[*layoutgraph.Node][]*layoutgraph.Node, map[*layoutgraph.Node]map[*layoutgraph.Node][]*layoutgraph.Node, error)
		GroupSheep groups root's children by their external uncle and records the
		cousin connections that define each group.

	 func SyncHerdFences(graph *layoutgraph.Graph)
		SyncHerdFences updates the coordinate constraint for every assigned herd to
		the current graph boundary.

The pages are generated with Golds v0.8.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.