Houseki Design Studio Docs Open the studio

Getting started

This page is a tour of the whole screen: the menu bar, the cutting instructions on the left, the render in the middle, the settings on the right, and every mouse gesture and keyboard shortcut the studio has. The screenshots below show the stone the studio opens with.

The whole studio window: the top bar, the cutting instructions pane on the left, the rendered stone in the middle with its view sliders and stats box, and the render settings panel on the right.
The studio's screen: the top bar, the cutting instructions, the render, and the render settings.

The screen has four main areas, always on screen, plus a fifth that only appears while you are editing a facet:

Everything here runs from a single page in your browser, and nothing is sent to a server (see "Saving, undo and sharing" below). If you would rather keep a copy that opens without needing an internet connection, see Saving the studio to your computer.

The top bar

The studio's name sits top left. Beside it is the menu bar: File, Edit, Tools and Help. Click a menu to open it; click its button again, press Escape, or click anywhere else to close it. While one menu is open, moving the pointer onto another menu's button opens that one straight away.

At the top right, Overview always tells you which mode the page is in — it changes to say so whenever you open a mode such as editing a tier, scaling height, resizing the girdle, the cutting assistant or tilt performance.

The File menu

The File menu open, listing New, Open, Save, Export, Rename and Settings.
The File menu.
ItemWhat it does
New, SaveGreyed out; not available yet.
OpenOpens a file picker for a .obj, .asc, .gem or .gcs file. Cmd+O on a Mac, Ctrl+O elsewhere.
ExportA submenu of file formats to save the current design as. See "Saving, undo and sharing" below.
RenameOpens the cut name at the top of the cutting instructions for editing, with its text selected. F2 does the same.
SettingsOpens the settings dialog: light or dark mode, and how many decimal places an angle shows. See "Settings, theme and precision" below.

The Edit menu

The Edit menu open, listing Undo, Redo, Rotate by index, Reverse index order, Resize girdle, Flip crown and pavilion, Scale height and Manual optimizer.
The Edit menu: undo and redo, and the whole-design transforms.
ItemWhat it does
UndoSteps the design back one change. Cmd+Z on a Mac, Ctrl+Z elsewhere. Greyed out when there is nothing to undo.
RedoSteps it forward again. Shift+Cmd+Z on a Mac, Ctrl+Shift+Z (or Ctrl+Y) elsewhere.
Rotate by indexOpens a slider that turns the whole design round the index gear by a number of teeth. See Rotation by index.
Resize girdleOpens girdle resizing. See Girdle resizing.
Scale heightOpens tangent-ratio height scaling. See Tangent ratio height scaling.
Manual optimizerOpens a grid of the stone at many crown and pavilion heights, to compare and pick from. See Manual optimizer.
Reverse index order, Flip crown and pavilion Greyed out, with a tooltip explaining what each will do; not built yet. See Crown and pavilion flipping.

A greyed-out item that opens a mode (Rotate by index, Resize girdle, Scale height, Manual optimizer) says why in its tooltip: usually because another mode, such as editing a tier, is already open. Only one mode can be open at a time.

The Tools menu

The Tools menu open, listing Tilt performance, Size/yield calculator, Cutting assistant, Record rendering and Rough scan.
The Tools menu.
ItemWhat it does
Cutting assistantWalks you through cutting the design tier by tier. See Cutting assistant.
Tilt performanceGraphs how much light the stone returns as it tilts. See Tilt performance analyzer.
Record renderingRecords a drag of the stone and renders it again, frame by frame, as an MP4 video. See Recording renders.
Rough scanConnects your phone's camera with a QR code and shows it live in the studio. See Rough scan.
Size/yield calculatorGreyed out, with a tooltip explaining what it will do; not built yet. See Size and yield calculator.

The Help menu

The Help menu open, listing Documentation and bug report.
The Help menu: this documentation, and a link to report a bug.

Documentation opens this site in a new tab; bug report 💀 opens the project's issue tracker in a new tab.

