Skip to main content

Asking — doors / light / site / the drawings

Different questions put to the same description — three that answer in numbers, and three that answer in a drawing. None of them declares a pass or a fail. What comes back is a number or a form, not a verdict.

For a verdict, call validate — whether one seventh is met, whether you can get out, whether the building escapes the site is what that tool says.

You call these after check has gone green, to confirm the consequences. Move one partition and circulation and daylight change; change an area and coverage changes. check was looking at none of it.

Every piece of output on this page was obtained by actually running it. Absolute paths are shortened to <abs>.

doors​

Circulation query: how many doors lie between space A and space B (the path with the fewest doors)

ArgumentRequiredContents
fileyesThe entry .muro path
fromyesPath of the space to start from
toyesPath of the space to reach
{"name": "doors", "arguments": {"file": "<abs>/examples/two-rooms.muro", "from": "/L1/a", "to": "/out"}}
{
 "doors": 2,
 "path": [
  "/L1/a",
  "/L1/b",
  "/out"
 ]
}

doors is the number of doors; path is the sequence of spaces passed through. The route chosen is the one with the fewest doors, not the shortest one.

Routes across storeys come out of the same question. A stair boundary carries no door, so descending ten storeys adds nothing to the count.

{
 "doors": 3,
 "path": [
  "/L9/A/ldk",
  "/L9/A/hall",
  "/L9/corridor",
  "/L9/stair",
  "/L8/stair",
  "/L7/stair",
  "/L6/stair",
  "/L5/stair",
  "/L4/stair",
  "/L3/stair",
  "/L2/stair",
  "/L1/stair",
  "/out"
 ]
}

(examples/mansion.muro with {"from": "/L9/A/ldk", "to": "/out"}.)

When it cannot be reached​

{
 "unreachable": true
}

A path that does not exist gives exactly the same answer. It is not an error. {"to": "/nope"}, {"to": "/L1/x"} (a space you forgot to write) and a genuinely sealed room are indistinguishable in this result. Confirm the spelling with spaces before you ask.

doors is not a verdict on whether escape is possible. For that, read validate's koyu.schematic.access.unreachable.

light​

Daylight inputs: floor area and effective window area for every space written with daylight:1 (a 0.7 factor applies through a covered semi-outdoor space). It delivers no verdict — the 1/7 judgement comes from the validate tool

file only, required.

[
 {
  "path": "/L1/a",
  "name": "居室A",
  "windowM2": 2.86,
  "floorM2": 16.2,
  "missingH": false
 },
 {
  "path": "/L1/b",
  "name": "居室B",
  "windowM2": 2.86,
  "floorM2": 16.2,
  "missingH": false
 }
]
FieldContents
pathThe space's path
nameThe value of name:, or the last path segment
windowM2Effective area of windows facing outside, in m²
floorM2Floor area in m²
missingHWhether some window has no h:, leaving the window area under-counted

The population is what was declared​

Only spaces written daylight:1 come back. Nothing is inferred from the type. "Ask the daylight question about this room" is the writer's declaration, not the implementation's guess.

So a building that never writes daylight:1 gets an empty array. That means "nobody asked", not "there is enough daylight".

[]

The factor is derived from the form​

windowM2 is not the plain sum of w × h. A factor applies according to what is on the other side of the window.

What the window facesFactor
exterior — straight outside1
A semi-outdoor space that is open above (garden, top-floor balcony)1
A semi-outdoor space with something above it (under an eave, under the balcony above)0.7
Indoors0 — not counted

A window written without h: is not counted at all, and missingH goes true. That is the sign the number came out low — read it before you trust windowM2.

It passes no judgement​

Comparing against floorM2 / 7 is not this tool's job. The one-seventh judgement is validate's koyu.schematic.daylight.ratio. The counterpart of missingH is koyu.schematic.daylight.unknown.

site​

Site query: site area (declared against derived), road frontage, footprint, and the coverage and floor-area ratios. Numbers only — whether the declared and derived areas agree closely enough is a verdict, and comes from the validate tool

file only, required.

