Check floor plan
check_floor_planRead-onlyIdempotent
Use this when the user wants to check a room layout before drawing it, or asks why a floor plan was refused, for example "do these rooms overlap?" or "what is the total area of these rooms?". Takes the same rooms, doors and windows as make_floor_plan. Returns the area table, the sum of room areas, the floor area actually covered, and a list of problems: overlapping rooms with the overlap area, doors or windows that run past a wall end, L-shaped parts that overlap or do not touch, and rooms that do not touch the rest. Does not draw the plan and does not check building codes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| doors | No | Doors, up to 60, e.g. [{"room":"Living","wall":"south","offset":1,"width":0.9}]. Drawn as a gap with a swing arc. | |
| rooms | Yes | Rooms as rectangles, up to 40. A room with no position goes to the right of the previous room. Example: [{"name":"Living","width":5,"length":4},{"name":"Kitchen","width":3,"length":4,"right_of":"Living"}]. | |
| title | No | Plan title, e.g. "Ground floor". Up to 80 characters. | |
| units | No | Unit for plain numbers. m (default), cm or mm: a metric plan, sizes like 3.5, "350 cm" or "3500 mm"; ft or in: a feet-and-inches plan, sizes like 12'6", "12 ft 6 in", "12.5 ft" or "150 in". With cm, a plain 90 is 90 cm; with in, a plain 30 is 30 inches. | |
| windows | No | Windows, up to 60, e.g. [{"room":"Kitchen","wall":"east","offset":1,"width":1.2}]. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rooms | Yes | ||
| title | Yes | ||
| units | Yes | ||
| problems | Yes | ||
| warnings | Yes | ||
| area_unit | Yes | ||
| plan_size | Yes | ||
| checks_run | Yes | ||
| room_count | Yes | ||
| covered_area | Yes | ||
| counted_twice | Yes | ||
| preview_count | No | ||
| problem_count | Yes | ||
| sum_of_room_areas | Yes |