Global GDL Parameters

General Global Variables

Written by László Nagy

GLOB_SCRIPT_TYPE

GLOB_CONTEXT

GLOB_SCALE

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.

• 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

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.

GLOB_MODPAR_NAME

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

GLOB_HSTORY_HEIGHT

GLOB_CSTORY_ELEV

GLOB_CSTORY_HEIGHT

GLOB_CH_STORY_DIST

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.

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.

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.

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.

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).

GLOB_ID

GLOB_INTID

GLOB_ELEVATION

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

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.

General element parameters - available for listing only

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

SYMB_FILL

SYMB_FILL_PEN

SYMB_FBGD_PEN

SYMB_SECT_PEN

SYMB_VIEW_PEN

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.

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.

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:

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:

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).

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.

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.

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

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.

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.

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’.

WIDO_LEFT_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’.

WIDO_HEAD_DEPTH

WIDO_REVEAL_SIDE

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

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 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

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

WIDO_SUBFL_THICKNESS

WIDO_PREFIX

WIDO_CUSTOM_MARKER

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.

WIDO_PWALL_INSET

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.

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.

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.

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].

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).

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.

LABEL_ARROWHEAD_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.

LABEL_TEXT_SIZE

LABEL_TEXT_PEN

LABEL_FONT_STYLE

LABEL_FRAME_ON

LABEL_ANCHOR_POS

Wall parameters - available for Doors/Windows

WALL_RESOL

WALL_THICKNESS

Old name: C_
Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the thickness of the Wall into which the Window/Door is placed.

The fields in the Wall Settings Dialog corresponding to WALL_LINETYPE, WALL_SECT_PEN, WALL_FILL/WALL_COMPS_NAME, WALL_FILL_PEN, WALL_FBGD_PEN, WALL_HEIGHT, WALL_POSITION[3] and WALL_THICKNESS

In case of inclined walls the variable returns the thickness of the wall at the centerline of the Window/Door measured perpendicularly to the reference line of the wall as shown in the below example.

WALL_THICKNESS = 35 cm

WALL_INCL

WALL_INCL = -5.71059°

WALL_HEIGHT

WALL_MAT_A

Old name: G_
Type: numerical (integer value)
Possible range: 0 and up
Returns the index number of the material assigned to the reference side of the Wall into which the Window/Door is placed.

WALL_MAT_B

WALL_MAT_EDGE

WALL_LINETYPE

WALL_FILL

WALL_FILL_PEN

WALL_COMPS_NAME

WALL_SKINS_NUMBER

WALL_SKINS_PARAMS

• the row indexes start from bottom to top of the structure defined in the Composite Structures Dialog so the skin at the bottom will be returned in WALL_SKINS_PARAMS[1][x], the next up in WALL_SKINS_PARAMS[2][x] and so on.

• there are two checkboxes in the Wall Settings Dialog that can define whether the composite uses its own defined outline/fill/background pens or the ones defined in the Wall Settings Dialog. So the state of these checkboxes will influence some of the values returned by the WALL_SKINS_PARAMS array.

The two checkboxes in the Wall Settings Dialog influencing the values returned by WALL_SKINS_PARAMS[3][x], WALL_SKINS_PARAMS[4][x] and WALL_SKINS_PARAMS[5][x]

The example above returns the below values:

WALL_SECT_PEN

WALL_VIEW _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 visible edges (not cut surfaces) of the Wall into which the Window/Door is placed as set in the Wall Settings Dialog. This pen is used to draw all edges of the Wall in the 3D Window and all visible edges (not the edges of cut bodies) in Section/Elevation Windows.

WALL_FBGD_PEN

WALL_DIRECTION

Type: numerical (angle value)
Possible range: 0° – 359.9999°
Returns the angle along which the Wall into which the Window/Door is placed lies. The variable basically returns the angle of the reference line of the Wall relative to horizontal.

The value of WALL_DIRECTION in case of different Wall placements

In the case when the Window/Door is placed into a curved Wall the returned value gives the angle of the arc chord connecting the two ends of the width of the Window/Door relative to horizontal.

WALL_POSITION

Wall parameters - available for listing only

WALL_LENGTH_A

WALL_LENGTH_B

WALL_SURFACE_A

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the surface area of the Wall on the side of its reference line. This includes the appropriate surfaces of Window/Door reveals as well. To get WALL_SURFACE_A the surface area of any Window/Door opening or hole is deducted from the whole surface area if its area is larger than the limit defined in the List Setup Schemes Dialog.

WALL_SURFACE_B

WALL_EDGE_SURF

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface area of all edges in a Wall. Every side in a Wall body that is not WALL_SURFACE_A and WALL_SURFACE_B counts under WALL_EDGE_SURF. This includes all outside edges (top, bottom and side) of Wall and all edges of Window/Door openings (this includes the appropriate surfaces of Window/Door reveals as well) and holes within the Wall (as in the case of WALL_SURFACE_A an opening/hole counts as one if it is larger than the defined limit). The surface area of reveals also count under this variable. This means that if a hole e.g. is smaller than the limit, it counts as if it was part of the wall’s body in which case it doesn’t count as a hole and so it doesn’t count as to have edges either which would contribute to WALL_EDGE_SURF.

WALL_VOLUME

WALL_DOORS_NR

WALL_WINDS_NR

WALL_HOLES_NR

WALL_DOORS_SURF

WALL_WINDS_SURF

WALL_HOLES_SURF

WALL_DOORS_WID

WALL_WINDS_WID

