Skip to content

Latest commit

 

History

History
223 lines (191 loc) · 12.5 KB

DESIGN.md

File metadata and controls

223 lines (191 loc) · 12.5 KB
version alpha
name Plotter Studio
description Material Design 3 components on the drafting palette (light panel, ink black, white controls) around a drafting board that stays a drafting board.
omitted
elevation-levels-4-5
colors
primary on-primary primary-container secondary-container on-secondary-container tertiary error on-error error-container amber surface on-surface on-surface-variant surface-container-lowest surface-container-low surface-container surface-container-high surface-container-highest outline outline-variant mat paper ink ink-faint pen-down pen-up origin
#1B1B1B
#FFFFFF
#E2E4DD
#E2E4DD
#1B1B1B
#1F5FBF
#C8102E
#FFFFFF
#F7D6DA
#C98A00
#ECEDE8
#1B1B1B
#5C5F58
#FFFFFF
#ECEDE8
#E2E4DD
#FFFFFF
#D6D9D0
#C9CCC3
#D8DBD3
#2E5C4C
#FFFFFF
#1B1B1B
#B8BDB5
#C8102E
#1F5FBF
#C98A00
typography
headline-medium title-large title-small body-medium body-small label-large data log drafting drafting-mono
fontFamily fontSize lineHeight fontWeight
Roboto, system-ui, sans-serif
28px
36px
400
fontFamily fontSize lineHeight fontWeight
Roboto, system-ui, sans-serif
22px
28px
400
fontFamily fontSize lineHeight fontWeight letterSpacing
Roboto, system-ui, sans-serif
14px
20px
500
0.1px
fontFamily fontSize lineHeight letterSpacing
Roboto, system-ui, sans-serif
14px
20px
0.25px
fontFamily fontSize lineHeight letterSpacing
Roboto, system-ui, sans-serif
12px
16px
0.4px
fontFamily fontSize lineHeight fontWeight letterSpacing
Roboto, system-ui, sans-serif
14px
20px
500
0.1px
fontFamily fontSize
Roboto Mono, Menlo, monospace
14px
fontFamily fontSize lineHeight
Roboto Mono, Menlo, monospace
12px
18px
fontFamily fontSize
Barlow, system-ui, sans-serif
2.6mm
fontFamily fontSize
IBM Plex Mono, Menlo, monospace
2.6mm
rounded
none extra-small small medium large extra-large full
0px
4px
8px
12px
16px
28px
9999px
spacing
xs sm md lg xl
4px
8px
12px
16px
24px
components
top-app-bar side-sheet primary-tabs button-filled button-tonal button-outlined button-error icon-button segmented-button text-field-outlined status-chip dialog linear-progress board title-block log
height backgroundColor typography
56px
{colors.surface}
{typography.title-large}
width backgroundColor padding
440-520px
{colors.surface-container-low}
{spacing.xl} {spacing.lg}
height indicator
44px, top of the side column
3px "{colors.primary}", rounded top
backgroundColor textColor height rounded padding
{colors.primary}
{colors.on-primary}
40px
{rounded.full}
0 {spacing.xl}
backgroundColor textColor
{colors.secondary-container}
{colors.on-secondary-container}
borderColor textColor
{colors.outline}
{colors.primary}
backgroundColor
{colors.error}
size rounded
48px
{rounded.full}
height selectedBackground borderColor
40px
{colors.secondary-container}
{colors.outline}
height rounded borderColor focusBorder
56px
{rounded.extra-small}
{colors.outline}
2px "{colors.primary}"
height rounded
32px
{rounded.small}
backgroundColor rounded padding
{colors.surface-container-high}
{rounded.extra-large}
{spacing.xl}
height color
4px
{colors.primary}
backgroundColor grid
{colors.mat}
10mm minor, 50mm major
width height font
72mm
21mm
Hershey Sans 1-stroke, labels 1.6mm, values 2.2mm cap height
typography height backgroundColor
{typography.log}
remaining column below the board (board takes 70 %)
{colors.surface-container-low}

Overview

Two worlds meet on one screen and are kept deliberately distinct. The tool chrome (app bar, step tabs, forms, dialog, log) follows Material Design 3 so it behaves like every other app the operator uses on a Mac or an iPad: familiar buttons, text fields with floating labels, a pause dialog with the expected corner radius. The work surface (the board) stays a drafting table: a green cutting mat with a millimetre grid, a white sheet, rulers, and a title block drawn where a draughtsman writes it. The chrome uses the drafting palette (light neutral panel, ink black, white controls), so both halves read as one workbench.

The page has one job: get a drawing from Inkscape onto paper correctly, then watch it plot. The five steps are a real sequence, so they are numbered primary tabs.

Colors

