• Global GDL Parameters

---

General Global Variables

GLOB_SCRIPT_TYPE

Old name: T~
Type: numerical (positive integer value)
Possible range: 1 – 5
Returns a number corresponding to the type of the current GDL script the program is in at the moment of generating the value. The following table shows the numerical values returned when used in each script:

Note: Parameter Script was called ‘Value List Script’ in versions prior to 6.5

GLOB_CONTEXT

Type: numerical (positive integer value)
Possible range: 1 – 6
Returns an number corresponding to the type of Window in which the Library Part or information about the Library Part appears in at the moment of generating the value. Possible values include:

GLOB_SCALE

Old name: A_
Type: numerical (positive integer value)
Possible range: 1 – 30000
Returns a number corresponding to the scale of the drawing as set in the current Window (e.g. it returns 100 for M 1:100). The variable returns a valid value in the Floor Plan Window, in the Section/Elevation Windows, in the Library Parts’ 2D Symbol and 2D Full View Windows and in Lists.

Imperial scales available in ArchiCAD are calculated according to the following table:

GLOB_NORTH_DIR

Old name: U~
Type: numerical (angle value)
Possible range: 0 – 360.0000 (in degrees)
Returns the Project North direction relative to the horizontal direction of the default project coordinate system (relative to Global Origin). This value can be set in the ‘Sun’ Dialog.

The field in the Sun Dialog Box corresponding to GLOB_NORTH_DIR

Notes:

• This Dialog can be accessed by clicking the ‘More Sun...’ button in Image3D Projection Settings...

• Changing to skewed grid in the Floor Plan Window has no effect on this value.

GLOB_DRAWING_BGD_PEN

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index number of the pen from the currently defined ArchiCAD palette that most closely approximates the color of the background of the Window in which the value is generated. The index number of this pen will be returned when the value is generated while in the Floor Plan Window, in any Section/Elevation Window and in a Library Part’s 2D Symbol or 2D Full View Window

The field in the Grids & Background Dialog corresponding to GLOB_DRAWING_BGD_PEN.

The field in the 3D Window Settings Dialog corresponding to GLOB_DRAWING_BGD_PEN. The index number of this pen will be returned when the value is generated while in the 3D Window or in a Library Part’s 3D View Window

GLOB_SUN_AZIMUTH & GLOB_SUN_ALTITUDE

Type: numerical (angle value)
Possible range: -360.0000 – 360.0000 (in degrees)
Returns the value of the Sun Azimuth/Sun Altitude as set in the 3D Projection Setting Dialog Box.

The fields in the 3D Projection Settings Dialog corresponding to GLOB_SUN_AZIMUTH and GLOB_SUN_ALTITUDE

Notes:

• Changing the ‘Sun Azimuth/Sun Altitude’ settings in the Camera/VR Settings Dialog will not change these Global variables unless the values are transferred to the 3D Projection Settings Dialog.

• Since the Library Part’s Sun Azimuth/Sun Altitude settings can be defined separately, these Global variables can show different values in the ArchiCAD Floor Plan/3D/Section/Elevation Windows and in the Library Part Editing Dialog’s 2D Full View/3D View Windows.

GLOB_MODPAR_NAME

Type: string
Possible length: 30 characters
Returns the name of that parameter of the Library Part that was last modified in the Library Part Settings Dialog or in the Library Part Editing Dialog.

---

Story Information

GLOB_HSTORY_ELEV

Old name: B_
Type: numerical (real value)
Possible range: -100.0000 and up (in meters)
Returns the elevation of the home story of the object, which is the story the object is placed on as set in the Story Settings Dialog. Since there is no story-related information in the 3D Window, there the variable does not return a valid value.

Illustration for Global variables providing Story information

The fields in the Story Settings Dialog corresponding to GLOB_CSTORY_ELEV, GLOB_CSTORY_HEIGHT, GLOB_HSTORY_ELEV & GLOB_HSTORY_HEIGHT in case of the above example.

In the above example (stair is placed on story 0 and the current story is 1. story) GLOB_HSTORY_ELEV is 1.50 m, GLOB_CSTORY_ELEV is 4.50 m, both GLOB_HSTORY_HEIGHT and GLOB_CSTORY_HEIGHT are 3.00 m and GLOB_CH_STORY_DIST is ‘1’ since the current story is one story higher than the home story of the Library Part.

GLOB_HSTORY_HEIGHT

Old name: Q_
Type: numerical (positive value)
Possible range: 0 – 9999.9900 (in meters)
Returns the height of the home story of the object, which is the story the object is placed on as set in the Story Settings Dialog. Since there is no story-related information in the 3D Window, there the variable does not return a valid value. Note: see illustration at GLOB_HSTORY_ELEV.

