hypar.json

{
  "$schema": "https://hypar.io/Schemas/Function.json",
  "id": "38d6e371-c600-40bc-a7b6-4f9e93ff8eee",
  "name": "MJ_ProceduralMass",
  "description": "Generates a procedural massing for a residential/office building. See sample workflow: https://hypar.io/workflows/0c29a4f5-4e8e-4f55-8101-14eafb8a2c8e.",
  "language": "C#",
  "model_dependencies": [
    {
      "autohide": false,
      "name": "Site",
      "optional": false
    }
  ],
  "model_output": "Envelope",
  "input_schema": {
    "type": "object",
    "properties": {
      "TargetCellCount": {
        "multipleOf": 1,
        "default": 50,
        "maximum": 100,
        "description": "Target cell count to cover.",
        "type": "number",
        "$hyparOrder": 4,
        "minimum": 1
      },
      "MinHeight": {
        "multipleOf": 1,
        "default": 15,
        "maximum": 50,
        "description": "Min Height for procedural mass.",
        "type": "number",
        "$hyparOrder": 5,
        "minimum": 15
      },
      "StartingLocation": {
        "multipleOf": 0.01,
        "default": 0.75,
        "maximum": 1,
        "description": "Starting cell parameter (from 0.0-1.0)",
        "type": "number",
        "$hyparOrder": 2,
        "minimum": 0
      },
      "HeightJitter": {
        "multipleOf": 0.01,
        "default": 0.5,
        "maximum": 1,
        "description": "Height randomness",
        "type": "number",
        "$hyparOrder": 7,
        "minimum": 0
      },
      "CellSize": {
        "multipleOf": 0.1,
        "default": 18,
        "maximum": 20,
        "description": "Range for size of cell",
        "type": "number",
        "$hyparOrder": 3,
        "minimum": 17
      },
      "MaxHeight": {
        "multipleOf": 1,
        "default": 80,
        "maximum": 150,
        "description": "Max Height to procedural mass.",
        "type": "number",
        "$hyparOrder": 6,
        "minimum": 50
      },
      "ObstaclePolygons": {
        "description": "List of polygons describing no-go zones.",
        "default": [],
        "optional": true,
        "type": "array",
        "$hyparOrder": 0,
        "items": {
          "name": "Obstacle Polygons",
          "description": "Polygon describing no-go zones.",
          "default": null,
          "type": "object",
          "$ref": "https://hypar.io/Schemas/Geometry/Polygon.json"
        }
      },
      "SiteSetback": {
        "multipleOf": 1,
        "default": 5,
        "maximum": 30,
        "description": "Setback of the site",
        "type": "number",
        "$hyparOrder": 1,
        "minimum": 0
      }
    }
  },
  "outputs": [
    {
      "unit_type": "none",
      "name": "Cells",
      "description": "Cell count covered",
      "type": "number"
    },
    {
      "name": "Site Cover",
      "description": "Site cover",
      "type": "string"
    },
    {
      "unit_type": "none",
      "name": "Cell Size",
      "description": "Length of cell.",
      "type": "number"
    }
  ],
  "element_types": [
    "https://prod-api.hypar.io/schemas/Envelope",
    "https://raw.githubusercontent.com/hypar-io/Schemas/master/Site.json",
    "https://prod-api.hypar.io/schemas/ProceduralMassData"
  ],
  "repository_url": "",
  "source_file_key": null,
  "preview_image": null
}