The palette is the drafting palette, mapped onto M3 colour roles rather than generated from a seed: primary is ink black, so the one filled button per step, the active tab indicator, selected segments and the progress bar are black on the light neutral panel. Controls are white with a light outline. Surface containers are neutral greys (#ECEDE8, #E2E4DD), the dialog is white.

Three signal colours with one meaning each: error red for pen down and Stop, blue (tertiary) for pen up, amber for paused, notices and the origin. Green is never a status; the mat is green. Single light scheme by choice; the sheet is physical and does not change with the system theme.

Board colours stay outside the roles: pending strokes in ink-faint, strokes that leave the sheet or the machine travel in amber, plotted strokes in ink, the path picked for Resume or Plot this path in ink at twice the line width (at least 4 screen px; over a pickable path the pointer is a crosshair), pen cross red when down and blue when up. Manual moves (jog, console) leave a dashed trace in the same two colours; during a plot the pen-up travel between paths leaves a dotted blue trace, the strokes themselves show the pen-down part. The trace clears on home and at the start of a plot.

Typography

Roboto in the M3 type scale for the chrome: headline-medium for the step title, title-large for the app name, label-medium uppercase for section labels (muted), body-medium for guidance, label-large in every button. Roboto Mono for every number the machine will receive: coordinates in the app bar, tab numbers, jog step sizes, numeric text fields, the log. On the board the drafting faces remain (Barlow and IBM Plex Mono in millimetre sizes) because the board is a drawing, not a UI.

Layout

Names of the parts

Used in code, comments and conversation.

  • App bar: the top bar with the name, status chip, position readout, pen state, unit switch, the Reset text button (opens the reset dialog: everything but the connection and the saved pen profiles back to the defaults) and the red Stop button (same as Esc).
  • Board: the green area on the left with the sheet, rulers, trace and title block. On it: the board tools (dark strip top-left: title block corner button, zoom slider) and the Sheet/Machine toggle top-right on the same kind of dark strip (inverted there: the selected segment is white with the check mark, the other one transparent with white text).
  • Splitter: the console's top edge, styled as an M3 bottom sheet drag handle (32 × 4 px pill, on-surface-variant at 40 %, full on hover, in a 20 px zone laid over the console's top edge, no extra band); drag resizes, double-click resets to the default (board 70 %), the height is remembered in the browser. Console minimum: two log lines plus the input line.
  • Console: below the board, a bottom sheet made of the log and, under a divider, the input line with the ? button that opens the command reference dialog.
  • Side column: the right column, made of the step tabs (1 Connect to 5 Plot), and the step panel with the current step's groups. Steps are switched with the tabs only.
  • Pause dialog: shown before a ! layer.
  • Busy dialog: shown when a command takes longer than 300 ms (loading a drawing, hidden-line removal) and when a large snapshot is drawn; it closes once the board shows the result. Spinner on the left, the action as headline, the seconds elapsed below in monospace. No buttons, Esc does not close it.

Arrangement

Top app bar 56 px with the name on the left and, on the right, the status chip, the position readout, the pen state and a segmented unit switch (mm, cm, in). Below it the height is split: the board on the left takes all remaining width (70 % of the column, the log below it takes the rest), the side column on the right is 440 to 520 px wide. The side column is one unit: the five step tabs at its top and the step panel with the step's groups stacked. The Sheet/Machine view toggle floats in the board's top-right corner; a translucent dark strip in the top-left holds the board tools: a corner button (◲ ◱ ◰ ◳ ▢) cycles the title block through the four sheet corners and off; the choice is a server setting. The title block is plotted: it is a virtual last layer "Title block" in the Plot step, drawn in the single-stroke Hershey Sans font at a fixed 72 × 21 mm, so board and paper show the same thing. Its row stays in the layer table when it is off; the Plot checkbox is the same switch as the corner button (empty when off). The button cycles bottom right, bottom left, top left, top right, off; turning it on again with either control goes where the button would go next, i.e. back to the corner the box turned it off in. Below it a vertical zoom slider snaps to 0.5× to 8× of the fitted view; above 1× the board can be dragged to pan, a double-click resets zoom and pan. With a 1280 px window the board is about 760 px wide, close to the aspect of a landscape sheet, so the sheet fills it. Every step fits the panel without scrolling at 1280 × 690 CSS px.

The board's view fits the sheet by default (rulers and a thin mat margin around it); the Machine toggle zooms out to the whole travel range. All board labels (rulers, title block, machine label, pen cross) are sized in screen pixels and converted to millimetres at render time, so they stay legible at every zoom.

Under 900 px the layout stacks: board first at 60 vw height, then the step panel, then the log, and every button grows to 44 px.

Elevation & Depth

M3 level 1 on cards and on hovered filled buttons, level 3 on the dialog. The side sheet and bars are flat, separated by outline-variant hairlines and container tones. The board has no elevation; it is the table.

Shapes

M3 shape scale: buttons and chips full, text fields extra-small (4 px), status chip and hints small (8 px), cards and the notice medium (12 px), dialog extra-large (28 px). Segmented controls are full on their outer ends only. The board keeps right angles: the sheet, the machine frame, the title block.

Components

App bar: name, status chip whose container follows the state (ink outline when ready, ink fill when moving or plotting, amber when paused, error container on error), position in Roboto Mono, pen state coloured, unit segmented buttons with the M3 check mark on the selection.

Primary tabs: five, numbered, active one in primary with a 3 px indicator; a tick after the number when the step's physical result is verified.

Text fields: outlined, 56 px, label floating in the outline, unit as a suffix; selects share the same outline. Buttons: filled (ink) for the one main action of a step, white outlined for everything else, text for dialog actions, error for Stop. Icon buttons for jogging.

Segmented buttons: unit switch, jog step, placement. Checkboxes and radios use the platform control tinted with primary.

Dialog: pause before a layer, headline, body, text Stop and filled Continue. The busy dialog is narrower and has no actions; its spinner is "spinner-multiple-2" from magecdn.com/tools/svg-loaders (MIT), five rings in primary, 64 px.

Linear progress: 4 px track in surface-container-highest, primary indicator, with a monospace readout below.

Board: unchanged from the drafting design: mat, machine frame, sheet, rulers in the current unit, strokes at the measured line width, pen cross, origin, title block (as strokes, since it is plotted).

Do's and Don'ts

Follow M3 for anything a person touches; keep the board as a drawing. One filled button per step. Error colour only for Stop and pen-down. No custom shapes inside the chrome, no drop shadows on the board. Labels name what happens ("Set origin here", "Trace paper frame, pen up"). Units live in the field suffix or the label, never in the value. Motion is limited to state-layer opacity, the progress indicator, the busy spinner, and strokes appearing on the sheet.