GLOB_CSTORY_ELEV

Old name: Q~
Type: numerical (real value)
Possible range: -100.0000 and up (in meters)
Returns the elevation of the current story, which is the story currently shown in the Floor Plan Window as set in the Story Settings Dialog. Since there is no story-related information in the 3D Window, there the variable does not return a valid value.
Note: see illustration at GLOB_HSTORY_ELEV.

GLOB_CSTORY_HEIGHT

Old name: R~
Type: numerical (positive value)
Possible range: 0 – 9999.9900 (in meters)
Returns the height of the current story, which is the story currently shown in the Floor Plan Window as set in the Story Settings Dialog. Since there is no story-related information in the 3D Window, there the variable does not return a valid value.
Note: see illustration at GLOB_HSTORY_ELEV.

GLOB_CH_STORY_DIST

Old name: S~
Type: numerical (integer value)
Possible range: positive or negative or zero.
Returns a number giving the relative position of the current story to the home story of the Library Part. The value of the variable is calculated by deducting the story number of the home story from the story number of the current story. Since there is no story-related information in the 3D Window, there the variable does not return a valid value.
Note: see illustration at GLOB_HSTORY_ELEV.

---

Fly-through information

GLOB_FRAME_NR

Old name: N_
Type: numerical (positive integer value)
Possible range: 1 and up
Returns the current frame number in animations. The variable returns a valid value only for animations. In case of still images the variable returns ‘0’ as a value.
Note: You need to enable the ‘Rebuild Model for Each Frame’ checkbox in the Create Fly-Through Dialog in order for the variable to give the correct value for each frame of the animation.

+The field in the Create Fly-Through Dialog enabling the operation of the GLOB_FRAME_NR variable

GLOB_FIRST_FRAME & GLOB_LAST_FRAME

Old names: O_ and P_, respectively
Type: numerical (positive integer value)
Possible range: 1 and up
Return the frame numbers of the first frame and the last frame in the fly-through. You can set these values in the Fly-Through Dialog in the two fields of the ‘Frames from – to’ portion of the Dialog. In case you select the ‘All Frames’ option instead, GLOB_FIRST_FRAME will be ‘1’ and GLOB_LAST_FRAME will return the last frame number of the full fly-through. The variable returns a valid value only for animations.

The fields in the Fly-Through Dialog corresponding to GLOB_FIRST_FRAME and GLOB_LAST_FRAME.

Note: You need to enable the ‘Rebuild Model for Each Frame’ checkbox in the ‘Create Fly-Through’ Dialog in order for the variable to give the correct value for each frame of the animation.

GLOB_EYEPOS_X, GLOB_EYEPOS_Y & GLOB_EYEPOS_Z

Old names: K~, L~ and M~, respectively
Type: numerical (real value)
This trio of global variables returns the X, Y and Z coordinates of the current position of the camera. In case of still images it is the position marked with the selection hotspot of the camera in the Floor Plan Window that is selected to generate a perspective. In case of fly-throughs the program automatically calculates camera positions between placed camera positions based on settings made in the fly-throughs path. The global variables return valid values in case of perspective projections only (in case of both fly-throughs and still images). In the Floor Plan and 3D Windows they return the coordinates of the last selected camera eye position.

The fields in the Coordinate Box and the Camera/VR Dialog corresponding to GLOB_EYEPOS_X, GLOB_EYEPOS_Y and GLOB_EYEPOS_Z. The location of the Eye position in the Floor Plan Window is also shown.

Note: The coordinates are relative to the Project Origin and changing the User Origin has no effect on them.

GLOB_TARGPOS_X, GLOB_TARGPOS_Y & GLOB_TARGPOS_Z

Old names: N~, O~ and P~, respectively
Type: numerical (real value)
This trio of global variables returns the X, Y and Z coordinates of the current position of the target to where the camera points. In case of still images it is the position marked with the Sun icon in the Floor Plan Window. In case of fly-throughs the program automatically calculates target positions between placed camera target positions based on settings made in the fly-throughs path. The global variables return a valid value in case of perspective projections only (in case of both fly-throughs and still images). In the Floor Plan and 3D Windows they return the coordinates of the last selected camera eye position.

The X,Y and Z values in the Coordinate Box and the Camera/VR Dialog Box corresponding to GLOB_TARGPOS_X, GLOB_TARGPOS_Y and GLOB_TARGPOS_Z. The location of the Target position in the Floor Plan Window is also shown.