{
 "siteZone": "/site",
 "polygonVertices": 5,
 "declaredAreaM2": 1097.8,
 "derivedAreaM2": 1097.8,
 "footprintM2": 569.6,
 "totalFloorM2": 4785.92,
 "coverageRatio": 51.9,
 "floorAreaRatio": 436,
 "roads": [
  {
   "path": "/out/road-s",
   "name": "南側道路",
   "widthMm": 12000,
   "frontageMm": 40600
  },
  {
   "path": "/out/road-e",
   "name": "東側道路",
   "widthMm": 6000,
   "frontageMm": 20200
  }
 ]
}

(From examples/tower/main.muro.)

FieldWhen it appearsContents
siteZoneWhen there is a site:1 zoneThat zone's path
polygonVerticesWhen a site shape is writtenHow many vertices the polygon has
declaredAreaM2When the zone carries area:The surveyed value as written, in m²
derivedAreaM2When it can be derivedThe area derived from the shape, in m²
footprintM2alwaysBuilding footprint in m²
totalFloorM2alwaysTotal floor area in m²
coverageRatioWhen the site area is knownCoverage as a percentage, to one decimal
floorAreaRatioWhen the site area is knownFloor-area ratio as a percentage, to one decimal
roadsalways (empty array if none)Adjoining roads: path, name, widthMm, frontageMm

The denominator of coverageRatio and floorAreaRatio is the declared area when there is one, and the derived area otherwise.

This tool draws no line. Whether the declared and derived areas agree closely enough used to come back here as areaMatch; it does not any more. That comparison is a rule — koyu.schematic.site.area — and it belongs to validate, where the tolerance it applies is written down and can be replaced. An adapter that answered the same question with its own threshold would eventually disagree with the rule.

It answers even for a building with no site​

{
 "derivedAreaM2": 32.4,
 "footprintM2": 32.4,
 "totalFloorM2": 32.4,
 "coverageRatio": 100,
 "floorAreaRatio": 100,
 "roads": []
}

