GDL Center

https://gdl.graphisoft.com
Admin
GDL Center is a knowledge base website that aggregates GDL knowledge and builds a community for...
Tokens:832,311
Snippets:4,354
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### Forward Migration Script Example

Source: https://gdl.graphisoft.com/index_p=874

This script provides an example of a forward migration script for compatibility. It demonstrates migrating an element by updating its GUID and parameters using commands like SETMIGRATIONGUID.

```script
actualGUID = FROM_GUID

! ==============================================================================
! Subroutines
! ==============================================================================

    _startID    = "AAAA-AAAA-...AAA"
    _endID      = "BBBB-BBBB-...BBB"
gosub "migrationstepname_FWM"

! ==============================================================================
! Set Migration GUID
! ==============================================================================

setmigrationguid actualGUID

! ==============================================================================
end ! end ! end ! end ! end ! end ! end ! end ! end ! end ! end ! end ! end ! en
! ==============================================================================

! ==============================================================================
! migrationstepname
! ==============================================================================
"migrationstepname_FWM":
    if actualGuid = _startID then
        newParameter = oldParameter
        parameters newParameter = newParameter
        actualGuid = _endID
    endif
return
```

--------------------------------

### GDL Parameter Script Examples

Source: https://gdl.graphisoft.com/index_p=872

Illustrates the usage of the VALUES command for creating simple value lists with direct values, custom inputs, and ranges. Also shows an advanced example of reading string values from a file to populate a parameter's pop-up menu.

```GDL
VALUES "par1" 1, 2, 3
VALUES "par2" "a", "b"
VALUES "par3" 1, CUSTOM, SIN (30)
VALUES "par4" 4, RANGE(5, 10], 12, RANGE(,20] STEP 14.5, 0.5, CUSTOM
```

```GDL
DIM sarray[]
! file in the library, containing parameter data
filename = "ProjectNotes.txt"
ch1 = OPEN ("text", filename, "MODE=RO, LIBRARY")
i = 1
j = 1
sarray[1] = ""
! collect all strings
DO
    n = INPUT (ch1, i, 1, var)
    IF n > 0 AND VARTYPE (var) = 2 THEN
        sarray[j] = var
        j = j + 1
    ENDIF
    i = i + 1
WHILE n > 0
CLOSE ch1
! parameter popup with strings read from the file
VALUES "RefNote" sarray
```

--------------------------------

### GDL Example with Transformations and Shapes

Source: https://gdl.graphisoft.com/reference-guide/scripting

This example demonstrates the use of PRISM, ADDZ, and MUL commands to create repeated, transformed shapes.

```GDL
PRISM 4, 1, 3, 0,
        3,  3,
        -3, 3,
        -3, 0
ADDZ -1
MUL 0.666667, 0.666667, 1
PRISM 4, 1, 3, 0,
        3,  3,
        -3, 3,
        -3, 0
ADDZ -1
MUL 0.666667, 0.666667, 1
PRISM 4, 1, 3, 0,
        3,  3,
        -3, 3,
        -3, 0
```

--------------------------------

### GDL Backward Migration Script Example

Source: https://gdl.graphisoft.com/reference-guide/the-backward-migration-script

This script demonstrates the structure and commands used in the GDL Backward Migration process. It includes setting the target GUID, calling migration subroutines, and defining parameter conversions. The script requires the GDL (Graphisoft Description Language) environment to run.

```GDL
targetGUID = TO_GUID

! ==============================================================================
! Subroutines
! ==============================================================================

gosub "migrationstepname_BWM"

! ==============================================================================
! Set Migration GUID
! ==============================================================================

setmigrationguid targetGUID

! ==============================================================================
end ! end ! end ! end ! end ! end ! end ! end ! end ! end ! end ! end ! end ! en
! ==============================================================================


! ==============================================================================
! migrationstepname
! ==============================================================================
"migrationstepname _BWM":
    if targetGUID # "" then
        bMigrationSuccess = 1
        if bMigrationSuccess = 1 then
            oldParameter = newParameter
            parameters oldParameter = oldParameter
        else
            targetGuid = ""
        endif
    endif
return
																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																															"NEWPARAMETER" "name", "type" [, dim1 [, dim2]]

Adds a new parameter to the parameters of a library part in the Backward Migration Script.
The parameter creation happens only after the full interpretation of the script.
If a parameter with the given name already exists in the parameters list, an error occurs.
`**name: **`string expression, name of the parameter to be created.
`**type: **`string expression, type of the parameter. Possible values are:
`Integer`
`Length`
`Angle`
`RealNum`
`LightSwitch`
`ColorRGB`
`Intensity`
`LineType`
`Material`
`FillPattern`
`PenColor`
`String`
`Boolean`
`BuildingMaterial` _(**Compatibility** : introduced in ARCHICAD 22.)_
`Profile` _(**Compatibility** : introduced in ARCHICAD 22.)_
`**dim1, dim2: **`  
dim1 is the first dimension of the parameter, 0 if not set. dim2 is the second dimension of the parameter, 0 if not set.
`dim1 = 0, dim2 = 0: `the parameter is a scalar parameter,
`dim1 > 0, dim2 = 0: `the parameter is a 1 dimensional array,
`dim1 > 0, dim2 > 0: `the parameter is a 2 dimensional array,

```

