Showing:

Annotations
Diagram
Properties
Constraints
Compositions
Used By
Source
Definition FloorplanTemplate
definitions_FloorplanTemplate.html#/definitions/FloorplanTemplate/properties/Footprint definitions_FloorplanTemplate.html#/definitions/FloorplanTemplate/properties/Ceiling definitions_FloorplanTemplate.html#/definitions/FloorplanTemplate/properties/Rooms definitions_FloorplanTemplate.html#/definitions/FloorplanTemplate/properties/DesiredConnections
Annotations
Title  FloorplanTemplate

Description  The top-level floorplan template that parameterizes the randomly generated
architectural layout. By default, a residential floorplan with bedroom and
living room are generated with a random doorway or opening connection.

The footprint contributes to the overall shape of the floor layout along
with rooms. The footprint shape is desired as it is a preference and not
guaranteed.

The ceiling determines the height of the walls. There are minimum and maximum ceiling heights. The ceiling height is guaranteed.

Rooms are required. Each room has a desired shape. Together, the room
shapes and footprint determine floor layout. The room types contribute to
the layout and are used when randomly selecting furniture and materials for
the walls and floors.

DesiredConnections are optional. Two rooms are connected if they share a
wall and doorway or adjacent without any wall aka "opening". All rooms are
guaranteed to be connected randomly if they are not specified in the
connections list. Connections that are specified are _not_ guaranteed but
will be attempted as best-effort.
Diagram
Type object
Properties
Name Occurrence
Footprint
Ceiling
Rooms
DesiredConnections
optional
optional
optional
optional
Additional Properties false
Used by
Source

 "FloorplanTemplate": {
  "type": "object",
  "additionalProperties": false,
  "title": "FloorplanTemplate",
  "description": "The top-level floorplan template that parameterizes the randomly generated\narchitectural layout. By default, a residential floorplan with bedroom and\nliving room are generated with a random doorway or opening connection.\n\nThe footprint contributes to the overall shape of the floor layout along\nwith rooms. The footprint shape is desired as it is a preference and not\nguaranteed.\n\nThe ceiling determines the height of the walls. There are minimum and maximum ceiling heights. The ceiling height is guaranteed.\n\nRooms are required. Each room has a desired shape. Together, the room\nshapes and footprint determine floor layout. The room types contribute to\nthe layout and are used when randomly selecting furniture and materials for\nthe walls and floors.\n\nDesiredConnections are optional. Two rooms are connected if they share a\nwall and doorway or adjacent without any wall aka \"opening\". All rooms are\nguaranteed to be connected randomly if they are not specified in the\nconnections list. Connections that are specified are _not_ guaranteed but\nwill be attempted as best-effort.",
  "properties": {
    "Footprint": {
      "title": "Footprint",
      "default": {
        "DesiredAspectRatio": {
          "x": 1,
          "y": 1
        }
      },
      "allOf": [
        {"$ref": "#/definitions/FloorplanFootprint"}
      ]
    },
    "Ceiling": {
      "title": "Ceiling",
      "default": {"Height": 3},
      "allOf": [
        {"$ref": "#/definitions/FloorplanCeiling"}
      ]
    },
    "Rooms": {
      "type": "array",
      "minItems": 1,
      "maxItems": 6,
      "title": "Rooms",
      "default": [
        {
          "Type": "Living",
          "Name": "My_Living_Room",
          "OriginalName": "My Living Room",
          "DesiredShape": {
            "Area": 20,
            "AspectRatio": {
              "x": 1,
              "y": 1
            }
          }
        }
      ],
      "items": {}
    },
    "DesiredConnections": {
      "type": "array",
      "minItems": 0,
      "maxItems": 12,
      "title": "Desiredconnections",
      "default": [],
      "items": {}
    }
  }
}


Definition Footprint
#/definitions/FloorplanTemplate/properties/Footprint/allOf/0
Annotations
Title  Footprint

Diagram
Type object
Constraints
Default : {DesiredAspectRatio={x=1.0, y=1.0}}

All of
Additional Properties false
Used by
Source

 "Footprint": {
  "title": "Footprint",
  "default": {
    "DesiredAspectRatio": {
      "x": 1,
      "y": 1
    }
  },
  "allOf": [
    {"$ref": "#/definitions/FloorplanFootprint"}
  ]
}


Definition allOf/0
definitions_FloorplanFootprint.html#/definitions/FloorplanFootprint
Diagram
Type reference
Refers FloorplanFootprint
Used by
Source

{"$ref": "#/definitions/FloorplanFootprint"}


Definition Ceiling
#/definitions/FloorplanTemplate/properties/Ceiling/allOf/0
Annotations
Title  Ceiling

Diagram
Type object
Constraints
Default : {Height=3.0}

All of
Additional Properties false
Used by
Source

 "Ceiling": {
  "title": "Ceiling",
  "default": {"Height": 3},
  "allOf": [
    {"$ref": "#/definitions/FloorplanCeiling"}
  ]
}


Definition allOf/0
definitions_FloorplanCeiling.html#/definitions/FloorplanCeiling
Diagram
Type reference
Refers FloorplanCeiling
Used by
Source

{"$ref": "#/definitions/FloorplanCeiling"}


Definition Rooms
definitions_FloorplanTemplate.html#/definitions/FloorplanTemplate/properties/Rooms/items
Annotations
Title  Rooms

Diagram
Type array
Constraints
Unique Items : false

Array Items
Additional Items true
Used by
Source

 "Rooms": {
  "type": "array",
  "minItems": 1,
  "maxItems": 6,
  "title": "Rooms",
  "default": [
    {
      "Type": "Living",
      "Name": "My_Living_Room",
      "OriginalName": "My Living Room",
      "DesiredShape": {
        "Area": 20,
        "AspectRatio": {
          "x": 1,
          "y": 1
        }
      }
    }
  ],
  "items": {"$ref": "#/definitions/FloorplanRoom"}
}


Definition Rooms/items
definitions_FloorplanRoom.html#/definitions/FloorplanRoom
Diagram
Type reference
Refers FloorplanRoom
Used by
Source

 "items": {"$ref": "#/definitions/FloorplanRoom"}


Definition DesiredConnections
definitions_FloorplanTemplate.html#/definitions/FloorplanTemplate/properties/DesiredConnections/items
Annotations
Title  Desiredconnections

Diagram
Type array
Constraints
Unique Items : false

Array Items
Additional Items true
Used by
Source

 "DesiredConnections": {
  "type": "array",
  "minItems": 0,
  "maxItems": 12,
  "title": "Desiredconnections",
  "default": [],
  "items": {"$ref": "#/definitions/FloorplanConnection"}
}


Definition DesiredConnections/items
definitions_FloorplanConnection.html#/definitions/FloorplanConnection
Diagram
Type reference
Refers FloorplanConnection
Used by
Source

 "items": {"$ref": "#/definitions/FloorplanConnection"}