Opening parameters

Compatibility: introduced in ARCHICAD 23.

Opening parameters – available for listing and labels only

OPENING_HEIGHT length, nominal height of the opening
2D GDL_CheckIcon 3D GDL_ErrorIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_ErrorIcon Default 1
OPENING_WIDTH length, nominal width of the opening
2D GDL_CheckIcon 3D GDL_ErrorIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_ErrorIcon Default 1
OPENING_HEIGHT length, nominal height of the opening
2D GDL_CheckIcon 3D GDL_ErrorIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_ErrorIcon Default 1
OPENING_HEADERHEIGHT_VALUES dictionary, relative elevation of the header of the opening (or topmost point if rotated) from specific reference levels
2D GDL_CheckIcon 3D GDL_ErrorIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_ErrorIcon Default {}
{
    "toHomeStory": 1.5,
    "toProjectZero": 1.5,
    "toWallBottom": 1.5,
    "toWallTop": 1.5
}
OPENING_CENTERHEIGHT_VALUES dictionary, relative elevation of the center of the opening from specific reference levels
2D GDL_CheckIcon 3D GDL_ErrorIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_ErrorIcon Default {}
{
    "toHomeStory": 1.0,
    "toProjectZero": 1.0,
    "toWallBottom": 1.0,
    "toWallTop": 2.0
}
OPENING_SILLHEIGHT_VALUES dictionary, relative elevation of the sill of the opening (or lowest point if rotated) from specific reference levels
2D GDL_CheckIcon 3D GDL_ErrorIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_ErrorIcon Default 1
{
    "toHomeStory": 0.5,
    "toProjectZero": 0.5,
    "toWallBottom": 0.5,
    "toWallTop": 0.5
}

Opening symbol parameters

OPENING_SYMBOL_DISPLAY integer, visibility of the opening symbol according to the Floor Plan Cut Plane (view dependent, do not use in parameter/property scripts)
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_ErrorIcon Default 1
  • 1 – visible
  • 2 – hidden
  • 3 – overhead
OPENING_SYMBOL_GEOMETRY dictionary, contains the geometry of the symbol (view dependent, do not use in parameter/property scripts)
2D GDL_CheckIcon 3D GDL_ErrorIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_ErrorIcon Default {}
.boundingBox2D{} (dictionary) bounding box definition of the opening polygon, always aligned with the opening symbol coordinate system.
.boundingBox2D.xmin
.boundingBox2D.xmax
.boundingBox2D.ymin
.boundingBox2D.xmax
.polygon2D{} (dictionary) projected polygon of the opening cut by the geometry of the parent element
.polygon2D.isClosed (boolean) always 1 in case of a polygon (0 – reserved for future developments)
.polygon2D.contour{} (dictionary) contains data of the polygon contour. The default polygon corresponds to the rectangle in .boundingBox2D
.polygon2D.contour.edges[n] (array) contains an embedded dictionary for each edge of the polygon
.polygon2D.contour.edges[n].type (integer) 0 – straight, 1 – curved (circular arc)
.polygon2D.contour.edges[n].begPoint{} (dictionary) an embedded dictionary for the coordinates of the beginning point of the edge
.polygon2D.contour.edges[n].begPoint.x (float)
.polygon2D.contour.edges[n].begPoint.y (float)
.polygon2D.contour.edges[n].arcAngle (angle) central angle of the edge curve, positive counter-clockwise, negative clockwise (not set for straight edges)
.polygon2D.holes[m] (array) contains data of inner holes, similar to .contour, only set when holes exist
OPENING_SYMBOL_GEOMETRY: {
    "boundingBox2D": {
        "xmin": 0,
        "xmax": 1,
        "ymin": 0,
        "ymax": 1
    },
    "polygon2D": {
        "isClosed": 1,
        "contour": {
            "edges": [
                {
                    "type": 1,
                    "begPoint": {
                        "x": 1,
                        "y": 0.5
                    },
                    "arcAngle": 90
                },
                {
                    "type": 1,
                    "begPoint": {
                        "x": 0.5,
                        "y": 1
                    },
                    "arcAngle": 90
                },
                {
                    "type": 1,
                    "begPoint": {
                        "x": 0,
                        "y": 0.5
                    },
                    "arcAngle": 90
                },
                {
                    "type": 1,
                    "begPoint": {
                        "x": 0.5,
                        "y": 0
                    },
                    "arcAngle": 90
                }
            ]
        },
        "holes": {
            "edges": [
                {
                    "type": 0,
                    "begPoint": {
                        "x": 0.4,
                        "y": 0.4
                    },
                },
                {
                    "type": 0,
                    "begPoint": {
                        "x": 0.4,
                        "y": 0.6
                    },
                },
                {
                    "type": 0,
                    "begPoint": {
                        "x": 0.6,
                        "y": 0.6
                    },
                },
                {
                    "type": 0,
                    "begPoint": {
                        "x": 0.6,
                        "y": 0.4
                    },
                }
            ]
        }
    }
}