--------------------------------

### GDL Function and Utility Commands

Source: https://gdl.graphisoft.com/reference-guide/index

Includes utility functions for mathematical operations and addon scope initialization. 'FRA' evaluates a fraction, 'GET' retrieves a value, and 'INITADDONSCOPE' sets up addon parameters.

```GDL
**GET** (n)
```

```GDL
**FRA** (x)
```

```GDL
**INITADDONSCOPE** (extension, parameter_string1, parameter_string2)
```

```GDL
**INT** (x)
```

--------------------------------

### Compact Style Application with Gosub

Source: https://gdl.graphisoft.com/gdl-style-guide/general

When calling a subroutine with multiple flag-like parameters, compact code can be achieved by using additions to style variables.  This example uses `gosub` and style variables for more concise code.

```GDL
stText = "line1"
gosub "TypeText" _iStyle = 1 + 4 ! bold underline
_stText = "line2"
gosub "TypeText" _iStyle = 2     ! italic
```

--------------------------------

### Get Volume in GDL Property Script

Source: https://gdl.graphisoft.com/reference-guide/request-options/%22

This example shows how to obtain the volume of an element's skin in a property script. Like the projected area example, this REQUEST call only works in property scripts and returns 0 with dummy values in parameter scripts. The code requests the volume of the basic element (idxSkin=0) and displays it in a COMPONENT statement.

```GDL
n = REQUEST ("COMPONENT_VOLUME", 0, v)
COMPONENT "Volume", v, "m3"
```

--------------------------------

### Get Parent Object Properties (GDL)

Source: https://gdl.graphisoft.com/reference-guide/request-options/%22

Fetches properties of the parent object based on the specified property type. Properties are returned in a flat array. This function is exclusively for labels and may produce warnings if used in parameter scripts. Compatibility starts from ARCHICAD 20.

```GDL
DIM parentProperties[]
n = REQUEST ("Properties_Of_Parent", "", parentProperties)
! parentProperties =   [Id1, TypeName1, GroupName1, PropertyName1,
Id2, TypeName2, GroupName2, PropertyName2,
...
Idn, TypeNamen, GroupNamen, PropertyNamen]
```

--------------------------------

### GDL: Initialize variables and output values using text2

Source: https://gdl.graphisoft.com/forums/users/dbobaly/replies/page/3

This snippet demonstrates how to initialize return variables in GDL to avoid warnings. It also shows how to use the `text2` command for outputting values, which is recommended for debugging over the `print` command.

```gdl
p_values= ""
n = REQUEST ("ASSOCLP_PARVALUE", "gs_list_manufacturer", _dummy1, _dummy2, _dummy3, _dummy4, _dummy5, p_values)

text2 0, 0, p_values
```

--------------------------------

### Process and Split Profile Geometry Data in GDL

Source: https://gdl.graphisoft.com/gdl_other_docs/get-the-basic-properties-and-geometry

A GDL script example demonstrating how to retrieve profile component types and their raw geometry data. It then calculates start and end indices to split the raw data into individual components, considering display settings. This is recommended for use in the Master Script.