Note: the coordinates are relative to the Project Origin and changing the User Origin has no effect on them.

---

General element parameters

GLOB_LAYER

Type: string
Possible length: 31 characters
Possible values: layer names as set or modified in the Layer Settings Dialog Returns the layer name of the element (the name of the layer the element is assigned to).

The fields and values in the Info Box and the Coordinate Box corresponding to GLOB_ELEVATION, GLOB_ID and GLOB_LAYER

GLOB_ID

Type: string
Possible length: 15 characters
Returns the user ID of the element as set in the element’s Settings Dialog or modified in the Info Box when the element is selected.
Note: see illustration at GLOB_LAYER

GLOB_INTID

Type: numerical (positive integer value)
Possible range: 1 and up
Returns the internal ID of the element. The internal ID is a unique identifier generated by the program at the moment of the creation of the element and cannot be controlled by the user.
Note: no two elements generated by ArchiCAD in the same Project have the same unique ID number.

GLOB_ELEVATION

Old name: J_
Type: numerical (real value)
Returns the base elevation height of the element relative to the Project Origin.

The field in the Object Settings Dialog corresponding to GLOB_ELEVATION

In case of Doors/Windows the variable returns the sill height of the Window/Door as set in the Window/Door Settings Dialog.

The fields in the Window/Door Settings Dialog and the Window/Door Dimension Dialog influencing the value returned by GLOB_ELEVATION in case of Doors/Windows

Notes:

• sill height is calculated as height of Window/Door from the bottom of the wall into which it is placed (as set in Window/Door Dialog or Info Box) minus subfloor thickness (as set in the Window/Door Dimension Dialog accessible from the Window/Door Dialog).

• for the subfloor thickness value to have an effect on the returned value, the Dimensioning button has to be checked in the Window/Door Settings Dialog.

The Dimensioning button in the Window/Door Settings Dialog

---

General element parameters - available for listing only

GLOB_ELEM_TYPE

Type: numerical (positive integer value)
Possible range: 1 – 12
Returns a number corresponding to the type of the element. The following table shows the numerical values returned for each element type:

The values returned by GLOB_ELEM_TYPE

---

Object, Lamp, Door, Window parameters

SYMB_LINETYPE

Type: numerical (positive integer value)
Possible range: 1 and up
Returns the index number of the line type of the Object, Lamp, Door or Window used to draw it in the Floor Plan Window as set in their respective Settings Dialogs. The variable is applied as the default line type of the 2D symbol of the Library Part.

The fields in the Object Settings Dialog corresponding to SYMB_LINETYPE, SYMB_VIEW_PEN, SYMB_FILL, SYMB_SECT_PEN, SYMB_FBGD_PEN and SYMB_FILL_PEN

The fields in the Window/Door Settings Dialog corresponding to SYMB_LINETYPE, SYMB_VIEW_PEN, SYMB_FILL, SYMB_SECT_PEN, SYMB_FBGD_PEN and SYMB_FILL_PEN

SYMB_FILL

Type: numerical (positive integer value)
Possible range: 1 and up
Returns the index number of the fill type assigned to be shown on the cut surfaces of the Object, Lamp, Door or Window in Section/Elevation Windows as set in their respective Settings Dialogs.
Note: see illustrations at SYMB_LINETYPE

SYMB_FILL_PEN

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index number of the pen used to draw in the Section/Elevation Windows the fill pattern of the cut surfaces of the Object, Lamp, Door or Window as set in their respective Settings Dialogs.
Note: see illustrations at SYMB_LINETYPE.

SYMB_FBGD_PEN

Type: numerical (integer value)
Possible range: 0 – 255
Returns the index number of the pen used to draw in the Section/Elevation Windows the fill background of the Object, Lamp, Door or Window as set in their respective Settings Dialogs. It can return the value ‘0’ as well, which means the background is transparent.
Note: see illustrations at SYMB_LINETYPE.

SYMB_SECT_PEN

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index number of the pen used to draw in the Section/Elevation Windows the contours of the cut surfaces of the Object, Lamp, Door or Window as set in their respective Settings Dialogs.
Note: see illustrations at SYMB_LINETYPE.

SYMB_VIEW_PEN

Old name: L_
Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the default pen index number of the Object, Lamp, Door or Window as set in their respective Settings Dialogs. This pen is applied on all edges in the 3D Window and on edges on view (not cut surfaces) in Section/Elevation Windows.
Note: see illustrations at SYMB_LINETYPE

SYMB_MAT

