juli/OrcaSlicer
1
1
Fork 0
mirror of https://github.com/OrcaSlicer/OrcaSlicer.git synced 2026-09-20 07:22:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
c4990ee9567413322bb939aed1dee1cd1a79e64e
OrcaSlicer/docs/ux/tool_atlas.json
T
Tommaso Bianchi eb2fc986a4 docs/ux: the offer atlas — every tool, every state, drawn 
The charter fixed the slot-constancy invariant but carried one hand-written
eight-cell table as an illustration, and nothing of the offer exists in the
product. Before any GUI code, the group needs the map itself: what verbs there
are, what each one needs before it can be offered, and what the ring actually
looks like in every situation a user can put it in.

tool_atlas.json is the source of truth and it was extracted from the code, not
from memory: verbs, shortcuts and the exact refusal strings from DesignPanel's
six feat_dropdown call sites and the sk_key table, kernel coverage checked
against CadFeatureType, headless coverage against McpControl's dispatch, and
the selection kinds taken from the callbacks DesignCanvas actually exposes. It
carries each verb's preconditions, so "why is that slot empty" has an answer
already written in the product's own words. The eventual C++ table generates
from this file too — the map exists once.

gen_offer_mockups.py renders it: 20 selection kinds x 2 document states = 40
primary rings, plus 73 sub-rings, plus comparison sheets. 113 states, none of
them hand-drawn, because a human drawing 113 rings is exactly how an address
quietly changes. Everything is framed at 1366x768, the charter's own reach
target, so L11 is tested in the mockups before it is tested in code.

Three things the drawing found that the prose had not:

- MEAN FILL IS 3.45 OF 8. The empty-slot rule is cheap in argument and
  expensive on screen; on a fresh document exactly two slots are live. That
  picture is the anti-clutter thesis made literal and it is the strongest image
  in the set.
- SUB-RINGS MUST ANCHOR ON THEIR PARENT. Fanning them from north put Extrude at
  N, which is Create's address in the primary map, so the second level
  contradicted the first. Anchored, an address is two consistent strokes: Add
  material is NE and its first verb is NE again.
- ONE FAMILY OVERFLOWS, AND ONLY ONE. Sketch-mode Create needs nine addresses
  on an eight-slot ring. That is the ninth-position pressure the charter
  predicted, arriving on schedule and measured rather than argued: either Point
  moves family, or the tail goes to a third level, or the ring is not eight.
  Every model-mode family fits. The generator refuses to wrap a tenth verb onto
  a first — silent collision is the one outcome worse than an ugly ring — and
  reports the overflow instead.

Also fixed while looking at renders: the selection pill sat on top of the north
slot's shortcut chip and hid it, and the scrim at 0.55 swallowed the very face
the ring had been opened on, which is 4.1 failing inside its own mockup.

Fork-neutral: the generator and everything it emits name no product, so both
forks carry byte-identical copies.

snaporca-2is.
2026-07-31 11:40:45 +02:00

221 lines
20 KiB
JSON
Raw Blame History