```GDL
COMPTYPE_CORE = 0
COMPTYPE_FINISH = 1
COMPTYPE_OTHER = 2


if GLOB_SCRIPT_TYPE = 2 or GLOB_SCRIPT_TYPE = 3 then

	! --- Get the number of components and their types ---
	_nComponents = 0
	dim _componentTypes[]

	n = REQUEST ("Profile_components", myProfileIdx, _nComponents, _componentTypes)

	if n then
		dim _bShowPart[]
		_needRequestDetails = 0

		! --- Check the current partial structure display settings and the component types ---
		! ---- is there any part to be drawn by the script?
		! ---- GLOB_STRUCTURE_DISPLAY: 0 – entire structure, 1 – core only, 2 – without finishes
		for _i = 1 to _nComponents
			_bShowPart[_i] = 1
			if GLOB_STRUCTURE_DISPLAY = 1 AND _componentTypes[_i] <> COMPTYPE_CORE then _bShowPart[_i] = 0
			if GLOB_STRUCTURE_DISPLAY = 2 AND _componentTypes[_i] = COMPTYPE_FINISH then _bShowPart[_i] = 0
			if _bShowPart[_i] then _needRequestDetails = 1
		next _i

		if _needRequestDetails then

			! --- Get the profile components geometry ---
		dim _profileGeometryRawData[]
		n = REQUEST ("Profile_default_geometry", myProfileIdx, _profileGeometryRawData)

			! --- calculate indices to split up the original data into components ---
		dim _idxStartPoints[]
		dim _idxEndPoints[]
		_idxStartPoints[1] = _nComponents + 1
		_numPropertybyNodes = 5
		for _i = 2 to _nComponents
			_numCompNodes = _profileGeometryRawData[_i - 1]
			_idxStartPoints[_i] = _idxStartPoints[_i - 1] + _numCompNodes * _numPropertybyNodes
			_idxEndPoints[_i-1] = _idxStartPoints[_i] - 1
		next _i
		_idxEndPoints[_nComponents] = vardim1(_profileGeometryRawData)
		endif
	endif

endif

```

--------------------------------

### OUTPUT Command Usage Examples in GDL

Source: https://gdl.graphisoft.com/reference-guide/gdl-text-io-add-on

Practical examples of the OUTPUT command showing different usage patterns. Demonstrates writing string values followed by new rows and numeric values with separator characters without new rows. Shows interaction with file opening modes and separator definitions.

```GDL
string = "Date: 19.01.1996"
a = 1.5
OUTPUT ch2, 1, 0, string ! string followed by a new row
OUTPUT ch2, 0, 0, a, a + 1, a + 2! separator character after a + 2 ! without new row
```

--------------------------------

### Get Projected Area in GDL Property Script

Source: https://gdl.graphisoft.com/reference-guide/request-options/%22

This example demonstrates how to retrieve the projected area of an element's skin in a property script using REQUEST. The function returns 0 and dummy values when used in parameter scripts, causing warnings. The code requests the projected area of the basic element (idxSkin=0) and uses the result in a COMPONENT statement.

```GDL
n = REQUEST ("COMPONENT_PROJECTED_AREA", 0, a)
COMPONENT "Projected Area", a, "m2"
```

--------------------------------

### Call Light Configuration Macro

Source: https://gdl.graphisoft.com/tips-and-tricks/how-to-make-a-light-object

Demonstrates the usage of a light configuration macro with various parameters including light switch, color components, intensity, shadow settings, and photometric properties.

```GDL
call "lightMacro_m" parameters gs_light_switch = gs_light_switch,
	gs_color_red = gs_color_red,
	gs_color_green = gs_color_green,
	gs_color_blue = gs_color_blue,
	gs_light_intensity = gs_light_intensity,
	iLightGroupType = LIGHTGROUP_BUILTIN_NONVIS_AREA,
	iC4dDetAreaShape = AREASHAPE_RECT,
	c4dDetAreaX = 1,
	c4dDetAreaY = 0.3,
	c4dDetAreaZ = 0.05,
	bGenShadow = 1,
	iShadowQuality = 5,
	iShadowQualityGroupType = 3,
	bDetShowFalloff = 1,
	c4dDetRadius = 1.5,
	c4dDetFalloffAngle = 120,
	c4dPhoPhotometric = 0,
	iC4dPhoUnit = PHOTOUNIT_LUMEN,
	photoIntensityLumen = 12000,
	photoIntensityCandela = 1000,
	lightUnID = 100
```

--------------------------------

### Create a Parameterized Drawing in GDL

Source: https://gdl.graphisoft.com/reference-guide/index

Starts a drawing block that evaluates a single expression to define its content. Useful for generating simple geometry based on a computed value. The expression is evaluated at the start of the block.

```GDL
**DRAWING2** [expression]
```

--------------------------------

