Documentation for definitions

Showing:

Annotations

Diagram

Properties

Constraints

Compositions

Used By

Source

Definition FloorTemplate

Annotations

Title  FloorTemplate

Description  Describes a single foor within a building. Defaults to a single residential room
of a randomy type and size, and the interior is randomly furnished.

Diagram

Type

object

Properties

Name	Occurrence
Floorplan Interior	optional optional

Additional Properties

false

Used by

Schema

BuildingTemplate/properties/Floors/items

BuildingTemplate/properties/Floors

Source


 "FloorTemplate": {
  "type": "object",
  "additionalProperties": false,
  "title": "FloorTemplate",
  "description": "Describes a single foor within a building. Defaults to a single residential room\nof a randomy type and size, and the interior is randomly furnished.",
  "properties": {
    "Floorplan": {
      "title": "Floorplan",
      "default": {
        "Footprint": {
          "DesiredAspectRatio": {
            "x": 1,
            "y": 1
          }
        },
        "Ceiling": {"Height": 3},
        "Rooms": [
          {
            "Type": "Living",
            "Name": "My_Living_Room",
            "OriginalName": "My Living Room",
            "DesiredShape": {
              "Area": 20,
              "AspectRatio": {
                "x": 1,
                "y": 1
              }
            }
          }
        ],
        "DesiredConnections": []
      },
      "allOf": [
        {"$ref": "#/definitions/FloorplanTemplate"}
      ]
    },
    "Interior": {
      "title": "Interior",
      "default": {
        "Doorways": {
          "DoorwaySets": []
        },
        "Flooring": {
          "MaterialSets": []
        },
        "Walls": {
          "MaterialSets": []
        },
        "Furniture": {
          "FurnitureArrangements": []
        }
      },
      "allOf": [
        {"$ref": "#/definitions/InteriorTemplate"}
      ]
    }
  }
}

Definition Floorplan

Annotations

Title  Floorplan

Diagram

Type

object

Constraints

Default : {Footprint={DesiredAspectRatio={x=1.0, y=1.0}}, Ceiling={Height=3.0}, Rooms=[{Type=Living, Name=My_Living_Room, OriginalName=My Living Room, DesiredShape={Area=20.0, AspectRatio={x=1.0, y=1.0}}}], DesiredConnections=[]}

All of

Choices

Floorplan : Schema (0)

Additional Properties

false

Used by

Schema

FloorTemplate

Source


 "Floorplan": {
  "title": "Floorplan",
  "default": {
    "Footprint": {
      "DesiredAspectRatio": {
        "x": 1,
        "y": 1
      }
    },
    "Ceiling": {"Height": 3},
    "Rooms": [
      {
        "Type": "Living",
        "Name": "My_Living_Room",
        "OriginalName": "My Living Room",
        "DesiredShape": {
          "Area": 20,
          "AspectRatio": {
            "x": 1,
            "y": 1
          }
        }
      }
    ],
    "DesiredConnections": []
  },
  "allOf": [
    {"$ref": "#/definitions/FloorplanTemplate"}
  ]
}

Definition allOf/0

Diagram

Type

reference

Refers

FloorplanTemplate

Used by

Schema

FloorTemplate/properties/Floorplan

Source


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

Definition Interior

Annotations

Title  Interior

Diagram

Type

object

Constraints

Default : {Doorways={DoorwaySets=[]}, Flooring={MaterialSets=[]}, Walls={MaterialSets=[]}, Furniture={FurnitureArrangements=[]}}

All of

Choices

Interior : Schema (0)

Additional Properties

false

Used by

Schema

FloorTemplate

Source


 "Interior": {
  "title": "Interior",
  "default": {
    "Doorways": {
      "DoorwaySets": []
    },
    "Flooring": {
      "MaterialSets": []
    },
    "Walls": {
      "MaterialSets": []
    },
    "Furniture": {
      "FurnitureArrangements": []
    }
  },
  "allOf": [
    {"$ref": "#/definitions/InteriorTemplate"}
  ]
}

Definition allOf/0

Diagram

Type

reference

Refers

InteriorTemplate

Used by

Schema

FloorTemplate/properties/Interior

Source


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