mirror of
https://github.com/ajisaacs/OpenNest.git
synced 2026-10-01 14:18:48 -04:00
243 lines
14 KiB
Markdown
243 lines
14 KiB
Markdown
# Visual material-overlap check
|
|
|
|
## Desktop use
|
|
|
|
Choose **View > Overlap Check > Check Active Plate** to check committed parts on
|
|
this plate. Shared material is shaded red/magenta without changing the nest,
|
|
selection, cutting paths, or export behavior. Cutoffs and temporary preview parts
|
|
are excluded. **Cancel Check** discards the running request. **Display > Off /
|
|
Areas / Centroids / Both** changes visibility without rerunning analysis. Areas
|
|
is the default; rechecking preserves a visible mode, while checking from Off
|
|
shows Areas. Display preferences belong to the current document and are not saved.
|
|
|
|
Centroids and Both show fixed-screen-size, DPI-scaled pair crosshairs with a
|
|
contrasting halo. Labels such as `1/3` identify the two plate sequence positions
|
|
at capture time, including gaps occupied by cutoffs. Hover near a marker to see
|
|
captured names, approximate shared area in in² or mm², and centroid coordinates
|
|
in the same linear units. Units are captured with the request; hover does not
|
|
relabel an old report from live settings. Nearby/coincident markers show all
|
|
matching pairs in sequence order. If details exceed the view, the tooltip wraps
|
|
and pages them with a `Page x/y` hint: keep the pointer near the marker and use
|
|
plain **PageUp / PageDown** while PlateView has focus. Long individual details
|
|
continue across pages without truncation; an impossibly small viewport asks you
|
|
to enlarge it. These keys act only while a multipage diagnostic tooltip is
|
|
visible; wheel zoom, modified keys, selection clicks, and dragging are unchanged.
|
|
Small positive areas use significant-figure formatting rather than rounding to
|
|
zero. Selection and dragging remain ordinary plate operations, not overlay
|
|
interactions.
|
|
|
|
A persistent label distinguishes unchecked, checking, current, incomplete, stale,
|
|
canceled, and failed checks. Only a completed, current, fully checked report can
|
|
say **No material overlaps detected**. An incomplete check retains known overlaps
|
|
and states how many distinct parts could not be checked. Pair counts are not
|
|
fragment counts. This diagnostic checks shared material, not minimum spacing,
|
|
plate edges, or cutting-path crossings.
|
|
|
|
Edits clear the overlay and require another explicit check. Plate changes reset
|
|
the check. Pan, zoom, selection, and display changes do not rerun geometry.
|
|
Drawing-editor loading invalidates before loading, even if the dialog is later
|
|
canceled. There is no automatic check during dragging or export.
|
|
|
|
## Analysis API
|
|
|
|
`OpenNest.Diagnostics.PlateOverlapAnalyzer` in OpenNest.Core checks a group of placed
|
|
parts and returns the shared polygon areas for each overlapping pair. Existing
|
|
`Part.Intersects`, `PartOverlapChecker`, `Plate.HasOverlappingParts`, engine
|
|
validators, and CLI entry points are unchanged. A separate shared-triangulator fix
|
|
uses translation-stable winding, correcting missed clockwise outlines/holes far
|
|
from the origin without changing contact or fragment-area tolerance policies.
|
|
|
|
## Synchronous use
|
|
|
|
```csharp
|
|
using OpenNest.Diagnostics;
|
|
|
|
var report = PlateOverlapAnalyzer.Analyze(parts, cancellationToken);
|
|
var areas = report.Pairs.SelectMany(pair => pair.Regions).ToList();
|
|
|
|
foreach (var pair in report.Pairs)
|
|
{
|
|
// IDs are zero-based positions in the original input list, including skipped cutoffs.
|
|
Console.WriteLine($"{pair.PartAId} / {pair.PartBId}: {pair.Area}, centroid {pair.Centroid}");
|
|
foreach (var region in pair.Regions)
|
|
{
|
|
// region.Vertices: closed, read-only world-coordinate polygon
|
|
// region.Area: positive shared material area, in model units squared
|
|
}
|
|
}
|
|
|
|
// An empty list alone does not mean the whole group was checked successfully.
|
|
if (!report.IsComplete)
|
|
foreach (var issue in report.Issues)
|
|
Console.WriteLine($"Uncheckable input/pair {issue.PartAId} / {issue.PartBId}: {issue.Message}");
|
|
```
|
|
|
|
`Pairs` is ordered by `(PartAId, PartBId)`, with `PartAId < PartBId`. Drawing names
|
|
are captured as labels, not used as identity. Repeated instances and different
|
|
drawings with the same name remain distinct. Callers should pass each physical
|
|
instance once; duplicate input entries are distinct positions in the group.
|
|
`pair.Bounds` returns a fresh world-coordinate bounding box; collections and
|
|
vertices cannot mutate the snapshot, report, or live geometry.
|
|
|
|
## Capture once, analyze off-thread
|
|
|
|
```csharp
|
|
// UI thread, while parts/drawings are stable:
|
|
var snapshot = PlateOverlapAnalyzer.Capture(parts, cancellationToken);
|
|
|
|
// Worker thread, no access to live Part/Drawing/Program objects:
|
|
var report = await Task.Run(
|
|
() => PlateOverlapAnalyzer.Analyze(snapshot, cancellationToken),
|
|
cancellationToken);
|
|
```
|
|
|
|
Capture converts each distinct clean source program by reference identity once
|
|
into owned entities, including expanded shared hole-subprogram calls, and copies
|
|
input IDs, names, locations, and baseline-adjusted rotations. This is intentionally
|
|
not a `Program.Clone` dependency: conversion itself creates fresh geometry without
|
|
mutating the source or re-aligning shared subprograms. Capture has synchronous
|
|
conversion cost; callers must not mutate inputs while capture runs.
|
|
|
|
Analysis clones captured entities before chaining, prepares polygons once per
|
|
source, then prepares each pose. An X-sorted bounds sweep prunes separated pairs.
|
|
It invokes the existing hole-aware `Collision.Check` once per candidate pair,
|
|
without an earlier boolean collision pass. Pairs are rebased near the origin for
|
|
clipping/triangulation and restored to world coordinates; area calculation uses
|
|
translated-origin products to avoid cancellation far from the origin. Snapshots
|
|
can be reused and analyzed concurrently. Callers own freshness checks and must
|
|
not publish results after geometry changes or after a newer request supersedes them.
|
|
|
|
Cancellation throws `OperationCanceledException`; it never returns a partial
|
|
all-clear. Checks occur between source/pose preparation, validation loops, and
|
|
candidate pairs, and before return. An individual conversion, polygonization,
|
|
triangulation, or `Collision.Check` call is not internally interruptible.
|
|
|
|
## Material contract
|
|
|
|
- Material comes from `Part.BaseDrawing.Program`, transformed by
|
|
`part.Rotation - drawing.Program.Rotation`, then `part.Location`. Applied or
|
|
restored lead-ins, lead-outs, and tabs in `Part.Program` do not redefine material.
|
|
- Cutoff parts are skipped. Scribe, rapid, lead-in, and lead-out layers in the clean
|
|
source do not define material; ordinary cut/default/display contours do.
|
|
- The caller chooses the group. Preview parts are not intrinsically distinguishable
|
|
from committed parts here; a PlateView caller must supply committed parts only.
|
|
- Valid material has one simple closed outer contour and strictly internal,
|
|
mutually disjoint holes. Open, empty, degenerate, self-intersecting, nonfinite,
|
|
disconnected-outer, touching-hole, intersecting-hole, or nested-island geometry
|
|
produces an issue. Native contour intersections are checked before polygonal
|
|
containment, so sampling cannot hide a circular-hole crossing or tangency.
|
|
A gap above `Tolerance.Epsilon` is not silently welded closed.
|
|
Open cut marks are conservatively uncheckable; mark them as Scribe instead.
|
|
- Some valid curved geometry, such as sub-chord-width thin rings whose sampled
|
|
contours cross, is uncheckable at this fixed tolerance and returns incomplete
|
|
rather than clear. No automatic healing or adaptive refinement is performed.
|
|
Poses that collapse edges or materially change area through floating-point
|
|
rounding are also incomplete, even when all coordinates remain finite.
|
|
- Expected geometry failures produce issues with original input indices and
|
|
preserve overlaps found among other valid parts. Unexpected failures propagate.
|
|
A report with any issue has `IsComplete == false`, even if `Pairs` is empty.
|
|
- No part, drawing, quantity, pose, cutting state, or selection is modified.
|
|
|
|
## Interpretation and limits
|
|
|
|
Regions are the kernel's convex, hole-subtracted fragments, not merged connected
|
|
islands. Fill the fragments for a visual overlay; do not outline triangulation
|
|
seams as physical boundaries. Areas within one pair may be summed. Areas across
|
|
pairs are not a union: three coincident parts produce three overlapping pairs,
|
|
so summing all pair areas double-counts shared plate locations.
|
|
|
|
`pair.Centroid` is the true area-weighted center of every shared-material fragment
|
|
for that pair, after hole subtraction. It is not an average of crossings or
|
|
vertices. For a disconnected or concave overlap, the mathematical centroid can
|
|
lie outside the red material (for example, between two separate patches). This
|
|
is intentional: shaded Areas are authoritative for actual overlap locations;
|
|
use Both for detailed inspection rather than interpreting a centroid as an
|
|
interior collision point. There is one centroid per pair, not per connected island.
|
|
|
|
`PolygonAreaMoments` evaluates signed moments about local origins and combines
|
|
fragments with positive area weights independent of winding. The analyzer does
|
|
this on rebased clipping fragments before adding the world origin back. Invalid,
|
|
degenerate, or nonfinite moments produce an incomplete pair issue, not a marker
|
|
at zero. Curved-outline centroids inherit the polygonization approximation.
|
|
|
|
Full containment and coincident parts are detected without relying on crossing
|
|
points. Edge/corner contact with no positive shared material is not overlap.
|
|
There are no spacing offsets, plate-edge checks, cut-path crossing checks, automatic
|
|
repairs, export blocks, or machining-validity guarantees.
|
|
|
|
Arc/circle flattening uses a chord tolerance of `0.001` model units (also exposed
|
|
as `report.ChordTolerance`). Curved overlaps and topology are therefore polygonal
|
|
approximations. The unchanged collision kernel applies dimensional bounds and
|
|
fragment-area thresholds using `Tolerance.Epsilon` (`0.00001`); sufficiently small
|
|
slivers are below its reporting policy. Floating-point coordinates still have
|
|
finite resolution. Contact and fragment thresholds are unchanged; only the shared
|
|
triangulator's winding arithmetic was stabilized in the prerequisite fix.
|
|
|
|
## Desktop lifecycle and rendering
|
|
|
|
`OverlapReportState` and `OverlapGeometryStamp` in Core hold the testable request
|
|
policy. The stamp compares ordered part identities, exact pose scalars, drawing
|
|
and program references, cutoff status, and plate identity. It is not a geometry
|
|
hash: any new editor that mutates a clean program in place must call
|
|
`PlateView.InvalidateOverlapCheck()` before loading/mutation. Current live clean
|
|
program editing goes through `EditNestForm.EditDrawingsInConverter_Click`;
|
|
metadata-only edits do not change material. In-place hole-program edits require
|
|
the same explicit invalidation.
|
|
|
|
`OverlapOverlayController` owns UI-thread captures, background analysis, request
|
|
generations, cancellation, and the GDI display cache. It checks freshness before
|
|
publication and painting. Handle destruction/disposal cancels work and releases
|
|
paths; old completions cannot replace a newer report. Snapshot conversion and
|
|
clipping never run in paint or mouse-move handlers.
|
|
|
|
PlateView draws the controller overlay after work-area/debug-remnant drawing and
|
|
before action paint subscribers and hover tooltips. One consistently wound path
|
|
is filled once, avoiding fragment outlines, internal triangulation seams, and
|
|
darker triple coverage. World-to-graph conversion excludes pan, because PlateView
|
|
already applies origin translation. Paths are rebuilt for report/scale changes,
|
|
not ordinary repaints or panning. The state label saves/restores graphics state.
|
|
Centroid hit tests use only cached report coordinates and DPI-scaled screen
|
|
radii. Hover clears on edits, mode/request/view changes, leave, and teardown.
|
|
Diagnostic details draw above action adorners and take precedence over the normal
|
|
part-name tooltip only while visible.
|
|
|
|
Next hardening: measure real-plate capture/analysis cost and cancellation latency
|
|
before adding cached triangulations or background capture. Cancellation cannot
|
|
interrupt the interior of an existing kernel operation.
|
|
|
|
## Verification
|
|
|
|
`OpenNest.Tests/Diagnostics/PlateOverlapAnalyzerTests.cs` exercises analytical
|
|
rectangle regions/areas, containment and contact, both operands' holes, concave
|
|
and disconnected intersections, curves, baseline rotation, large translations,
|
|
deterministic pair ordering against an exhaustive rectangle oracle, invalid
|
|
inputs, snapshot isolation, read-only output, cutting-program independence, and
|
|
cancellation. Run:
|
|
|
|
```sh
|
|
dotnet test OpenNest.Tests/OpenNest.Tests.csproj --filter 'FullyQualifiedName~PlateOverlapAnalyzerTests|FullyQualifiedName~OverlapReportStateTests|FullyQualifiedName~PolygonAreaMomentsTests|FullyQualifiedName~OverlapPairPresentationTests|FullyQualifiedName~OverlapHoverPagesTests'
|
|
```
|
|
|
|
`OverlapReportStateTests` verifies request supersession, exact pose/reference
|
|
freshness, stale clearing, cancellation, and incomplete-versus-clear messaging.
|
|
`PolygonAreaMomentsTests` covers analytic
|
|
centers, unequal/disconnected fragments, winding, closure, large translations,
|
|
and invalid/overflow cases. `OverlapPairPresentationTests` checks adaptive unit
|
|
formatting, sequence labels, coincident ordering, and zoom-independent DPI hit
|
|
radii. `OverlapHoverPagesTests` proves bounded continuation pages retain every
|
|
pair and long/Unicode name, with navigation bounds and explicit tiny-view failure.
|
|
`OpenNest.WinForms.Tests/PlateOverlapOverlayTests.cs` adds STA worker/publication,
|
|
menu/MDI, path-cache, uniform-fill pixel, and control-lifetime checks. Run those
|
|
on Windows:
|
|
|
|
```sh
|
|
dotnet test OpenNest.WinForms.Tests/OpenNest.WinForms.Tests.csproj
|
|
```
|
|
|
|
Linux can cross-build with `-p:EnableWindowsTargeting=true`, but that does not
|
|
execute Windows tests or verify appearance, DPI, or interaction. On Windows,
|
|
check partial overlap, containment, inside-hole placement, pan/zoom and quadrant
|
|
alignment, stale clearing during edits/plate switches, converter cancellation,
|
|
crowded-marker PageUp/PageDown access to the last pair, and repeated
|
|
check/toggle/close cycles without GDI/disposed-control errors.
|