### UI Separator Definition

Source: https://gdl.graphisoft.com/reference-guide/index

Defines a separator line using start and end coordinates.

```GDL
UI_SEPARATOR x1, y1, x2, y2

```

--------------------------------

### GDL Macro Call Syntax Example

Source: https://gdl.graphisoft.com/gdl-style-guide/macro-calls

Demonstrates the standard syntax for calling a GDL macro, including parameter passing and returned parameters. Adheres to style guidelines by placing each parameter on a new line.

```GDL
call "DetlevelDWFunctionMacro" parameters   bWindow         = 1,
                                            MVODetlevel2D   = MVODetlevelWindow.detlevel2D,
                      returned_parameters   _windowDetlevel2D,
                                            _unused         ! windowDetlevel3D
                                            _unused         ! windowDetlevel4D
```

--------------------------------

### GDL: Projecting 2D Geometry with Fills and Pens

Source: https://gdl.graphisoft.com/forums/users/jsuhlo/replies/page/2

Illustrates the use of the PROJECT2 command to create 2D representations of objects, including specifying foreground and background pens, fill types, and positioning. This is fundamental for defining how objects appear in floor plans.

```GDL
PEN foregroundPen  
FILL myFill 
PROJECT2{2} 3, 270, 3+32,  
backgroundPen, xOrigo, yOrigo, fillDirect
```

--------------------------------

### GDL LIGHT Element Example 1: Basic Configuration

Source: https://gdl.graphisoft.com/reference-guide/elements-for-visualization

A practical example demonstrating the basic configuration of a LIGHT element in GDL, specifying RGB color, shadow casting, radius, angles, distances, and falloff parameters. This code is directly usable in GDL scripts.

```GDL
LIGHT 1.0,0.2,0.3,   ! RGB
        1,             ! shadow on
        1.0,           ! radius
        45.0, 60.0,    ! angle1, angle2
        0.3,           ! angle_falloff
        1.0, 10.0,     ! distance1, distance2
        0.2            ! distance_falloff

```

--------------------------------

### Get Keynote Folder Tree in GDL UI Script

Source: https://gdl.graphisoft.com/reference-guide/request-options/%22

This example demonstrates retrieving the keynote folder tree structure for use in a UI script of Keynote Legends. The function uses the KEYNOTE_FOLDER_TREE keyword and requires an input dictionary for parameters and an output dictionary for results. The code includes the dictionary declarations, REQUEST call, and UI popup field population. The function returns 0 and empty dictionary when used outside UI scripts, with a warning.

```GDL
DICT keynoteFolderTreeInput, keynoteFolderTreeOutput
n = REQUEST ("KEYNOTE_FOLDER_TREE", keynoteFolderTreeInput, keynoteFolderTreeOutput)
if n > 0 then
    ui_custom_popup_infield "stParameterName", 10, 20, 300, 19,
        1, keynoteFolderTreeOutput.treeDepth, 1, "SelectedValueDescription",
        keynoteFolderTreeOutput.keynoteFolderTree
```

--------------------------------

### POLYROOF{3} Example Usage

Source: https://gdl.graphisoft.com/reference-guide/shapes-generated-from-polylines

Provides two example usages of the POLYROOF{3} command, demonstrating how to define roof geometry, materials, and apply different mask values for controlling roof behavior.

```gdl
pen 1
mat = IND (MATERIAL, "Metal-Aluminium")
a = -0.4242640691048 : b =  4.424264068326
c =  6.424264068326
POLYROOF{3} mat,1, 2,  5,  5,
  0, 0.3, 0.3,  1, 0, 1,
  a, b, 0, 45, 0, mat, mat, 90, 0, mat, mat,
  a, a, 0, 45, 0, mat, mat, 90, 0, mat, mat,
  c, a, 0, 45, 0, mat, mat, 90, 0, mat, mat,
  c, b, 0, 45, 0, mat, mat, 90, 0, mat, mat,
  a, b, -1,45, 0, mat, mat, 90,  0, mat, mat,
  -0.8, -0.8,  0,  2,  0, mat,
  6.8, -0.8,  0,  2,  0, mat,
  6.8,  4.8,  0,  2,  0, mat,
  -0.8,  4.8,  0,  2,  0, mat,
  -0.8, -0.8, -1,  2,  0, mat

a = 0.1514718617904 : b = 3.848528136652
c = 5.848528136652 : q = 0.5757359305057
w = 5.424264067936 :  e = 3.424264056692
POLYROOF{3} mat,1, 1,  5,  5,
  0,   0.3,  0.3,  1, 0.5757359312847,
  a, b, 0, 45,  0, mat, mat,
  a, a, 0, 45,  0, mat, mat,
  c, a, 0, 45,  0, mat, mat,
  c, b, 0, 45,  0, mat, mat,
  a, b, -1, 45,  0, mat, mat,
  q, q,   0,  0,  0, mat,
  w, q,   0,  0,  0, mat,
  w, e,   0,  0,  0, mat,
  q, e,   0,  0,  0, mat,
  q, q,  -1,  0,  0, mat
```