The cutting instructions pane

On the left, the cutting instructions read like a sheet you would take to the machine: a title, an author and a date, then every tier of the pavilion and the crown in the order they are cut.

The cut header

The name, author and date are each a text box you click to edit: click one, type, then press Enter or click away to apply it, or Escape to cancel. The name is also what File > Rename and F2 open.

The cut name field open for editing, with its text selected, above the author and date.
Clicking the cut name (or pressing F2, or choosing File > Rename) opens it for editing.

Pavilion and crown

Below the header are two foldable sections, Pavilion then Crown — click a section's title to fold or unfold it. Each row is one tier: its letter and number (such as P1 or C3), its angle, the teeth it is cut at, and, in italics, any cutting note for it. A tier kept only for its meetpoints shows its teeth in curly braces.

The cutting instructions pane: the cut header, the Pavilion section open showing its tier rows, and the Crown section folded shut below it.
The cut header, the Pavilion section open, and Crown folded shut.

Click a row to select its tier — the same tier highlights on the stone. Double-click a row (anywhere but its cutting note) to open that tier for editing; see "Editing a facet" below. With a row focused, Space selects it the same way a click does; Enter does too if it is not already the selected row, but on the row that already is, Enter instead opens it for editing, the same as Enter anywhere else on the page while that tier is selected. Alt+↑ / Alt+↓ moves the focused row up or down within its own section. You can also press and drag a row to reorder it; a line shows where it will land, and a pavilion row can never be dropped among the crown's, or the other way round.

The plain ↑/↓ keys (no Alt, and from anywhere on the page, not only a focused row) move the selection itself instead: ↓ selects the next tier and ↑ the previous one, running down the pavilion and into the crown and stopping at either end, rather than wrapping round. With nothing selected, ↓ picks the first tier and ↑ the last.

Once a row is selected, click its cutting note to type one; the note stays with that tier even if it is later reordered.

The first pavilion tier's row selected, shown with a highlighted left edge and a tinted background.
A selected tier's row: a tinted background and an accent bar on the left.

The tier toolbar

Pinned under the tier tables, these buttons act on whichever tier is selected (except Comments, which needs no selection). Selecting a tier brings most of them alive, as it does here. In a narrow pane the seven buttons wrap onto two rows, New/Delete/Edit/Hide over Preform/Frosted/Comments; drag the pane wider and, past about 540px, they settle into one row in the same order.

The tier toolbar with a tier selected: New, Delete, Edit and Hide active on the first row, Preform and Frosted active on the second, and Comments active.
The tier toolbar, all of its buttons active once a tier is selected.
ButtonWhat it does
NewAdds a new tier, copied from the selected one, and opens it for editing.
DeleteRemoves the selected tier. Backspace or Delete does the same, from anywhere on the page a text field isn't focused.
EditOpens the selected tier for editing — the same as double-clicking its row, or pressing Enter.
Hide (reads Show for a hidden tier) Hides the tier's facets from the stone without deleting them; a hidden tier's whole row greys out.
PreformMarks the tier as a preform, used to set up meetpoints — its teeth then show in curly braces. It is still cut into the stone as usual.
FrostedMarks the tier as frosted: it darkens in the list, and its facets render as frosted glass in the Monte Carlo and Deterministic renderers.
CommentsOpens a dialog for the design's own header and footer comments, and its shape, size and refractive-index range — the free-text fields a GemCad file carries. Cmd/Ctrl+Enter saves; Escape or Cancel discards.

Backspace, Delete, Enter and the ↑/↓ keys below work from anywhere on the page, not only with a row focused — except while typing in a text field, a dialog is open, or a dropdown has focus, and ↑/↓ also do nothing while scaling height, resizing the girdle or the cutting assistant is open.

Every button and field on the whole screen has a tooltip: rest the pointer on one for about half a second and an explanation appears beside it.

Resizing the pane