WALL_COLUMNS_NR

Type: numerical (integer value)
Possible range: 0 and up
Returns the total number of columns placed in the Wall.


Example:

The 15 Wall Global variables

In the above illustration we have the following dimensions and values:
Wall: 7.50 m long, 3.60 m high and 0.45 m thick
Doors: two 90/270 Doors 30 cm apart
Windows: two 90/150 Windows with a 120-cm parapet, 30 cm apart
Holes: two 60/60 holes at 120 cm and 210 cm parapet heights
Columns: two 30/30 columns between two Door and two Window, 15 cm deep in Wall.
In the List Setup Schemes Dialog the hole limit is set to 0.10 square meters (so all opening/holes will be deducted from Wall surfaces/volume).
With these data the above 15 Global Variables return the following values:

The values returned by the Wall global variables in the above example.

As you can see, WALL_SURFACE_B is less than WALL_SURFACE_A because the two columns on the side opposite to the reference line side reduce the surface area. All holes are deducted from the Wall volume, hence the value of WALL_VOLUME. WALL_EDGE_SURF is quite large because of the large areas created by openings/ holes and column cut-ins. Other values are quite self-explanatory.
Just as a comparison here are the results when the hole size limit is set to 1.50 square meters (in this case Windows and holes will not count in width, surface and volume variables).

Column parameters - available for listing only

COLU_CORE

COLU_HEIGHT

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the height of the Column as set in the Column Settings Dialog.

COLU_VENEER_WIDTH

COLU_MAT

Type: numerical (integer value)
Possible range: 0 and up
Returns the index number of the material assigned to the sides of the Column as set in the Column Settings Dialog.

COLU_LINETYPE

COLU_CORE_FILL

COLU_VENEER_FILL

COLU_SECT_PEN

COLU_VIEW_PEN

COLU_CORE_FILL_PEN

COLU_CORE_FBGD_PEN

COLU_VENEER_FILL_PEN

COLU_VENEER_FBGD_PEN

COLU_CORE_SURF

COLU_CORE_VOL

COLU_VENEER_SURF

COLU_VENEER_VOL

Type: numerical (positive value)
Possible range: 0 and up (in cubic meters)
Returns the volume of the veneer of the Column (the volume of the whole Column [core and veneer] minus the volume of the core).

Example:
In case of the example shown in illustrations at COLU_HEIGHT and COLU_MAT the returned values are the following when listed.

The values returned by the Column variables in case of a 30/30 rectangular Column with 10-cm veneer

Beam parameters - available for listing only

BEAM_THICKNESS

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the thickness (or width) of the Beam as set in the Beam Settings Dialog.

BEAM_HEIGHT

BEAM_REFLINE_OFFSET

BEAM_PRIORITY

Type: numerical (positive integer value)
Possible range: 1, 3, 5, 7, 9, 11, 13 and15
Returns an odd integer showing the priority index number assigned to the Beam as set in the Beam Settings Dialog. The program decides based on this number which construction element has priority in display in 3D in case of Wall/Column and Beam intersections.

BEAM_MAT_RIGHT

BEAM_MAT_LEFT

BEAM_MAT_TOP

BEAM_MAT_BOTTOM

BEAM_MAT_END

BEAM_OUTLINE_LINETYPE

BEAM_AXES_LINETYPE

BEAM_FILL

BEAM_FILL_PEN

BEAM_SECT_PEN

BEAM_FBGD_PEN

BEAM_DIRECTION

Type: numerical (angle value)
Possible range: 0° – 359.9999°
Returns the direction of the angle of the reference line of the Beam relative to the horizontal direction.

BEAM_POSITION

Type: numerical (real value)
Possible range: any value (in meters)
Returns the starting point coordinates of the reference line of the Beam. The variable is a two-member array (BEAM_POSITION[1] and BEAM_POSITION[2]). They return the x and y coordinates of the starting point of the reference line of the Beam relative to the Project’s Global Origin, respectively. Since the reference line can be anywhere you may encounter a case where the Beam is actually quite far from the points returned by this pair of variables.

BEAM_LENGTH_RIGHT

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the length of the Beam on the right side of the reference line. This is the side that is on the right of the Beam when looking in the direction of the Beam’s reference line.

BEAM_LENGTH_LEFT

BEAM_RIGHT_SURF

BEAM_LEFT_SURF

BEAM_TOP_SURF

BEAM_BOTTOM_SURF

BEAM_END_SURF

BEAM_VOLUME

BEAM_HOLES_NR

Type: numerical (integer value)
Possible range: 0 and up
Returns the total number of holes placed into the Beam.

BEAM_HOLES_SURF

BEAM_HOLE_EDGE_SURF

BEAM_HOLES_VOLUME

Type: numerical (positive value)
Possible range: 0 and up (in cubic meters)
Returns the total volume of all of the holes placed into the Beam.
Note: see illustration at BEAM_HOLES_NR

Slab parameters - available for listing only

SLAB_THICKNESS

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the thickness of the Slab as set in the Slab Settings Dialog.

SLAB_MAT_TOP

Type: numerical (integer value)
Possible range: 0 and up
Returns the index number of the material assigned to the top side of the Slab as set in the Slab Settings Dialog.

SLAB_MAT_EDGE

SLAB_MAT_BOTT

SLAB_LINETYPE

SLAB_FILL

SLAB_FILL_PEN

SLAB_FBGD_PEN

SLAB_COMPS_NAME

SLAB_SKINS_NUMBER

SLAB_SKINS_PARAMS