Allplan interactor python API - Interactor PythonParts

Name: Allplan interactor python API - Interactor PythonParts
Rating: 4.7 (2 reviews)

With the Allplan Python API you can add new functionality to Allplan to meet your personal needs

Created bySanh Mai

Last updated 7/2023

English

What you'll learn

Reduce the manual work of reinforced concrete detailing
Maximise the value of your Allplan software with ALLTO PythonParts
Adjust Allplan to individual working method with PythonParts
With the new Allplan Python interface, Allplan users can add new functions and objects to Allplan and therefore adjust the BIM software to your own method
n interactor is a simple, single-purpose object. Interactor provides a common interface for performing complex user interactions.

Course content

1 section • 8 lectures • 56m total length

Get to know interactor pythonparts - Strip Foundation2:18
What is an Interactor?
An interactor is a simple, single-purpose object. Interactor provides a common interface for performing complex user interactions. This PythonPart has a simple workflow, if you select any point in the Planview, it will create the model. To support these interactive request, Allplan have another type of Pythonparts, You can find them in InteractorExamples.
Email me if you want to get notification for this video course!
Creating Empty Interactive PythonParts10:07
In this lesson 2, we will learn how to create an empty interact PythonParts that we can run without error.
-------
Adjust Allplan to individual working method with PythonParts With the new Allplan Python interface, Allplan users can add new functions and objects to Allplan and therefore adjust the BIM software to their own working method. In addition to parametric objects and variants, recurring work steps can be automated.
Show Palatte For Interactor PythonPart7:56
In this lesson 3, we will learn how to Show Palatte For Interactor PythonParts in Allplan. Firstly, they get these variables by the method read_data_from_pyp.
This method belong to the class BuildingElementService, You can deep dive into this method to see what it's doing.
Get User Input Point For Strip Footing PythonParts7:53
In this lesson 4, I will show you how to get the users input point. Please open pythonparts in allplan to get the source code to use for this lesson. We will use:
- CoordinateInput class
- InputStringConvert class
- IsMouseMove method
- InitNextPointInput method
- GetInputPoint method
Creating the model for Strip Footing PythonParts14:38
As I mentioned in lesson 4, in interactor PythonParts, we use create_interactor instead of create_element function. It's empty for our strip foundation PythonPart.
Now in this lesson 5, we will see how to create the model for our PythonPart. I
n the process_mouse_msg function, we check if users select 2 points, then we create the model and reset.... Watch the video to get through the lesson 5.
Creating preview for strip foundation pythonparts6:02
In this lesson 6, We will show how to create the preview for strip foundation PythonParts. If preview, we will create the preview instead of create elements, using the function DrawElementPreview in AllplanBase module... Watch the video to get through the lesson 6 with us.
Add more features for strip foundation PythonParts7:04
In this lesson, we will improve this PythonPart by adding more features. Example we will add elevation for the model that user can input. Watch the video to know how.
------
Adjust Allplan to individual working method with PythonParts With the new Allplan Python interface, Allplan users can add new functions and objects to Allplan and therefore adjust the BIM software to their own working method. In addition to parametric objects and variants, recurring work steps can be automated.
Bonus lecture0:41

Requirements

Python Language
Allplan Software
Install Allplan version 2023/2022/2021
Install Visual Studio

Description

Allplan users can add new functions and objects to Allplan and therefore adjust the BIM software to their own working method. In addition to parametric objects and variants, recurring work steps can be automated.

Suitable for beginning programmers, through this course of 10 lectures and 3 hours of content, you’ll learn all of the ALLPLAN PythonParts fundamentals and establish a strong understanding of the concept behind object-oriented programming.

Students completing the course will have the knowledge to create functional and useful Allplan PythonPart tools.

Complete with working files and code samples, you’ll be able to work alongside the author as you work through each concept.

What is Allplan Interactor?

An interactor is a simple, single-purpose object. Interactor provides a common interface for performing complex user interactions.

This PythonPart has a simple workflow, if you select any point in the Planview, it will create the model. To support these interactive request, Allplan have another type of Pythonparts, You can find them in 'Interactor Examples'.

Getting started! - Get python!

The required Python version is already installed together with Allplan. The standard Python installation of Allplan contains all parts of the Python framework that are required to run the PythonParts supplied by Allplan. You can find it in the Allplan program directory under ...\Prg\Python.

The current Python version used by Allplan are:

Allplan Version 2021: Python Version 3.8.8 (64-bit)
Allplan Version 2022: Python Version 3.8.8 (64-bit)
Allplan Version 2023: Python Version 3.8.8 (64-bit)

Note: Since Python package is already delivered with Allplan, you don't need to install it separately. If you however want to install it in your environment, make sure you have the appropriate version.

INCLUDE THE TOOLS AND EXAMPLES IN LIBRARY:

There are many useful PythonPart tools and examples included in the Allplan installation. They are located in the folders:

....\etc\Examples\PythonParts for the pyp files
....\etc\PythonPartsExampleScripts for the py files

The easiest way to start using them is to include them in Allplan's Library Palette. To do that, add the path of the pyp files to the External folder.

INSTALL THE RIGHT IDE

You can edit your Python code with a normal text editor but for a better effinciency we strongly reccomend using a proper Integrated Development Environment, or IDE. Those will help you by the development by checking and debugging your code. There are many IDEs available but in this tutorial we are going to focus on the two most common ones.

We reccommend following extensions to be installed for the development of PythonParts:

Python: extension for code formating, refactoring, unit test and more
Pylance: a performant, feature-rich language server for Python
Python Indent: for correct Python intendation
Pylint: tool for linting your python code
Studio Icons

With Allplan PythonParts, the scripting of reinforcement is far more efficient.

Who this course is for:

Structural Engineer
BIM Engineer
BIM developer
Civil Engineer