--------------------------------

### Get Transformation Count (NTR)

Source: https://gdl.graphisoft.com/index_p=844

Returns the current number of transformations that have been issued in the script. This is useful for dynamic manipulation of the transformation stack, such as in the DEL command examples.

```NTR
**NTR** ()

```

--------------------------------

### GDL Command Syntax Example

Source: https://gdl.graphisoft.com/gdl-basics/gdl-specific-programming-concepts

Demonstrates the basic syntax of a GDL command, showing a predefined geometric form command with its parameters. GDL commands have a fixed keyword followed by comma-separated input parameters.

```gdl
CIRCLE2 coorX, coorY, radius
! command inputParam1, inputParam2, inputParam3
```

--------------------------------

### COOR Command Complete Example (GDL)

Source: https://gdl.graphisoft.com/index_p=851

Complete GDL example demonstrating the deprecated COOR command usage within a 3D object definition. Shows VERT definition for coordinate axes, CSLAB_ for material assignment, and COOR for texture mapping setup with box wrapping mode. The negative VERT indices indicate they are used only for coordinate system definition.

```GDL
CSLAB_ "Brick-White", "Brick-White", "Brick-White",
        4, 0.5,
        0, 0, 0, 15,
        1, 0, 0, 15,
        1, 1, 1, 15,
        0, 1, 1, 15
BASE
VERT 1, 0, 0 !#1
VERT 1, 1, 1 !#2
VERT 0, 0, 0 !#3
VERT 1, 0, 1 !#4
COOR 2, -1, -2, -3, -4
BODY 1
```

--------------------------------

### Get Internal ID (Deprecated) - ARCHICAD API

Source: https://gdl.graphisoft.com/reference-guide/request-options/%22

Always returns 1. Deprecated in favor of GLOB_INTGUID. Included for backward compatibility only.

```ARCHICAD API
n = REQUEST ("Internal_ID", "", id)
```

--------------------------------

### GDL Backward Migration Script Example

Source: https://gdl.graphisoft.com/index_p=875

This script demonstrates the structure and basic commands used in the GDL Backward Migration script. It shows how to set the target GUID for migration and define migration steps. The script uses GDL's procedural syntax with subroutines and conditional logic.

```GDL
targetGUID = TO_GUID

! ==============================================================================
! Subroutines
! ==============================================================================

gosub "migrationstepname_BWM"

! ==============================================================================
! Set Migration GUID
! ==============================================================================

setmigrationguid targetGUID

! ==============================================================================
end ! end ! end ! end ! end ! end ! end ! end ! end ! end ! end ! end ! end ! en
! ==============================================================================


! ==============================================================================
! migrationstepname
! ==============================================================================
"migrationstepname _BWM":
    if targetGUID # "" then
        bMigrationSuccess = 1
        if bMigrationSuccess = 1 then
            oldParameter = newParameter
            parameters oldParameter = oldParameter
        else
            targetGuid = ""
        endif
    endif
return
																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																					
```

--------------------------------

### Get Area Dimension Format

Source: https://gdl.graphisoft.com/reference-guide/request-options/%22

Returns a format string for area dimensions that can be used with the STR() function. Format is set in Options/Project Preferences/Dimensions.

```GDL
n = REQUEST ("Area_dimension", "", format_string)
```

--------------------------------

### Example: Full DateTime Workflow in GDL

Source: https://gdl.graphisoft.com/reference-guide/gdl-datetime-add-on

Demonstrates a complete process to retrieve and print formatted date/time using OPEN, INPUT, and CLOSE. Initializes an empty string, opens channel with custom format (%w/%m/%d/%Y, %H:%M%P), reads the data, closes channel, and prints the result. Assumes system time is available and formats accordingly.