Old name: M_
Type: numerical (positive integer value)
Possible range: 1 and up
Applies to: 3D Window & Photorendering Window
Returns the index number of the default material of the Window/Door, Object or Lamp as set in its Settings Dialog that is applied to its surfaces when generating it in the above Windows.

The field in the Library Part Settings Dialog corresponding to SYMB_MAT

SYMB_POS_X, SYMB_POS_Y & SYMB_POS_Z

Old names: X~, Y~ and Z~, respectively
Type: numerical (real value)
Possible range: all three values can be positive or zero (for Windows/Door, Objects and Lamps) or negative (for Windows/Doors, in case the Local Origin of the Window/Door is outside the body of the Wall – a possible case).
This trio of variables returns the X, Y and Z coordinates of the position of the Library Part’s Local Origin relative to the Project Origin. This point is not the point or selection dot by which the Library Part is placed in the Project. This is the point within the Library Part with the local coordinates {0,0,0}. This is the location the Library Part is placed to when there are no transformations (such as the ADD2 statement) in the 2D Script of the Library Part.

The fields in the Coordinate Box corresponding to SYMB_POS_X, SYMB_POS_Y and SYMB_POS_Z

In case of the bed shown above, the Local Origin of the ‘Bed’ Library Part is at the point marked with the red pair of arrows in the Floor Plan Window. By going to the Library Part Editing Dialog and generating a 2D Full View you can always determine where its Local Origin is relative to the 2D View of the Object. Even though the Object was placed in the Floor Plan Window by its left-lower corner at the coordinates {0,0}, the Local Origin of the Library Part is at {0.45,2.00} in the X-Y plane.

In case of Doors/Windows, the variables return the position of the Local Origin of the Window/Door relative to the starting point and the bottom of the Wall in which they are placed. The starting point of any Wall is the starting point of its reference line. Let’s consider the case below:

Example of SYMB_POS_X, SYMB_POS_Y and SYMB_POS_Z

The three values generated for this example as parts of the Window Object’s 2D View are (from top to bottom) SYMB_POS_X, SYMB_POS_Y and SYMB_POS_Z. The pair of arrows in the Floor Plan Window shows the Local Origin of the Window Object. The Local Origin is 2.75 meters from the starting point of the enclosing Wall. This is the value of SYMB_POS_X. However, the Y and Z coordinates are swapped because of the special way Doors/Windows are generated in GDL (see Chapter 12.1 General Guidelines in the GDL Reference Manual). For this reason, the SYMB_POS_Y variable returns the height of the Window/Door in the Wall. This value is 0.9 meters in our example. SYMB_POS_Z is calculated by how far above the Window/Door’s Local X-Y plane from the reference side plane of the Wall is. Depending on which side of the Wall the Window/Door is and if it is flipped, SYMB_POS_Z can be either positive or negative. In our above example, flipping the Window - the frame width of which is 0.10 meters - would cause SYMB_POS_Z to return –0.15 meters as shown by the illustration below. Please note how the position of the Local X-Y of the Object changed by flipping it:

Example of SYMB_POS_X, SYMB_POS_Y and SYMB_POS_Z when the Window is flipped

---

Object, Lamp parameters

SYMB_ROTANGLE

Old name: W~
Type: numerical (angle value)
Possible range: 0 – 359.9990° (in Settings Dialog a value between -359.9990° – 359.9990° can be entered, which then will be converted to value within the given range)
Returns the rotation angle of the Library Part in the X-Y plane as set in the Library Part Settings Dialog. The rotation is performed around the anchor point of the Object. The anchor point is that selection dot of the Library Part by which it is placed.

The fields in the Library Part Settings Dialog corresponding to SYMB_ROTANGLE and SYMB_MIRRORED

The variable is valid even in case of Doors/Windows and is either 0° or 180° depending on whether the body of Window/Door extends upwards/downwards and whether it is flipped. Let’s consider the following example:

Examples for SYMB_ROTANGLE at various Window placements (direction where Window looks at and flipping)

If you open the Window/Door for editing and generate its 2D Full View you will see the following or similar:

2D Full View of Window

