BuildingDefinition Syntax

The Generate Building Information component (GenBuilding) accepts a single text string and generates a complete BuildingData object.

---

Full Syntax

<Template>, <Floors>, <Spans> [, Key=Value ...]

All three primary tokens are comma-separated. Additional Key=Value options can follow.

---

Token 1 — Template

The building use type. Determines default story height, span, structural system, sections, and load conditions.

Office
Mansion
Factory
Hospital
School
SRC
W

See Building Templates for the full definition of each template.

---

Token 2 — Floors

Basic: floor count only

5F

Generates 5 identical stories using the template's default story height.

Custom: specify story heights (mm)

5F:4000

All 5 floors at 4000 mm.

5F:5000:4000:4000:4000:3000

Per-floor heights: 1F→2F = 5000, 2F→3F = 4000, 3F→4F = 4000, 4F→5F = 4000, 5F→RF = 3000.

Height count rules

• If fewer heights than floors are provided, the last specified value repeats for remaining floors.
• If more heights than floors are provided, excess values are ignored.

---

Token 3 — Spans

Basic: bay count only

4x3

4 bays in X, 3 bays in Y. Uses template default spans.

Uniform span: all bays the same size

4@8000 x 3@6000

4 X-bays each 8000 mm, 3 Y-bays each 6000 mm.

Mixed spans: different sizes per bay

3@7200,8000,6000 x 2@6000

3 X-bays at 7200, 8000, 6000 mm; 2 Y-bays each 6000 mm.

Separators

X and Y are separated by any of: x · X · ×

---

Options (Token 4+)

Additional comma-separated Key=Value pairs. Order is not significant.

Structure

Override the structural catalog while keeping the base template's geometry (story height, spans, offsets).

Structure=SRC
Structure=RC
Structure=W
Structure=S

Example: An office building with SRC structural sections:

Office, 5F, 4x3, Structure=SRC

TopOfBeam

Override the beam top elevation offset from floor datum (mm).

TopOfBeam=-200

SlabOffset

Override the slab top elevation offset from floor datum (mm).

SlabOffset=50

Origin

Override the building origin coordinates.

Origin=1000,2000

Unit

Override the unit system.

Unit=metric
Unit=imperial

---

Complete Examples

Prompt	Description
Office, 5F, 4x3	5-floor S-frame office, 4×3 grid, all defaults
Mansion, 10F:3000, 3@6000 x 2@8000	10-floor RC mansion, 3000 mm stories, custom spans
Factory, 2F:8000:6000, 5@10000 x 3@12000	2-floor factory with large bays
Hospital, 8F, 6@8000 x 4@8000	8-floor RC hospital
Office, 5F, 4x3, Structure=SRC	Steel office geometry + SRC catalog
W, 3F:3000, 5@3640 x 3@3640	3-floor timber building, 910mm modular grid
Office, 5F, 4@8000 x 3@7200, TopOfBeam=-200, Origin=5000,3000	Full options

---

Warning Handling

The parser is fault-tolerant. If a token cannot be parsed, a warning is issued and a default value is used. Warnings appear:

• In the Info output of the component.
• As Grasshopper runtime warning bubbles on the component.

Condition	Fallback
Template not recognized	Office
Floor count missing	3F
Span token missing	3x3
Invalid story height value	Template default height
Invalid span value	Template default span
Unknown Structure= value	Default catalog from template