The seam on the pane's right edge is also its handle: drag it to make the pane wider or narrower (it has a minimum and a maximum width), or focus it with Tab and use ←/→ to move it a step at a time, or Home/End to snap it to its narrowest or widest. The render settings panel's own left edge works the same way. Your chosen widths are remembered.

The render

The middle of the screen is the stone itself, with a ring of ticks around it (the index gear's teeth) that fades in when the stone is close to face-up or face-down.

GestureWhat it does
DragMoving sideways tilts the stone's axis to the left or right: drag right and the table tips to the right, drag left and it tips to the left. Moving up or down tilts the stone towards or away from you. A diagonal drag does both at once.
Hold Shift and dragMoving sideways spins the stone about its own axis instead of tipping it. Moving up or down tilts it towards or away from you, exactly as a plain drag does. Press or let go of Shift during a drag and sideways movement switches between spinning and tipping from that point on.
Scroll the wheelZooms in or out.
Click a facetSelects its tier — the same tier highlights in the cutting instructions. Clicking empty space clears the highlight.
Double-click a facetTurns the view to face it square on. If the facet belongs to a tier, this opens that tier for editing instead of turning (see "Editing a facet" below).
Drag a design file onto the renderLoads it, the same as File > Open. A hint appears while a file is over the render.

The view sliders

Over the bottom left of the render, two sliders turn the stone directly: X rotation (spin) turns it about its own axis, and Y rotation (tilt) tilts that axis towards or away from you. Under them, Top and Side jump straight to face-up or side-on, and also undo any sideways tilt (see below). The sliders follow whatever orbiting or double-clicking a facet has already done, and their numbers are also click-to-edit text boxes.

The X rotation (spin) and Y rotation (tilt) sliders, and the Top and Side buttons, laid over the bottom left of the render.
The view sliders and the Top/Side buttons.

Dragging sideways on the stone tilts it to your left or right: its axis tips the way you drag. Dragging up or down moves Y rotation (tilt). There is no slider for the sideways tilt; Top or Side sets it straight again. The ring of index ticks fades out once the stone is tipped more than a few degrees, just as it does when you tilt it with Y rotation (tilt).

The render after dragging to the right: the stone's table is tipped towards the right and the ring of index ticks has faded out, while the X rotation and Y rotation sliders still read 0.
After a drag to the right: the stone tipped to the right.

To spin the stone about its own axis instead, hold Shift while you drag sideways, or move the X rotation (spin) slider. Spinning keeps a face-up stone face-up, so the ring of index ticks stays in view and turns with it. Holding Ctrl makes no difference to a drag.

The render after holding Shift and dragging to the right: the stone is still face-up, turned about its own axis, the ring of index ticks still showing, and the X rotation slider reads a negative angle.
After a Shift-drag to the right: the stone spun, still face-up.

The stats box

Over the bottom right of the render, this shows the stone's facet count and three proportions, each a ratio to the girdle's width across its short axis: T/W (the table's width), C/W (the crown's height) and P/W (the pavilion's height). A ratio the stone does not have, such as a table on a pointed stone, shows a dash.

The stats box, reading Facets 67, T/W 0.189, C/W 0.207 and P/W 0.414.
The stone's facet count and proportions.

Editing a facet

Double-click a tier's row in the cutting instructions, double-click one of its facets on the stone, or select it and click Edit in the tier toolbar, to open it for editing. The top bar's mode readout then reads Editing followed by the tier's id.

A thin sub bar appears above the render, holding the index gear button and a scrolling ruler of its teeth, with Symmetry and Offset fields (or, in arbitrary mode, a box of teeth typed by hand). Drag the ruler, or scroll over it, to move the facet round the stone; the index changes as it passes each tooth.

The sub bar shown only while editing: the index gear button reading 96, a scrolling ruler of teeth, and the Symmetry and Offset fields.
The sub bar, shown only while editing a facet: the gear button and the index ruler.

In place of the render settings, the right-hand panel becomes two vertical scales, Angle and Depth: drag either (or scroll over it, or use the arrow keys once it has focus) to cut the facet there and then, with the stone updating as you go. Click the angle reading to type an exact value. A cutting plane is drawn over the stone showing exactly where the facet being edited sits.

The studio in edit mode: the mode readout reading Editing P1, the sub bar above the render, a cutting plane laid over the stone, and the angle and depth scales on the right.
Editing a facet: the sub bar, the cutting plane over the stone, and the angle/depth scales.
The edit panel's Angle and Depth vertical scales, each with a Fine button, and the facet's teeth listed underneath.
The angle and depth scales, each with a Fine toggle for slower, more precise drags.

Cancel stops editing and undoes every change made since it began; Escape does the same. Done stops editing and keeps the changes.

Only one tier can be open for editing at a time: while a facet is being edited, the other tier-toolbar buttons and rows, and double-clicking a different facet, do nothing until you choose Cancel or Done.

Clicking the gear button opens the index gear dialog: the number of teeth on the index wheel, a Fractional teeth checkbox, and an Arbitrary mode checkbox that switches the sub bar to typed indexes. Enter applies (when the fields are valid); Escape or Cancel closes it unchanged.

The index gear dialog: a Number of teeth field reading 96, and Fractional teeth and Arbitrary mode checkboxes.
The index gear dialog, opened from the gear button in the sub bar.

See Editing facets by tier for the full detail of editing, adding, deleting, hiding and reordering tiers.

The render settings panel

On the right, foldable sections choose how the stone is rendered: Material (a preset, refractive index, dispersion and stone color), Tracing (which renderer, and its quality settings) and Lighting (the lighting model and its colors). Click a section's title to fold or unfold it — here is Tracing unfolded, as an example:

The Tracing section unfolded: a Deterministic renderer picker, Max internal bounces, Resolution scale and Drag quality sliders, and a Facet wireframe switch.
The Tracing section: the renderer picker and its quality settings.

Click a color swatch, such as Stone color, to open a picker: hue, saturation, value and opacity sliders, and a Pick from screen button that samples a color from anywhere on your screen.

The color picker opened from a swatch: a Pick from screen button, then Hue, Saturation, Value and Opacity sliders.
The color picker, opened from any color swatch in the settings panel.

See Deterministic renderer and Monte Carlo renderer for what the two renderers under Tracing do.

Fullscreen

At the top of the panel, Fullscreen hides the top bar and the cutting instructions pane, leaving only the stone and this settings panel. Click it again — labelled Exit fullscreen — or press Escape, to bring them back.

Fullscreen mode: only the render and the settings panel remain on screen, with the top bar and cutting instructions hidden.
Fullscreen: everything but the render and its settings is hidden.

Settings, theme and precision

Choose File > Settings for the studio's own preferences: a light/dark toggle, and how many decimal places an angle is shown to in the cutting instructions and the angle scale. Both are remembered.

The Settings dialog: a light/dark toggle, an Angle decimal places field reading 2, and a greyed-out Concave cutting profile section.
The Settings dialog, in dark mode.

Clicking the toggle switches the whole page — this documentation included — between dark and light colors.

The same Settings dialog after switching to light mode.
The Settings dialog, in light mode.
The whole studio window in light mode, with the same layout as the dark overview.
The whole studio in light mode.

The Concave cutting profile section of the Settings dialog is a placeholder: its fields cannot be typed into or chosen yet.

Saving, undo and sharing

Every change you can undo is also saved into the page's own address as you make it — there is no separate save button, and nothing is sent to a server. Copy the address bar to send someone your design; opening it restores it exactly. See Sharing designs by link.

File > Export writes the design out as a file instead — GemCad's .gem or .asc, Gem Cut Studio's .gcs, Wavefront .obj, .stl, or a PDF cutting sheet. See Saving and exporting for opening and saving files.

Every mouse gesture and keyboard shortcut

Anywhere on the page

ShortcutDoes
Cmd+O (Mac) / Ctrl+O (elsewhere) File > Open
Cmd+S (Mac) / Ctrl+S (elsewhere) Your browser's own "save page" shortcut, not one of the studio's — File > Save itself is greyed out. See Saving the studio to your computer.
Hover any controlShows its tooltip after about half a second
Cmd+Z (Mac) / Ctrl+Z (elsewhere) Undo
Shift+Cmd+Z (Mac) / Ctrl+Shift+Z (elsewhere)Redo
Ctrl+Y (not on a Mac)Redo
F2Renames the design (opens the cut name field)
Backspace / DeleteDeletes the selected tier — the same as the tier toolbar's Delete button. Nothing while a text field, a dialog or a dropdown has focus.
EnterOpens the selected tier for editing — the same as Edit — unless focus is on a button, a link or a menu item, which it presses instead as usual. Nothing while a text field, a dialog or a dropdown has focus.
↑ / ↓Moves the tier selection to the previous or next tier, down the pavilion and into the crown, stopping at either end rather than wrapping; with nothing selected, ↓ picks the first tier and ↑ the last. Nothing while a text field, a dialog or a dropdown has focus, or while scaling height, resizing the girdle or the cutting assistant is open.
EscapeCloses an open menu or dialog. Otherwise: leaves edit mode, or scale height, or the cutting assistant, or resize girdle mode, whichever is open; with none open, leaves fullscreen.
← / → (only while the cutting assistant is open) Previous / next cut
Shift+← / Shift+→ (cutting assistant open)Previous / next tier

On the stone

GestureDoes
DragSideways tilts the stone's axis left or right, the way you drag; up and down tilt it towards or away from you
Shift+dragSideways spins the stone about its own axis instead; up and down tilt it as a plain drag does. Pressing or letting go of Shift mid-drag switches between the two
ScrollZooms in or out
Click a facetSelects its tier; clicking empty space clears the selection
Double-click a facetTurns to face it, or opens its tier for editing if it belongs to one
Drag a file onto itLoads that design

Cutting instructions rows

GestureDoes
Click a rowSelects its tier
Double-click a row (not its note)Opens that tier for editing
Space (row focused)Same as clicking it
Enter (row focused, not yet selected)Same as clicking it: selects it
Enter (row focused and already selected)Opens it for editing — the same as the page-wide Enter above
Alt+↑ / Alt+↓ (row focused) Moves the tier up/down within its section
Press and drag a rowReorders it within its section
Click a section's title (Pavilion, Crown)Folds or unfolds it

The plain ↑/↓ keys, without Alt, are not a row gesture — they move the tier selection itself from anywhere on the page; see "Anywhere on the page" above.

Text you can click to edit (the cut name, author, date, a tier's note, a slider's number)

GestureDoes
Click itOpens a text box, with its text selected where that makes sense
Enter, or clicking awayApplies the typed text
EscapeCancels, keeping the old value

Sliders

GestureDoes
Drag the thumbChanges the value
Click the number beside itOpens it for typing an exact value

The index ruler and the angle/depth scales (while editing a facet)

GestureDoes
Drag the tapeMoves it
Scroll over itMoves it
↑/↓ (any of the three, focused); also ←/→ on the index ruler Moves by one step
Page Up / Page DownMoves by one large tick
Home (index ruler) / Home, End (angle, depth) Jumps to 0, or to the near/far end of the scale
Hold Shift while dragging, or click Fine Moves five times slower, for precise placing
Click the angle readingOpens it for typing an exact value (the depth scale shows no number to click)

Dialogs

ShortcutDoes
Enter (index gear dialog)Applies, if the fields are valid
Cmd/Ctrl+Enter (comments dialog) Saves the comments
Escape, or clicking outside itCloses the dialog without applying anything

Resizing the side panes

GestureDoes
Drag the seam between two panesWidens or narrows the pane beside it
←/→ (seam focused)Moves it a step
Home / End (seam focused)Moves it to its narrowest or widest