As you can see the body of the Window extends downwards from its Local Origin. If in the Floor Plan Window the Window is generated the same way (its body extending downward as in the Editing Dialog) the returned value is 0°. Whenever its body extends upwards the returned value is 180° (because the original generated 2D view of the Window has to be rotated 180° to be correctly displayed.
In the above example fro SYMB_ROTANGLE, the Window is placed in a Wall 0.30 meters wide and the sill is 0.05 meters deep. The four possible states of the Window/Door are (from top to bottom):
Window is at upper side of Wall, it is not flipped (thus window body extends downward) – SYMB_ROTANGLE is 0°
Window is at lower side of Wall, it is not flipped (thus window body extends upward) – SYMB_ROTANGLE is 180°
Window at lower side of Wall, it is flipped (thus window body extends downward) – SYMB_ROTANGLE is 0°
Window at upper side of Wall, it is flipped (thus window body extends upward) – SYMB_ROTANGLE is 180°

SYMB_MIRRORED

Old names: V~
Type: numerical (integer value)
Possible range: 0 or 1
Returns a number corresponding to the ‘mirrored’ status of the Library Part. The returned value is ‘0’ if the ‘Mirrored’ checkbox in the Library Part Settings Dialog is not checked and it is ‘1’ if it is checked. When done, the mirroring is performed around the current anchor point, which is the point by which the Library Part is placed.
Note: unlike the SYMB_ROTANGLE variable, this variable is not valid for Doors/Window (it always returns 0).

The checkbox in the Library Part Settings Dialog corresponding to SYMB_MIRRORED

---

Object, Lamp, Door, Window parameters - available for listing only

SYMB_A_SIZE

Type: numerical (positive value)
Possible range: 0 or up (in meters)
Returns the nominal length of Library Part (usually the dimension parallel with the X-axis) as set in its Settings Dialog. In case of Doors/Windows it returns the width of the Window/Door.

The fields in the Library Part Settings Dialog corresponding to SYMB_A_SIZE, SYMB_B_SIZE and SYMB_Z_SIZE

SYMB_B_SIZE

Type: numerical (positive value)
Possible range: 0 or up (in meters)
Returns the nominal width of the Library Part (usually the dimension perpendicular to the X-axis) as set in its Settings Dialog. In case of Doors/Windows it returns the height of the Window/Door.

The fields in the Window/Door Settings Dialog corresponding to SYMB_A_SIZE and SYMB_B_SIZE

---

Object, Lamp parameters - available for listing only

SYMB_Z_SIZE

Type: numerical (positive value)
Possible range: 0 or up (in meters)
Returns the nominal height of the Library Part (the dimension parallel to the X-Y plane) as set in its Settings Dialog.
If the first user parameter as set in the Object/Lamp Editing Dialog is named ‘zzyzx’ then this will be used as the nominal height for the element. Otherwise the nominal height cannot be set in the Dialog and the variable will return ‘0’. Also, if the Library Part has no 3D part the variable will return ‘0’.

Example of a lamp where no field appears below the length and width fields for setting nominal height. See illustration at SYMB_A_SIZE where there is field for setting nominal height as a result of zzyzx being the first user parameter

The result of a simple list where nominal size global variables of the example bed at SYMB_A_SIZE are listed.

---

Window, Door parameters

WIDO_REVEAL_ON

Type: numerical (integer value)
Possible values: 0 or 1
Returns a number corresponding to the current state of the reveal of the Window/Door as set in their Settings Dialog. The returned value is ‘0’ if the reveal is turned OFF and it is ‘1’ if the reveal is turned ON.

The buttons in the Window/Door Settings Dialog influencing the value of WIDO_REVEAL_ON (top) and the fields corresponding to WIDO_SILL (middle) and WIDO_REVEAL_SIDE (bottom). Of the three buttons below the Preview Window the left and middle ones set WIDO_REVEAL_ON to ‘0’ and the one on the right sets it to ‘1’.

WIDO_SILL

Old name: K_
Type: numerical (real value)
Possible range: any value (in meters - can be even negative)
Returns the sill size of the Window/Door as set in their Settings Dialog. In the case of the Window/Door being in a curved wall the distance is measured in radial direction from the imaginary line connecting the ends of two sides of the Window/Door. Please see illustration below.

The values corresponding to WIDO_SILL in case of straight and curved walls.

Note: if the Window/Door has a reveal the ‘Reveal depth’ field in the Reveal Setup Subdialog of the Window/Door Settings Dialog is the field corresponding to WIDO_SILL.

The field in the Reveal Setup Subdialog corresponding to WIDO_SILL.

WIDO_RIGHT_JAMB

Old name: B~
Type: numerical (positive value)
Possible range: 0 to half of nominal width of Window/Door (SYMB_A_SIZE/2) (in meters)
Returns the jamb depth on the left side of the Window/Door as set in the Reveal Setup Subdialog of the Window/Door Settings Dialog. If there is no reveal the returned value is ‘0’.

The fields in the Reveal Setup Dialog corresponding to WIDO_RIGHT_JAMB and WIDO_LEFT_JAMB

WIDO_LEFT_JAMB

Type: numerical (positive value)
Possible range: 0 to half of nominal width of Window/Door (SYMB_A_SIZE/2) (in meters)
Returns the jamb depth on the right side of the Window/Door as set in the Reveal Setup Subdialog of the Window/Door Settings Dialog. If there is no reveal the returned value is ‘0’.
Note: see illustration at WIDO_RIGHT_JAMB

WIDO_THRES_DEPTH

Old name: C~
Type: numerical (positive value)
Possible range: 0 to half of nominal height of Window/Door (SYMB_B_SIZE/2) (in meters)
Returns the sill/threshold depth of the Window/Door as set in the Reveal Setup Subdialog of the Window/Door Settings Dialog. If there is no reveal the returned value is ‘0’.

The field in the Reveal Setup Dialog corresponding to (from top to left) WIDO_HEAD_DEPTH and WIDO_THRES_DEPTH

WIDO_HEAD_DEPTH

Old name: D~
Type: numerical (positive value)
Possible range: 0 to half of nominal height of Window/Door (SYMB_B_SIZE/2) (in meters)
Returns the head depth of the Window/Door as set in the Reveal Setup Subdialog of the Window/Door Settings Dialog. If there is no reveal the returned value is ‘0’.
Note: see illustration at WIDO_THRES_DEPTH

WIDO_REVEAL_SIDE

Old name: E~
Type: numerical (integer value)
Possible values: 0 or 1
Returns a number corresponding to the state of the opening side of the Window/Door. It expresses the state of its position relative to the side of the reveal.
In case of a Window the Window is placed in such a way so that it ‘looks’ in the direction of its Reveal. Therefore as a default the variable returns ‘0’ and returns ‘1’ if the Window is flipped. In case of a Door the Door is placed in such a way that it extends to the direction opposite to its reveal side. Therefore the default return value for Doors is ‘1’ and ‘0’ is returned when the Door is flipped.
Note: see illustration at WIDO_REVEAL_ON

WIDO_FRAME_THICKNESS

Old name: F~
Type: numerical (positive value)
Possible range: 0 or up (in meters)
Returns the thickness of the frame of the Window/Door, as set in the Details Dialog accessible from the Library Part Editing Dialog (when the ‘Parameters’ list is active). This is the value the program uses when flipping a Window/Door. The program does the flipping by first mirroring the Window/Door around its local X-axis and then relocating it along the Y-axis with this value. With this it can be achieved that only the opening side of the Window/Door changes but not its location in the Wall. If the Library Part has no 3D part the variable will return ‘0’.

The steps executed by ArchiCAD when flipping a Window/Door: the example Door is first mirrored then relocated by WIDO_FRAME_THICKNESS

The fields in the Details Dialog accessible by clicking the ‘Details’ button in the Library Part Editing Dialog. They correspond to WIDO_FRAME_THICKNESS, WIDO_PWALL_INSET and WIDO_ORIENTATION

WIDO_POSITION

Old name: H~
Type: numerical (real value – in case of straight walls; angle value in case of curved walls)
Possible range: -([Window/Door size]/2) and up in case of straight walls; approx. -360.0000° – approx. 360.0000° in case of curved walls) (in meters)
Imagine the axis of the Window/Door. Then imagine the normal vector of its enclosing wall projecting at the starting point of the wall. This global variable returns the shortest distance along the Wall between these two parallel lines. With straight walls this is a distance value and with curved walls it is an angle value.

