TWBDocs

The editor

Anatomy of the editor

The editor is one component that does many things, each in its own place on it. These are the places, by the names we use for them — in the code, in these pages and when we talk with you.

The map

The view fills the editor; everything else floats over it in small pills and cards, so the house is never pushed aside. A place is only shown when there is something in it: one view needs no switch, a view without tools has no rail.

A diagram of the editor with its nine regions numbered where they are
The nine regions, numbered; each is described below.

The regions

RegionWhat it is forPut there with
1StageThe whole editor, under everything else The view shown: the house in plan, in 3D or as its drawings. Everything else floats over it.2D plan editor, 3D viewer, the shell’s 3D, the drawing set ctx.addView({ id, label, pane, fit, nav })
2View switchTop left Switches between the views: 3D and 2D as buttons, the others in a menu behind one more when there are two or more of them. Hidden while there is only one view.3D · 2D · Drawings, or 3D · 2D · More ▾ ctx.addView({ label, hint, order }) · editor.view
3Tool railDown the left edge, under the view switch The tools of the view shown: what a click in the view does. Changes with the view.Select, Wall, Arc, Section (2D) · Faces, Edges (3D) · Members, Faces (shell) ctx.addTool({ view, item, active, pick })
4LegendDown the left edge, in the tool rail’s place While a display colours the house by what was worked out — an analysis shown on the plan and in 3D — what its colours mean, its figures room by room or part by part (one clicked is drawn alone), and Close, the way out of it. The house is looked at, not drawn, so the rail is put away while it is shown, and the card that turned the display on folds away. One at a time.Daylight factor (each room’s median), Hours over 27 °C (each room’s hours), Where the heat goes (each build-up’s W/K) ctx.addLegend(el, shown)
5Corner menuTop right One button for how the view is shown and the panels the features open; the open panel’s name beside it, to close it. Pills wanted at hand while working sit beside it.Show: Walls, Dimensions, Shown as · Panels: Build-ups, Zones, Frame, Cutting list · Module ctx.addChoice({ label, control }) · ctx.addMenuItem({ label, hint, icon, active, toggle }) · ctx.addPill(el, shown)
6Side panelsDown the right side, under the pills What a pill opens: a list or a panel about the whole house. A host’s own panel can open here too.Build-ups list, Frame panel · a host’s panel ctx.addOverlay(el) · editor.openPanel({ place: 'side', … })
7Pick cardsOver the foot of the view, right (the freeform and member cards left) About what was clicked in the view: a face, an edge, a room, a member. A host can take the click and show its own card here instead.Face card, joint wizard, freeform card, room card, member card · a host’s card options.onPick(pick, editor) · editor.openPanel({ place: 'card', … })
8SheetsOver the whole view A view a level down, opened from the one under it, which shows dimmed round its edge. The cross, Escape or Back goes back.A section opened, a build-up in the layer builder <sk-sheet> through ctx.addOverlay(el)
9Camera barOver the foot of the view, centre Moves the camera: select, orbit, pan, zoom extents, the level shown, explode. Keys O, H, Space, Shift+Z.Select · Orbit · Pan · Zoom extents · Levels · Explode the view’s nav(), setNavMode(), fit(), pickLevel()
10Status lineAlong the foot What the last edit did, or why it was refused; what the view shows in figures.“Structure: 412 members of timber.” · “Deleted ‘Wall 2’.” ctx.status.set(text)

On the editor itself

The same regions outlined on a live editor. Here a face has been clicked in 3D: its card opens over the foot of the view, at the right — a card of the host’s own, in this case (see Make it your own).

The editor in 3D with each region outlined and named, a wall picked and its card open
Each region outlined where it is. The card at the right is a host’s, opened on the wall picked.
The plan with a room picked and the host’s card on it
A room picked in the plan: its card in the same place.