mirror of
https://github.com/ajisaacs/OpenNest.git
synced 2026-11-04 06:51:35 -05:00
ajandClaude Opus 5.5
44372d129e
"Fill" said nothing about what the engine does, since every engine fills. It is now Lattice, and Fill stays an alias, so saved selections, scripts and API requests keep working. Engine descriptions are rewritten in plain language and shown beside each name in the desktop engine lists; the main toolbar's tooltip also says when Fill Area falls back to Lattice. Docs also cover the leftover placement from the previous commit. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
70 lines
3.2 KiB
C#
70 lines
3.2 KiB
C#
using System;
|
|
using OpenNest;
|
|
|
|
namespace OpenNest.Engine.Jobs;
|
|
|
|
/// <summary>Immutable per-job options; selection never changes the legacy global registry.</summary>
|
|
public sealed class NestJobOptions
|
|
{
|
|
public NestJobOptions(
|
|
string placementStrategy = "Lattice",
|
|
int? maxPlates = null,
|
|
double salvageRate = 0,
|
|
double minimumSalvageDimension = 0,
|
|
bool searchUntilCancelled = false,
|
|
CutOffAxis? offcutCut = null
|
|
)
|
|
{
|
|
if (offcutCut is { } axis && !Enum.IsDefined(axis))
|
|
throw new ArgumentOutOfRangeException(nameof(offcutCut));
|
|
ArgumentException.ThrowIfNullOrWhiteSpace(placementStrategy);
|
|
if (maxPlates <= 0)
|
|
throw new ArgumentOutOfRangeException(nameof(maxPlates));
|
|
if (!double.IsFinite(salvageRate) || salvageRate < 0 || salvageRate > 1)
|
|
throw new ArgumentOutOfRangeException(nameof(salvageRate));
|
|
if (!double.IsFinite(minimumSalvageDimension) || minimumSalvageDimension < 0)
|
|
throw new ArgumentOutOfRangeException(nameof(minimumSalvageDimension));
|
|
PlacementStrategy = placementStrategy;
|
|
MaxPlates = maxPlates;
|
|
SalvageRate = salvageRate;
|
|
MinimumSalvageDimension = minimumSalvageDimension;
|
|
SearchUntilCancelled = searchUntilCancelled;
|
|
OffcutCut = offcutCut;
|
|
}
|
|
|
|
/// <summary>
|
|
/// When set, only the edge strips one cut along this axis frees count as a sheet's offcut, for
|
|
/// salvage credit and for the compactness tie-break between equal-cost plans:
|
|
/// <see cref="CutOffAxis.Horizontal"/> keeps full-width strips at the bottom or top (the drop
|
|
/// off the end of a sheet), <see cref="CutOffAxis.Vertical"/> full-length ones at the sides.
|
|
/// Null (the default) counts the largest of all four.
|
|
/// </summary>
|
|
public CutOffAxis? OffcutCut { get; }
|
|
|
|
/// <summary>
|
|
/// Asks engines that support it to keep searching after their normal search, reporting
|
|
/// each better plan (<see cref="NestJobStage.PlanImproved"/>) until the solve's token is
|
|
/// cancelled, which then ends the solve with <see cref="OperationCanceledException"/>.
|
|
/// Meant for a caller that keeps the best reported plan at a time limit, such as
|
|
/// <see cref="NestingEngines.DeadlineNestingEngine"/>. Ignored when the token cannot be
|
|
/// cancelled. Results then depend on how long the search ran.
|
|
/// </summary>
|
|
public bool SearchUntilCancelled { get; }
|
|
|
|
/// <summary>A copy of these options with <see cref="SearchUntilCancelled"/> set.</summary>
|
|
public NestJobOptions WithSearchUntilCancelled(bool value) =>
|
|
new(PlacementStrategy, MaxPlates, SalvageRate, MinimumSalvageDimension, value, OffcutCut);
|
|
|
|
/// <summary>Fraction of eligible edge-offcut area credited by <see cref="NestJobCost.NetSheetCost"/> (0..1).</summary>
|
|
public double SalvageRate { get; }
|
|
|
|
/// <summary>Both offcut dimensions must meet this caller-supplied minimum in job units.
|
|
/// Zero disables credit; scraps and holes are never credited.</summary>
|
|
public double MinimumSalvageDimension { get; }
|
|
|
|
public string PlacementStrategy { get; }
|
|
|
|
/// <summary>Maximum physical sheets to commit, or null for no explicit cap.</summary>
|
|
public int? MaxPlates { get; }
|
|
}
|