The values returned by WIDO_POSITION in case of various Wall shapes and Window/Door positions

Consider the above example. In case of straight walls it is self-explanatory: in most case the returned value is a positive number (if more than half of the Window/Door is outside the Wall body then it is negative). In case of curved walls the method of calculation is the following: there is a way the Window/Door is generated. You can see this by going to the Library Part Editing Dialog and viewing the 2D Full View. In our example the Door opens to the right (see below):

The default opening direction of the example Door

Since positive angles are measured counter-clockwise, if the starting point of the wall is clockwise from the centerline of the Door the returned angle value is negative and if it is counter-clockwise from the centerline of the Door the returned angle value is positive. If the Door is placed in such a way that it is mirrored around its centerline the directions for negative and positive values are swapped (because of the mirroring). In such a case, if the starting point of the wall is clockwise from the centerline of the Door the returned angle value is positive and if it is counter-clockwise from the centerline of the Door the returned angle value is negative.

Notes:

• the Window/Door can actually be placed in such a way that the whole of it is outside the body of the wall but its end is just placed at the end of the wall (see top of left straight wall of example), hence the possibility of negative values.

• If there is a space fill as part of the Window/Door (because the Window/Door polygon is not rectangular) the origin of the texture and 3D hatch of those space fill bodies are located in the starting point of the enclosing Wall.

