HelloWorld is traditionally written to provide an example of a programming language.

We will be no exception here with our first script’s writing.

The goal is simple, create a line with fixed length.

1) GUI Script

I’m going into the Allplan Library folder (by default located here C:\Data\Allplan\2023\Std\Library\PythonParts) and I’m creating a new file :


As seen above, the GUI files are written in XML.

They begin with the following information :

<?xml version=”1.0″ encoding=”utf-8″?>

This prolog defines the XML version and the character encoding.

Next comes the root Element in which we indicate the information of the main script :




First we find the file path, the title displayed in Allplan and the version of the script.

Here is the complete source code :

2) Main Script

Still in the STD folder, I’m now creating a new file in the PythonPartsScripts directory with this name :


We start by importing the different modules we will need :

import NemAll_Python_BaseElements as BaseElements
import NemAll_Python_BasisElements as BasisElements
import NemAll_Python_Geometry as Geometry
import NemAll_Python_IFW_ElementAdapter as ElementAdapter


from BuildingElement import BuildingElement
from CreateElementResult import CreateElementResult
from PythonPartUtil import PythonPartUtil

Please note : the complete modules’ list is available here.

Scripts need at least 2 functions :

  • check_allplan_version

This function is there to ensure the correct execution of the script in your Allplan’s version (by default all versions are accepted) :

def check_allplan_version(build_ele, version):


# Support all versions
return True

  • create_element

There we launch the creation of objects :

def create_element(build_ele, doc):


model_ele_list = []

pyp_util = PythonPartUtil()



return CreateElementResult(model_ele_list)

Please note : In general, I assume that the objects we are going to study remain in their PythonPart parametric form ; I start by initializing my list of objects to create and then instantiate my PythonPartUtil class.

I query Allplan to retrieve the current values ​​(layer, stroke, color, etc.) :

# Define common properties
com_prop = BaseElements.CommonProperties()

Here’s my line defined by its start and end point :

# Create 2D line
line = Geometry.Line2D(0, 0, 1000, 0)

Please note : the first 2 numbers are the start coordinates (0, 0) and the other 2 are the end point (1000, 0). A horizontal line of 1000mm in length is thus formed.

I add this line to my view :

# Add line to 2d view
pyp_util.add_pythonpart_view_2d(BasisElements.ModelElement2D(com_prop, line))

So I apply graphic properties (com_prop) to my object (line) and I place the result in a 2D view (add_pythonpart_view_2d).

Please note : Allplan offers us the choice on the visibility of our objects => in 2D (add_pythonpart_view_2d), in 3D (add_pythonpart_view_3d) or both (add_pythonpart_view_2d3d).

Last step, I create my PythonPart :

# Create the PythonPart
model_ele_list = pyp_util.create_pythonpart(build_ele)

Here is the complete source code :

Our first script is complete, Allplan generates a line with the correct length and current settings.

We’ll see in the next article how to add a handle to customize the length.


Submit a Comment

Objects3D V2.0

Next step for the modeling of our PythonPart “Reinforced Concrete Column”, today let's see how to configure the anchors of our 3D object. By anchoring I am particularly thinking of 2 types :...

Objects3D V1.0

New series in the PythonParts learning journey, let's delve into the modeling of a 3D object : a reinforced concrete column.1) GUI ScriptIn this example, we will set up the initial fields required...

Objects2D V3.0

Last step for this PythonParts example, I'll show you how to set up a legend for our object. This should include the following information : my object's name ; the name of a characteristic geometric...

Objects2D V2.0

In the previous article, we saw how to prepare our code in OOP, today let's see how to exploit its potential with this new example. Indeed, we are going to complete our PythonPart in order to...

Objects2D V1.0

We will build more complex objects on Allplan software, but first at all a word about Object Oriented Programming (OOP)...1) Object Oriented ProgrammingObject Oriented Programming (called OOP) is a...

HelloWorld V3.0

Last step for our HelloWorld script, we will see how to customize the rendering of our object.1) GUI ScriptBack in our palette, I first create a chapter to dissociate the geometric controls from...

HelloWorld V2.0

Previously, we learned how to create an object (a line with fixed length) via the PythonParts API. Today I'm going to show you how to set up handles for our HelloWorld script...1) GUI ScriptThe...

Structure of PythonParts

Allplan is installed, your IDE is ready... perfect, let's see in detail how PythonParts work.1) Files' DescriptionTo work, a PythonPart needs at least 2 files : GUI File The interface file...


In this series of articles, we'll study the editing of scripts in the Python programming language for the Allplan software.To allow you to follow these tutorials properly, I'm going to make a few...