(From examples/two-rooms.muro. With no site zone there is no siteZone and no declaredAreaM2, and derivedAreaM2 comes from the building's own outline.)

That coverageRatio: 100 does not mean "100% coverage". With no site written, the building itself is being counted as the site. Do not let anyone read those two numbers off a building with no site.

It compares against no limit​

The coverage and floor-area limits of a zoning district are facts outside the description, so neither this tool nor validate holds them. What comes back is numbers.

What validate says about the site is three things: whether the building escapes the site shape (koyu.schematic.site.escape), whether the declared and derived areas disagree (koyu.schematic.site.area), and whether road frontage falls under 2 m (koyu.schematic.site.frontage).

plan_svg​

Generates and returns the plan SVG for a level (form is generated, not written — the lowest level doubles as the site plan)

ArgumentRequiredContents
fileyesThe entry .muro path
levelyesA level name (L1, say)

What comes back is the SVG string itself, not JSON. Every other tool on the server returns JSON; this one is the exception.

<svg xmlns="http://www.w3.org/2000/svg" width="682" height="782" viewBox="0 0 682 782" font-family="'Hiragino Sans','Noto Sans JP',sans-serif">
<rect width="682" height="782" fill="#faf8f4"/>
<g transform="translate(9.11 9.27) scale(0.02179)"><path d="M1027.53 171.361L224.461 171.363L…" fill="#171A18"/><path d="M707 445.022L811.864 445L…" fill="#A84940"/></g>
<path d="M 341 316 L 523 316 L 523 134 L 341 134 Z" fill="#f1ebdd"/>
<path d="M 159 498 L 341 498 L 341 134 L 159 134 Z" fill="#f1ebdd"/>
<path d="M 341 498 L 523 498 L 523 316 L 341 316 Z" fill="#f1ebdd"/>

(The first six lines of L1 from examples/house/main.muro, with the two paths of the mark shortened. The whole thing is 7,669 bytes and ends with these two lines.)

<text x="22" y="764" font-size="12" fill="#1f1f1f">小さな戸建住宅 — L1 plan</text>
</svg>

Every drawing carries the mark, drawn rather than linked — an SVG that reaches for a file is one that arrives broken as often as not.

No file is written. Only the string comes back; nothing lands on disk. Saving it is the caller's job.

The lowest level doubles as the site plan. If site, garden and road are written, they appear on that level's drawing.

An undeclared level fails​

There is no space with a region on level L9

It comes back with isError: true. No empty SVG is ever produced. Confirm level names in model_summary's levels.

A level with no space that has a region — a roof-only R, say — takes the same path.

There is no space with a region on level R

The form is generated, never described​

The plan is written nowhere in the .muro. It is derived from spaces and boundaries every time. So the same description always yields the same drawing, and there is no way to edit the drawing directly — you edit the description.

The look (colours, line weights, typeface) is not frozen. A new version may change what the SVG contains. Do not build on the assumption that the same drawing keeps coming back.

section_svg​

Generates and returns the section SVG cut at a grid reference (form is generated, not written). The reference names the plane: X3 cuts across the X axis, Y2-600 across the Y axis

ArgumentRequiredContents
fileyesThe entry .muro path
atyesThe cutting plane, as a grid reference with an optional offset — X3, X3+450, Y2-600
looknoThe direction of view. It must cross the plane: E/W for an X reference, N/S for a Y one. Defaults to W and N

The plane is named in the notation's own words. The source never writes a coordinate (positions), so neither does a cut — and at resolves through the very function at:X3+450 resolves through on an opening.

{"name": "section_svg", "arguments": {"file": "<abs>/examples/house/main.muro", "at": "X2+900"}}
<svg xmlns="http://www.w3.org/2000/svg" width="834" height="478" viewBox="0 0 834 478" font-family="'Hiragino Sans','Noto Sans JP',sans-serif">
<rect width="834" height="478" fill="#faf8f4"/>
<g transform="translate(9.11 9.27) scale(0.02179)">…</g>
<path d="M 516 374 L 698 374 L 698 254 L 516 254 Z" fill="#f1ebdd"/>
<path d="M 516 229 L 698 229 L 698 109 L 516 109 Z" fill="#f1ebdd"/>
<path d="M 334 374 L 516 374 L 516 254 L 334 254 Z" fill="#f1ebdd"/>

(9,601 bytes, ending with the title.)

<text x="70" y="460" font-size="12" fill="#1f1f1f">小さな戸建住宅 — section at X2+900 looking W</text>
</svg>

A plane on a grid line usually runs along a wall​

Spaces are allocated to grid bays, so boundaries land on grid lines. --at X2 on a building whose partition stands on X2 pochés that wall along its whole length — a correct drawing of a poor cut. Offset the plane into the bay (X2+900) to cut through the rooms.

An undeclared reference fails​

Undefined grid reference: X9 (declared: X1 X2 X3 Y1 Y2 Y3)
look N runs along X2 rather than across it (an X reference is looked at from E or W, a Y reference from N or S)

Both come back with isError: true. Confirm the grid in model_summary.

elevation_svg​

Generates and returns the elevation SVG of one face (form is generated, not written). An elevation is a section whose plane stands outside the mass, so it cuts nothing

ArgumentRequiredContents
fileyesThe entry .muro path
faceyesThe side the viewer stands on — N, E, S or W. S is the south elevation, seen from the south
{"name": "elevation_svg", "arguments": {"file": "<abs>/examples/house/main.muro", "face": "S"}}
<svg xmlns="http://www.w3.org/2000/svg" width="734" height="478" viewBox="0 0 734 478" font-family="'Hiragino Sans','Noto Sans JP',sans-serif">
<rect width="734" height="478" fill="#faf8f4"/>
<g transform="translate(9.11 9.27) scale(0.02179)">…</g>
<path d="M 573 374 L 650 374 L 650 314 L 573 314 Z" fill="#b8b0a0" stroke="#1f1f1f" stroke-width="0.35" stroke-opacity="0.5"/>
<path d="M 209 374 L 573 374 L 573 314 L 209 314 Z" fill="#b8b0a0" stroke="#1f1f1f" stroke-width="0.35" stroke-opacity="0.5"/>
<path d="M 136 374 L 209 374 L 209 314 L 136 314 Z" fill="#b8b0a0" stroke="#1f1f1f" stroke-width="0.35" stroke-opacity="0.5"/>

(11,349 bytes.)

An opening is a hole, and nothing cuts one. A wall arrives as the run of intervals its openings split it into, so its elevation has the gap in it before any drawing starts.

See also​