WIDO_ORIENTATION

Type: string
Possible length: max. 31 characters
Returns a string corresponding to the orientation of the Window/Door (L – left, R – right or any other custom value). This will work fine if the Window/Door was created according to the local standards concerning orientation.
Note: see last illustration at WIDO_FRAME_THICKNESS.

WIDO_MARKER_TXT

Type: string
Possible length: max. 3 characters
Returns the marker text in a string as set in the Window/Door Dimension Settings Subdialog accessible from the Window/Door Settings Dialog

The fields in the Dimension Settings Subdialog of the Window/Door Settings Dialog corresponding to (from top to bottom) WIDO_MARKER_TXT, WIDO_SUBFL_THICKNESS, WIDO_PREFIX and WIDO_CUSTOM_MARKER

WIDO_SUBFL_THICKNESS

Type: numerical (positive value)
Possible range: 0 or up (in meters)
Returns the subfloor thickness (sill correction value) as set in the Window/Door Dimension Subdialog of the Window/Door Settings Dialog.
Note: see illustration at WIDO_MARKER_TXT

WIDO_PREFIX

Type: string
Possible length: max. 7 characters
Returns the Window/Door Dimension’s sill height prefix text in a string as set in the Window/Door Dimension Settings Subdialog of the Window/Door Settings Dialog.
Note: see illustration at WIDO_MARKER_TXT

WIDO_CUSTOM_MARKER