```gdl
dstr = ""
ch = OPEN ("DateTime", "", "%w/%m/%d/%Y, %H:%M%P")
n = INPUT (ch, "", "", dstr)
CLOSE (ch)
PRINT dstr !it prints 3/03/27/1996, 14:36 PM
```

--------------------------------

### Get Home Story Info

Source: https://gdl.graphisoft.com/reference-guide/request-options/%22

Returns the index and name of the home story in the specified variables. Causes warning if used in parameter script.

```GDL
n = REQUEST ("Home_story", "", index, story_name)
```

--------------------------------

### Define GDL Parameter with Integer Values and Text Descriptions Example

Source: https://gdl.graphisoft.com/gdl-basics/parameter-logic

An example demonstrating the use of the values{2} command to set up a parameter 'chairType' with integer values (1 and 2) corresponding to descriptive strings ('Designer' and 'Office').

```GDL
values{2} "chairType" 1, `Designer`,
	2, `Office`
```

--------------------------------

### GDL Text Rotation and Styling

Source: https://gdl.graphisoft.com/forums/topic/less-complex-examples/page/3

This GDL script demonstrates text rotation and styling in Graphisoft. It includes parameters for text rotation types and defines a text style. The script handles rotation based on user input and displays multiple text lines with proper styling.

```GDL
! Input parameters controlled by the user:
! ZZYZX – (Length) height of the block whose data are displayed
! iTypeTextRotation – (Integer) type of the text rotation:
! 0 – Align with Symbol, 1 – Always Horizontal,
! 2 – Readable

! Draw the block in 2D
rect2 0, 0, A, B

! Define styles
define style "Style1" "Arial", 2.5, 1, 0
rrr=request("Height_of_Style","Style1",theight1)

! Text Rotation – Readable / Always Horizontal / Align with Symbol
r = request ("View_Rotangle", "", _angleViewRot)
! Actual rotation of the 2D symbol:
_totalRotate = (SYMB_ROTANGLE + _angleViewRot) MOD 360

! Count the number of transformations of the
! coordinate system in different cases
_nTrans = 0
if iTypeTextRotation = 2 then ! Readable
if (_totalRotate > (90 + EPS) & _totalRotate < (270 + EPS)) then
rot2 180
_nTrans = _nTrans + 1
endif
else
if iTypeTextRotation = 1 then ! Horizontal
rot2 _totalRotate * (SYMB_MIRRORED – not(SYMB_MIRRORED))
_nTrans = _nTrans + 1
endif
endif

! Set input data for the text drawing
! Set the multiplier of the paper scale
PAPER_TO_MODEL = GLOB_SCALE / 1000
! Set text coordinate variable:
! samplesize is given in Paper Size – mm, convert it into Model size – m
! calculate the row height from it,
! therefore the row height will not depend on the font family
dy = – theight1 * 1.5 * PAPER_TO_MODEL

! Display the texts
style "Style1" ! Set the previously defined style
text2 0, 0, "Text 1"
text2 0, dy, "Text 2"
text2 0, dy * 2, "Text 3"
text2 0, dy * 3, "Text 4"

! Delete transformation after Text Rotation
del _nTrans
```

--------------------------------

### Get 3D Shape Volume (VOLUME3D)

Source: https://gdl.graphisoft.com/index_p=871

The VOLUME3D function calculates the volume of the 3D shape of a library part. It sums volumes if multiple shapes occupy the same location.

```gdl
**VOLUME3D** ()
```

--------------------------------

### BEAM Command Implementation Example

Source: https://gdl.graphisoft.com/index_p=846

Practical example of BEAM command implementation creating a beam structure with uniform material assignments. Demonstrates coordinate definition, height setting, and mask configuration for a simple architectural beam element.

```gdl
BEAM 1, 1, 1, 1, 1,
        0.3,
        0.0, 7.0, 7.0, 0.0,
        0.0, 0.0, 0.1, 0.1, 0.5,
        15, 15, 15, 15
```

--------------------------------

### Avoid Bittest/Bitset - Use Arrays Instead

Source: https://gdl.graphisoft.com/gdl-style-guide/general

Using bittest/bitset for parameter manipulation can be difficult to read. This example shows how to achieve the same functionality using arrays for improved readability and maintainability.

```GDL
dim bTypeEnabled[]
if ... then bTypeEnabled[2] = 1
```

```GDL
if ... then iTypeEnabled = bitset(iTypeEnabled, 2, 1)
```