{
"_comment": [
"Source of truth for the object-driven tool offer (see docs/cad_ux_guidelines.md 4.1).",
"Every verb, the selections it accepts, the document state it needs, and its fixed",
"compass address. Extracted from the code, not from memory:",
" verbs + shortcuts + refusal messages -> src/slic3r/GUI/DesignPanel.cpp (feat_dropdown",
" call sites at 524/662/734/790/874/904, sk_key table at 369-400, m_keys_feature)",
" kernel coverage -> src/libslic3r/CadDocument.hpp (enum CadFeatureType)",
" headless coverage -> src/slic3r/GUI/McpControl.cpp (method == \"...\")",
" selection kinds -> src/slic3r/GUI/DesignCanvas.hpp (the on_*_selected callbacks)",
"gen_offer_mockups.py reads this file; the eventual C++ offer table is generated from it",
"too, so the map exists once."
],
"slots": [
{"id": "create", "pos": "N", "angle": 270, "label": "Create", "why": "makes new geometry from nothing you have yet"},
{"id": "add", "pos": "NE", "angle": 315, "label": "Add material", "why": "grows solid or sheet material"},
{"id": "remove", "pos": "E", "angle": 0, "label": "Remove", "why": "takes material away"},
{"id": "dressup", "pos": "SE", "angle": 45, "label": "Dress-up", "why": "finishes faces and edges without changing the shape's intent"},
{"id": "repeat", "pos": "S", "angle": 90, "label": "Repeat", "why": "copies what exists"},
{"id": "transform", "pos": "SW", "angle": 135, "label": "Transform", "why": "moves without changing shape"},
{"id": "reference", "pos": "W", "angle": 180, "label": "Reference", "why": "makes datums, curves and measurements"},
{"id": "modify", "pos": "NW", "angle": 225, "label": "Modify", "why": "edits or removes what is already there"}
],
"selections": [
{"id": "none", "name": "Nothing selected", "mode": "model", "shape": "empty"},
{"id": "face_planar", "name": "Planar face", "mode": "model", "shape": "box_top"},
{"id": "face_cyl", "name": "Cylindrical face", "mode": "model", "shape": "box_bore"},
{"id": "face_other", "name": "Curved face", "mode": "model", "shape": "box_fillet_face"},
{"id": "edge_str", "name": "Straight edge", "mode": "model", "shape": "box_edge"},
{"id": "edge_circ", "name": "Circular edge", "mode": "model", "shape": "box_bore_rim"},
{"id": "vertex", "name": "Vertex", "mode": "model", "shape": "box_vertex"},
{"id": "body_solid", "name": "Solid body", "mode": "model", "shape": "box_whole"},
{"id": "body_sheet", "name": "Sheet body", "mode": "model", "shape": "sheet"},
{"id": "bodies_2", "name": "Two bodies", "mode": "model", "shape": "two_boxes"},
{"id": "datum_plane", "name": "Datum plane", "mode": "model", "shape": "datum"},
{"id": "datum_axis", "name": "Datum axis", "mode": "model", "shape": "axis"},
{"id": "coordsys", "name": "Coordinate system", "mode": "model", "shape": "csys"},
{"id": "art", "name": "Text / imported art","mode": "model", "shape": "art"},
{"id": "sk_loop", "name": "Closed sketch loop", "mode": "model", "shape": "loop"},
{"id": "sk_none", "name": "Sketch, nothing picked", "mode": "sketch", "shape": "sk_empty"},
{"id": "sk_line", "name": "Sketch line", "mode": "sketch", "shape": "sk_line"},
{"id": "sk_arc", "name": "Sketch arc or circle","mode": "sketch","shape": "sk_arc"},
{"id": "sk_point", "name": "Sketch point", "mode": "sketch", "shape": "sk_point"},
{"id": "sk_2ent", "name": "Two sketch entities","mode": "sketch", "shape": "sk_two"}
],
"doc_states": [
{"id": "rich", "name": "Working document", "bodies": 2, "sketches": 2, "sheet": true,
"note": "two solids, two sketches, one sheet body — everything doc-gated is legal"},
{"id": "fresh", "name": "Fresh document", "bodies": 0, "sketches": 0, "sheet": false,
"note": "nothing built yet — shows how much of the ring is empty on first open"}
],
"verbs": [
{"id": "sketch", "name": "Sketch", "slot": "create", "key": "Shift+S", "feature": "Sketch", "mcp": null,
"accepts": ["face_planar", "datum_plane", "none"], "needs": {},
"refusal": "Click a face or a reference plane in the viewport, then a sketch tool", "gui": true},
{"id": "extrude", "name": "Extrude", "slot": "add", "key": "Shift+E", "feature": "Extrude", "mcp": "extrude",
"accepts": ["sk_loop", "face_planar"], "needs": {},
"refusal": "Create a sketch, or pick a solid face, first", "gui": true},
{"id": "revolve", "name": "Revolve", "slot": "add", "key": "Shift+R", "feature": "Revolve", "mcp": "revolve",
"accepts": ["sk_loop"], "needs": {},
"refusal": "Create a sketch profile to revolve first", "gui": true},
{"id": "sweep", "name": "Sweep", "slot": "add", "key": "Shift+W", "feature": "Sweep", "mcp": null,
"accepts": ["sk_loop"], "needs": {"sketches": 2},
"refusal": "Create a profile sketch to sweep first", "gui": true},
{"id": "loft", "name": "Loft", "slot": "add", "key": "Shift+L", "feature": "Loft", "mcp": null,
"accepts": ["sk_loop"], "needs": {"sketches": 2},
"refusal": "Create at least two profile sketches to loft", "gui": true},
{"id": "thicken", "name": "Thicken", "slot": "add", "key": null, "feature": "Thicken", "mcp": "thicken",
"accepts": ["face_planar", "face_other"], "needs": {"bodies": 1},
"refusal": "Thicken needs a solid body — add or import one first", "gui": true},
{"id": "rib", "name": "Rib", "slot": "add", "key": null, "feature": "Rib", "mcp": "rib",
"accepts": ["sk_line"], "needs": {"bodies": 1},
"refusal": "Rib needs a solid body — add or import one first", "gui": true},
{"id": "boolean", "name": "Combine", "slot": "add", "key": "Shift+B", "feature": "Boolean", "mcp": "boolean",
"accepts": ["bodies_2"], "needs": {"bodies": 2},
"refusal": "Boolean needs two bodies — create or import a second solid", "gui": true},
{"id": "surf_extrude", "name": "Surface Extrude", "slot": "add", "key": "Shift+G", "feature": "SurfaceExtrude","mcp": "surface_extrude",
"accepts": ["sk_loop"], "needs": {}, "refusal": "Create a sketch first", "gui": true},
{"id": "surf_revolve", "name": "Surface Revolve", "slot": "add", "key": null, "feature": "SurfaceRevolve","mcp": "surface_revolve",
"accepts": ["sk_loop"], "needs": {}, "refusal": "Create a sketch profile to revolve first", "gui": true},
{"id": "surf_loft", "name": "Surface Loft", "slot": "add", "key": null, "feature": "SurfaceLoft", "mcp": "surface_loft",
"accepts": ["sk_loop"], "needs": {"sketches": 2}, "refusal": "Create at least two profile sketches to loft", "gui": true},
{"id": "surf_fill", "name": "Surface Fill", "slot": "add", "key": null, "feature": "SurfaceFill", "mcp": "surface_fill",
"accepts": ["sk_loop"], "needs": {}, "refusal": "Create a closed sketch first", "gui": true},
{"id": "thicken_surf", "name": "Thicken Surface", "slot": "add", "key": null, "feature": "ThickenSurface","mcp": "thicken_surface",
"accepts": ["body_sheet"], "needs": {"sheet": true}, "refusal": "target is not a sheet body", "gui": true},
{"id": "hole", "name": "Hole", "slot": "remove", "key": "Shift+H", "feature": "Hole", "mcp": "hole",
"accepts": ["face_planar", "datum_plane"], "needs": {"bodies": 1},
"refusal": "Pick a face or a plane to drill into", "gui": true},
{"id": "thread", "name": "Thread", "slot": "remove", "key": "Shift+T", "feature": "Thread", "mcp": null,
"accepts": ["face_cyl", "edge_circ"], "needs": {"bodies": 1},
"refusal": "Pick a cylindrical surface (bore / outer) or a circular edge for a thread", "gui": true},
{"id": "shell", "name": "Shell", "slot": "remove", "key": "Shift+K", "feature": "Shell", "mcp": "shell",
"accepts": ["face_planar", "body_solid"], "needs": {"bodies": 1},
"refusal": "Shell needs a solid body", "gui": true},
{"id": "cut", "name": "Cut", "slot": "remove", "key": "Shift+X", "feature": "Cut", "mcp": null,
"accepts": ["body_solid", "datum_plane"], "needs": {"bodies": 1},
"refusal": "Create a solid body to cut first", "gui": true},
{"id": "split", "name": "Split", "slot": "remove", "key": null, "feature": "Cut", "mcp": "split",
"accepts": ["body_solid"], "needs": {"bodies": 1}, "refusal": "Split needs a solid body", "gui": false},
{"id": "fillet", "name": "Fillet", "slot": "dressup", "key": "Shift+F", "feature": "Fillet", "mcp": "fillet",
"accepts": ["edge_str", "edge_circ", "face_planar", "body_solid"], "needs": {"bodies": 1},
"refusal": "Pick an edge to round", "gui": true},
{"id": "chamfer", "name": "Chamfer", "slot": "dressup", "key": null, "feature": "Chamfer", "mcp": "chamfer",
"accepts": ["edge_str", "edge_circ", "face_planar", "body_solid"], "needs": {"bodies": 1},
"refusal": "Pick an edge to bevel", "gui": true},
{"id": "draft", "name": "Draft", "slot": "dressup", "key": "Shift+D", "feature": "Draft", "mcp": "draft",
"accepts": ["face_planar", "face_other"], "needs": {"bodies": 1},
"refusal": "Pick a face to taper", "gui": true},
{"id": "surf_offset", "name": "Surface Offset", "slot": "dressup", "key": null, "feature": "SurfaceOffset", "mcp": "surface_offset",
"accepts": ["body_sheet"], "needs": {"sheet": true}, "refusal": "target is not a sheet body", "gui": true},
{"id": "pattern", "name": "Pattern", "slot": "repeat", "key": "Shift+N", "feature": "Pattern", "mcp": "pattern",
"accepts": ["body_solid", "face_planar", "sk_loop", "art"], "needs": {"bodies": 1},
"refusal": "Create a solid body to pattern first", "gui": true},
{"id": "mirror", "name": "Mirror", "slot": "repeat", "key": "Shift+Z", "feature": "Mirror", "mcp": "mirror",
"accepts": ["body_solid", "datum_plane"], "needs": {"bodies": 1},
"refusal": "Mirror needs a body — add or import one first", "gui": true},
{"id": "pat_curve", "name": "Pattern on Curve","slot": "repeat", "key": null, "feature": "Pattern", "mcp": "pattern_on_curve",
"accepts": ["body_solid", "edge_str"], "needs": {"bodies": 1},
"refusal": "Pattern on curve needs a body and a curve", "gui": false},
{"id": "transform", "name": "Move", "slot": "transform", "key": "Shift+Y", "feature": "Transform", "mcp": "transform",
"accepts": ["body_solid", "body_sheet", "art"], "needs": {"bodies": 1},
"refusal": "Transform needs a body — add or import one first", "gui": true},
{"id": "mate", "name": "Mate", "slot": "transform", "key": null, "feature": "Mate", "mcp": "mate",
"accepts": ["coordsys", "bodies_2", "face_planar"], "needs": {"bodies": 2},
"refusal": "A mate needs two coordinate systems", "gui": true},
{"id": "align", "name": "Align to", "slot": "transform", "key": null, "feature": "Transform", "mcp": "transform",
"accepts": ["face_planar"], "needs": {"bodies": 1}, "refusal": "Align needs a body", "gui": false},
{"id": "plane", "name": "Plane", "slot": "reference", "key": "Shift+P", "feature": "Plane", "mcp": null,
"accepts": ["none", "face_planar", "edge_str", "datum_plane", "vertex"], "needs": {},
"refusal": null, "gui": true},
{"id": "axis", "name": "Axis", "slot": "reference", "key": "Shift+A", "feature": "Axis", "mcp": "axis",
"accepts": ["none", "face_planar", "face_cyl", "edge_str", "vertex"], "needs": {},
"refusal": null, "gui": true},
{"id": "coordsys_v", "name": "Coord Sys", "slot": "reference", "key": "Shift+C", "feature": "CoordSys", "mcp": "coordsys",
"accepts": ["none", "face_planar", "vertex"], "needs": {}, "refusal": null, "gui": true},
{"id": "helix", "name": "Helix", "slot": "reference", "key": null, "feature": "Helix", "mcp": "helix",
"accepts": ["none", "datum_plane", "face_cyl"], "needs": {}, "refusal": null, "gui": true},
{"id": "project", "name": "Project", "slot": "reference", "key": null, "feature": "Project", "mcp": "project",
"accepts": ["body_solid", "face_planar", "datum_plane"], "needs": {"bodies": 1},
"refusal": "Project needs a body — add or import one first", "gui": true},
{"id": "measure", "name": "Measure", "slot": "reference", "key": null, "feature": null, "mcp": "measure",
"accepts": ["face_planar", "face_cyl", "face_other", "edge_str", "edge_circ", "vertex", "body_solid", "body_sheet", "bodies_2", "sk_line", "sk_arc", "sk_2ent"],
"needs": {}, "refusal": null, "gui": false},
{"id": "mass_props", "name": "Mass", "slot": "reference", "key": null, "feature": null, "mcp": "mass_properties",
"accepts": ["body_solid"], "needs": {"bodies": 1}, "refusal": null, "gui": false},
{"id": "interference", "name": "Interference", "slot": "reference", "key": null, "feature": null, "mcp": "check_interference",
"accepts": ["bodies_2"], "needs": {"bodies": 2}, "refusal": null, "gui": false},
{"id": "edit_feature", "name": "Edit", "slot": "modify", "key": null, "feature": null, "mcp": "set_feature_expr",
"accepts": ["body_solid", "face_planar", "face_cyl", "face_other", "sk_loop", "art", "datum_plane", "datum_axis", "coordsys", "body_sheet"],
"needs": {}, "refusal": null, "gui": true},
{"id": "delete_face", "name": "Delete Face", "slot": "modify", "key": null, "feature": "DeleteFace", "mcp": "delete_face",
"accepts": ["face_planar", "face_cyl", "face_other"], "needs": {"bodies": 1},
"refusal": "Delete Face needs a body — add or import one first", "gui": true},
{"id": "colour", "name": "Colour", "slot": "modify", "key": null, "feature": null, "mcp": null,
"accepts": ["body_solid", "body_sheet"], "needs": {"bodies": 1}, "refusal": null, "gui": true},
{"id": "delete", "name": "Delete", "slot": "modify", "key": "Del", "feature": null, "mcp": null,
"accepts": ["body_solid", "body_sheet", "sk_loop", "art", "datum_plane", "datum_axis", "coordsys", "bodies_2", "sk_line", "sk_arc", "sk_point", "sk_2ent"],
"needs": {}, "refusal": null, "gui": true},
{"id": "sk_line_t", "name": "Line", "slot": "create", "key": "L", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_none", "sk_point", "sk_line", "sk_arc", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_rect", "name": "Rectangle", "slot": "create", "key": "R", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_none", "sk_point", "sk_line", "sk_arc", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_circle", "name": "Circle", "slot": "create", "key": "C", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_none", "sk_point", "sk_line", "sk_arc", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_arc_t", "name": "Arc", "slot": "create", "key": "A", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_none", "sk_point", "sk_line", "sk_arc", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_slot", "name": "Slot", "slot": "create", "key": "S", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_none", "sk_point", "sk_line", "sk_arc", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_ellipse", "name": "Ellipse", "slot": "create", "key": "E", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_none", "sk_point", "sk_line", "sk_arc", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_spline", "name": "Spline", "slot": "create", "key": "B", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_none", "sk_point", "sk_line", "sk_arc", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_polygon", "name": "Polygon", "slot": "create", "key": "G", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_none", "sk_point", "sk_line", "sk_arc", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_point_t", "name": "Point", "slot": "create", "key": "P", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_none", "sk_point", "sk_line", "sk_arc", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_offset", "name": "Offset", "slot": "add", "key": "O", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_line", "sk_arc", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_trim", "name": "Trim", "slot": "remove", "key": "T", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_line", "sk_arc", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_fillet", "name": "Fillet", "slot": "dressup", "key": "F", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_line", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_chamfer", "name": "Chamfer", "slot": "dressup", "key": "H", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_line", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_mirror", "name": "Mirror", "slot": "repeat", "key": "M", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_line", "sk_arc", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_move", "name": "Move", "slot": "transform", "key": null, "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_line", "sk_arc", "sk_point", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_dimension", "name": "Dimension", "slot": "reference", "key": "D", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_none", "sk_line", "sk_arc", "sk_point", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_constrain", "name": "Constrain", "slot": "reference", "key": "K", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_line", "sk_arc", "sk_point", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_construct", "name": "Construction", "slot": "reference", "key": "Q", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_none", "sk_line", "sk_arc", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_extend", "name": "Extend", "slot": "modify", "key": "X", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_line", "sk_arc", "sk_2ent"], "needs": {}, "refusal": null, "gui": true},
{"id": "sk_delete", "name": "Delete", "slot": "modify", "key": "Del", "feature": "Sketch", "mcp": null, "mode": "sketch",
"accepts": ["sk_line", "sk_arc", "sk_point", "sk_2ent"], "needs": {}, "refusal": null, "gui": true}
],
"chrome_only": {
"_why": "document-level actions act on the DOCUMENT, not on a selection, so they stay in chrome and never enter the offer (see 4.1)",
"items": ["Import STEP", "Import mesh", "Text", "SVG", "Export STEP", "Commit to Plate",
"Undo", "Redo", "Variables", "Section view", "Origin planes", "World axes"]
}
}
Reference in New Issue View Git Blame Copy Permalink