Type: numerical (integer value)
Possible values: 0 or 1
Returns a number corresponding to the state of the ‘Use Object’s Settings’ checkbox as set in the Window/Door Dimension Settings Subdialog of the Window/Door Settings Dialog. Returns ‘0’ when the checkbox is not checked and returns ‘1’ when it is checked (the case in which the dimensions automatically generated by ArchiCAD do not appear and custom marker and dimensioning information can be displayed for the Window/Door as written in their 2D Scripts.
Note: see illustration at WIDO_MARKER_TXT

WIDO_ORIG_DIST

Old name: R_
Type: numerical (real value) (in meters)
Returns the distance from the local origin of the Window/Door of the center point of the curved Wall into which the Window/Door was placed. Since the variable applies only to curved walls, when the Window/Door is placed into a straight wall the returned value is 0.

The values returned by WIDO_ORIG_DIST in cases of various placements of Doors.

As you can see on the above example, the direction of the plus (+) range of the Door’s local origin changes with the opening direction of the Door, which is defined at the time of its placement. Depending on this the variable returns positive or negative values as automatically generated on the example. The variable returns values with opposite signs in the Floor Plan and the 3D Window. If you look at Chapter 12.1 in the GDL manual you will see that the way a Window/Door is generated in 3D is that it is rotated 90 degrees around its own X-axis. This way a direction that was positive Y on the Floor Plan Window becomes negative Z in the 3D Window and a direction that was negative Y on the Floor Plan Window becomes positive Z in the 3D Window. So if the variable returned 1.6 meters in the Floor Plan Window it will return –1.6 meters in the 3D Window.

WIDO_PWALL_INSET

Type: numerical (real value) (in meters)
Returns the inset of the parapet wall just below the Window/Door, as set in the Details Dialog accessible from the Library Part Editing Dialog (when a Window/Door is opened for editing and the ‘Parameters’ button is activated on the list side of the Dialog).
Note: see last illustration at WIDO_FRAME_THICKNESS.

---

Lamp parameters - available for listing only

LIGHT_ON

Type: numerical (integer value)
Possible values: 0 or 1
Returns a number corresponding to the state of the Lamp Object as set in its Lamp Settings Dialog. The returned value is ‘0’ if the light is switched OFF and it is ‘1’ if the light is switched ON.

The fields in the Lamp Settings Dialog corresponding to LIGHT_ON and LIGHT_INTENSITY and the color field giving access to the settings for LIGHT_RED, LIGHT_GREEN and LIGHT_BLUE

LIGHT_RED, LIGHT_GREEN & LIGHT_BLUE

Type: numerical (positive value)
Possible range: 0 to 1.0000
This trio of variables returns the red, green and blue components of the color of the light, as set in the Light Settings Dialog accessible by double clicking on the color field in the Lamp Settings Dialog. The returned values are 1.0000 if the highest possible value was entered in the field (255 on Windows, 65535 on the Mac) and they are 0 when the lowest possible value (0 on both platforms) was entered. All other values are proportionally calculated.

The fields in the Set Light Color Dialog corresponding to LIGHT_RED, LIGHT_GREEN and LIGHT_BLUE

Example: if on Windows, ‘153’ is set in the field for the Red component then the value returned by LIGHT_RED will be 0.6000 (153/255=0.6).

LIGHT_INTENSITY

Type: numerical (integer value)
Possible range: 0 to 100
Returns a number corresponding to the intensity of the light of the Lamp Object as set in the Lamp Settings Dialog.
Note: see illustration at LIGHT_ON
The following illustration shows a result of listing all the above five Lamp Object-related global variables.

The list of Lamp-related global variables

---

Label parameters

LABEL_POSITION

Type: numerical (real value)
Possible range: any value (in meters)
Returns a array of numbers with a dimension of 3 rows by 2 columns containing {X; Y} coordinate information about the label arrow’s definition points. The index values of the array range from [1][1] to [3][2].

The 3 definition points of the Label arrow

The three coordinate pairs return the following information:

LABEL_POSITION[1][1] & LABEL_POSITION[1][2] : they return the X and Y coordinates of the beginning of the Label pointer’s leader (marked with P1 on above illustration).
LABEL_POSITION[2][1] & LABEL_POSITION[2][2] : they return the X and Y coordinates of the relative vector going from the beginning of the Label pointer’s leader (P1) to the break point of the leader (P2). The values are calculated by deducting the respective X, Y coordinates of P1 from P2.
LABEL_POSITION[3][1] & LABEL_POSITION[3][2] : they return the X and Y coordinates of the relative vector going from the break point of the Label pointer’s leader (P2) to the end (tip) of the leader (P3). The values are calculated by deducting the respective X, Y coordinates of P2 from P3.

In the above illustration, P1 is in the point {6,2}, P2 is at {1,2} and P3 is at {0,0}. From this, the array will return the following values:
LABEL_POSITION[1][1], LABEL_POSITION[1][2] : {6,2}
LABEL_POSITION[2][1], LABEL_POSITION[2][2] : {-5,0}
LABEL_POSITION[3][1], LABEL_POSITION[3][2] : {-1,-2}

LABEL_CUSTOM_ARROW

Type: numerical (positive value)
Possible values: 0 or 1
Returns a number corresponding to the state of the arrow of the Label automatically generated by ArchiCAD as set in the Label Settings Dialog. The returned value is ‘0’ when the default ArchiCAD arrow is used and it is ‘1’ when the default arrow is not drawn (custom arrow can be generated by Label script).

The checkbox in the Label Settings Dialog corresponding to LABEL_CUSTOM_ARROW

LABEL_ARROW_PEN

Type: numerical (positive integer value)
Possible range: 1 to 255
Returns the index number of the pen used for the leader of the Label’s default pointer (arrow) as set in the Label Settings Dialog.

The fields in the Label Settings Dialog corresponding to LABEL_ARROWHEAD_PEN, LABEL_ARROW_PEN and LABEL_ANCHOR_POS

LABEL_ARROWHEAD_PEN

Type: numerical (positive integer value)
Possible range: 1 to 255
Returns the index number of the pen used for the arrowhead of the Label’s default pointer (arrow) as set in the Label Settings Dialog.
Note: see illustration at LABEL_ARROW_PEN

LABEL_FONT_NAME

Type: string
Returns in a string he name of the font used for the Label’s own texts (but not texts generated by Label scripts) as set in the Label Settings Dialog.

The fields in the Label Settings Dialog corresponding to LABEL_FONT_NAME, LABEL_FONT_STYLE, LABEL_TEXT_SIZE, LABEL_TEXT_PEN and LABEL_FRAME_ON

LABEL_TEXT_SIZE

Type: numerical (positive value)
Possible range: 0.1000 mm or up
Returns the size of the Label’s own texts (but not texts generated by Label scripts) in millimeters as set in the Label Settings Dialog.
Note: see illustration at LABEL_FONT_NAME

LABEL_TEXT_PEN

Type: numerical (positive integer value)
Possible range: 1 to 255
Returns the index number of the pen used for the Label’s texts as set in the Label Settings Dialog.
Note: see illustration at LABEL_FONT_NAME

LABEL_FONT_STYLE

Type: numerical (integer value)
Possible range: 0 to 7
Returns a number corresponding to the state of the style of the Label’s own texts (but not texts generated by Label scripts) as set in the Label Settings Dialog.
The following table shows the value returned by this variable with each combination of the ‘Bold’, ‘Italic’ and ‘Underline’ checkboxes checked:

Notes:

• when none of the checkboxes is checked, the font’s style is Normal.

• see illustration at LABEL_FONT_NAME