--------------------------------

### GDL Script: Hotspot Alignment Example

Source: https://gdl.graphisoft.com/gdl-style-guide/script-structure

Demonstrates the use of tabs for aligning expressions and spaces for aligning coordinates in GDL scripts. This improves visual clarity for related numerical values.

```GDL
hotspot2 -overhang,  0,     unID, width, 1 + 128 : unID = unID + 1
hotspot2 -overhang, -width, unID, width, 2       : unID = unID + 1
hotspot2 -overhang,  1,     unID, width, 3       : unID = unID + 1
```

--------------------------------

### Invoke lightMacro_m with spot light parameters

Source: https://gdl.graphisoft.com/tips-and-tricks/how-to-make-a-light-object

This snippet calls the lightMacro_m macro to set up a spot light with custom cone angles, shadow quality, and photometric intensity. It requires predefined variables such as gs_light_switch and color components, and uses constants for light group and photometric units. The call configures both geometric and illumination attributes for the light.

```Script
call "lightMacro_m" parameters gs_light_switch = gs_light_switch,
                                   gs_color_red = gs_color_red,
                                   gs_color_green = gs_color_green,
                                   gs_color_blue = gs_color_blue,
                                   gs_light_intensity = gs_light_intensity,
                                   iLightGroupType = LIGHTGROUP_BUILTIN_SPOT,
                                   c4dDetUseInner = 1,
                                   c4dDetInnerAngle = 40,
                                   innerConeAngleHalf = 20,
                                   c4dDetOuterAngle = 60,
                                   outerConeAngleHalf = 30,
                                   outerConeRadius = 1.8,
                                   iC4dDetAreaShape = AREASHAPE_SPHERE,
                                   c4dDetAreaX = 0.03,
                                   c4dDetAreaY = 0.03,
                                   c4dDetAreaZ = 0.03,
                                   bGenShadow = 1,
                                   iShadowQuality = 5,
                                   iShadowQualityGroupType = 2,
                                   bDetShowFalloff = 1,
                                   c4dDetRadius = 1.5,
                                   iC4dGenVisibility = VISLIGHT_VOLUMETRIC,
                                   c4dVisBrightness = 100,
                                   c4dPhoPhotometric = 0,
                                   iC4dPhoUnit = PHOTOUNIT_LUMEN,
                                   photoIntensityLumen = 12000,
                                   photoIntensityCandela = 1000,
                                   bShowIllumination3D = 1,
                                   iFalloffType = FALLOFFTYPE_SPOT,
                                   penIllumination = 10,
                                   iModelType = MODEL_WIREFRAME,
```

--------------------------------

### Get Window Door Dimension Format

Source: https://gdl.graphisoft.com/reference-guide/request-options/%22

Returns a format string for window/door dimensions that can be used with the STR() function. Format is set in Options/Project Preferences/Dimensions.

```GDL
n = REQUEST ("Window_door_dimension", "", format_string)
```

--------------------------------

### Get Project Name

Source: https://gdl.graphisoft.com/reference-guide/request-options/%22

Returns the name of the current project in the specified variable. Expression returns 0 with dummy values when used in parameter script.

```GDL
n = REQUEST ("Name_of_plan", "", name)
```

--------------------------------

### GDL XFORM Transformation Matrix Example 3 (ADD and MUL)

Source: https://gdl.graphisoft.com/tips-and-tricks/xform-the-transformation-matrix-and-applied-vector-geometry

An example demonstrating addition and multiplication in XFORM command.

```GDL
XFORM	2,		0,		0,		1,
		0,		3,		0,		2,
		0,		0,		4,		3
```

--------------------------------

### Keyword and Command Formatting

Source: https://gdl.graphisoft.com/gdl-style-guide/naming-conventions

Defines the formatting for keywords, commands, and functions in GDL scripts. Generally, these should be in lowercase, with specific exceptions like the PI constant. Provides examples of loop structures.

```GDL
lowercase
del ntr()
for i = 1 to nsp
```

--------------------------------

### GDL Input and Data Handling

Source: https://gdl.graphisoft.com/reference-guide/index

Commands for reading data from channels and initializing addon scopes. 'INPUT' reads records from a specified channel, and 'INITADDONSCOPE' configures addon parameters.

```GDL
**INPUT** (channel, recordID, fieldID, variable1 [, variable2, ...])
```
Tokens:
Raw