Allpy
Allpy
Allpy
Release 0.1.0
Manfred Moitzi
2 File Structure 7
2.1 PythonPart Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.2 Library Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.3 PythonPartScripts Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.4 Just Look, Don’t Touch Policy in ETC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
3 Development Environment 11
3.1 Location of the Building Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.2 Reload Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.3 Windows Python Launcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
4 Introduction 13
5 allpy 15
6 allpy.env 17
7 allpy.pyp 19
8 allpy.geo 21
9 allpy.build 23
10 allpy.workbench 25
i
11 allpy.util 27
12 allpy.colors 29
13 Basic PythonPartsScript 31
13.1 Required Callback Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
13.2 Optional Callback Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
14 Standard TextIds 33
15 Introduction 37
16 NemAll_Python_AllplanSettings 39
16.1 Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
17 NemAll_Python_ArchElements 43
17.1 Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
18 NemAll_Python_BaseElements 45
18.1 Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
18.2 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
18.3 Global Defined Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
19 NemAll_Python_BasisElements 51
19.1 Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
19.2 ENums . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
19.3 Global Defined Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
20 NemAll_Python_Geometry 75
20.1 Data Object Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
20.2 List Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
20.3 Abstract Base Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
20.4 2D Object Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
20.5 3D Object Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
20.6 Service Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
20.7 ENum Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
20.8 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
20.9 Global Defined Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
21 NemAll_Python_IFW_Input 185
21.1 Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
21.2 ENums . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
21.3 Global Defined Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
22 NemAll_Python_Palette 199
22.1 Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
22.2 ENums . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
23 NemAll_Python_Reinforcement 213
23.1 Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
23.2 ENums . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
23.3 Global Defined Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
24 NemAll_Python_Utility 233
24.1 Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
24.2 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
ii
24.3 Global Defined Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
26 News 239
iii
iv
CHAPTER 1
If you want to write your own PythonParts (this is the only reason to use allpy), this Information may be of interest
for you. This section shows my personal experience I gathered by writing the allpy package and as time goes by, they
may be not true anymore! (written 25.12.2016 using Allplan 2017.1 and Python 3.5.2)
The Python Environment provided by Allplan is only determined to run PythonParts inside of Allplan, if you launch
the Python interpreter in PRG\Python, you get an error message about the missing python35.dll which is located in
the parent PRG folder. You can run the Allplan Python interpreter if you copy the python35.dll into the folder of
python35.exe.
But this is not the only problem, the Allplan Python interpreter started inside of Allplan strips the sys.path (locations
where to search for additional modules and packages), especially the user’s site-packages folder will be removed, if
you want to use “pip” to install packages from Python Package Index (PyPI), you can only install this packages into the
Allplan site-packages directory (PRG\Python\lib\site-packages), which is in the write protected program installation
path. This requires to run the Allplan Python interpreter within a command shell with admin rigthts.
This were the point I choose not to touch the Allplan Python Environment at all and it is nevertheless possible to add
your own packages and also using “pip” to install packages from PyPI.
1
allpy Documentation, Release 0.1.0
Learn Python!
Python is for much more useful than just PythonParts, so learn Python the proper way, read some (free) books:
• The (official) Python Tutorial by Python.org (free, no registration & online to read)
• Dive into Python 3 (free, no registration & online to read)
• Python Cookbook (free, no registration & online to read), this is advanced stuff!
• Python books linked at Python.org (english) (some are free)
• Free books linked at OnlineProgrammingBooks.com (english)
The strategy is to extend the sys.path at runtime, because I don’t know how to add paths permanently to the Allplan
Python environment (Status 25.12.2016), and Allplan removes some standard search paths from sys.path, I de-
cided to use a special python module exendsyspath.py, located in one of the Allplan Python standard search paths:
STD\PythonPartsScripts (ETC\PythonPartsScripts would also work), from this location it is available from all Python-
Parts launched by the Allplan application.
PATHS = [
# replace <username> with your user name, this is the location of
# the user's site packages, so every package installed with
# 'py -m pip install --user <packagename>' is available inside of Allplan
r"C:\users\<username>\AppData\Python\Python35\site-packages",
# I would not recommend to add the system wide site-packages directory
You can use my allpyhelper tool on the command line to create a “extendsyspath.py” file in STD\PythonPartsScripts:
py -m allpyhelper --extendsyspath
By adding the Allplan PRG path to the standard Python environment, it is possible to run/test your PythonPartsScripts
from outside of Allplan. But some API objects need a running Allplan application to work properly. And it helps
PyCharm to generate proper interface files to the binary libs to get doc strings and identifier strings for auto completion.
Again this step is not necessary to write PythonParts but it is very helpful if you use an IDE.
You can add the PRG path in your development environment (VS 2015 or PyCharm), or crate a .pth file in your user
site package folder, this is the universal solution, because it works for every IDE, Editor or just the plain command
line.
The file location should look like this (replace <username>): C:\users\<username>\AppData\Python\Python35\site-pa
if “site-packages” does not exist, create a new folder. Add a file with a unique name and the ending .pth, I would
suggest allplan.pth. Every line in this file represents an additional search path for sys.path, but this way the Python
interpreter adds this location automatically to sys.path. The Python interpreter launched within Allplan prevents this
standard mechanism actively, therefore I needed the awkward solution with extendsyspath.py as shown above.
Example allplan.pth:
You can use my allpyhelper tool on the command line to create a “allplan.pth” file in your site package folder:
py -m allpyhelper --setlibpath
If you choose Visual Studio as your development environment, please follow the instruction provided by Allplan.
This section shows how to setup PyCharm as developing environment for PythonParts.
Setup a new PyCharm Project.
The Allplan python environment installed in C:\Program Files\Allplan\Allplan 2017\Prg\Python
will not recognised as full functional Python environment by PyCharm, it is not worth to repair the Allplan Python
environment (see introduction). If you haven’t already installed a regular Python 3.5 64-bit environment, do it now.
Warning: It is not recommend to run the 32-bit and the 64-bit environment of the same Python version on the
same machine.
3. If you haven’t created the allplan.pth file in your site packages folder, you can add the lib path to the Python
environment, in the settings menu (wheel beside the env name), choose menu “more”, select your python en-
vironment, click on “Show path for the selected interpreter” (last icon from above), and add (+ symbol) the
Allplan PRG path, the path to PRG should look like this C:\\Program Files\\Allplan\\Allplan
2017\\Prg.
4. PyCharm has to update its project skeleton, this may take a while.
Download the unit test from the Allplan site, and unzip the tests into your PyCharm project directory.
Create a new test runner with Edit -> Edit Configurations ....
Add a test suite (green +) -> Python tests -> Unittests
Name the test suite, in Unittests select “All in folder”, select the folder containing the test files, as Pattern set *.py, and
use the standard Python 3.5 interpreter.
Because I use PyCharm, I don’t need PyLint and therefore I haven’t installed it, and the test TestPyLint.py breaks the
test suite, I just deleted this file.
Now you can run the unit tests provided by Allplan. But in Allplan 2017 some of the available tests from 2016-03-07
and 2016-06-24 fail, because of a change of the API.
When installing packages with the PyCharm package dialog, check the option “install packages into user’s site-
packages directory”, if the packages should be available for PythonPartsScripts started by Allplan.
Installing from the command line into the regular Python environment
If you have a system wide (means not a virtual environment) Python environment, just type:
• option –user is important to install the packages in the user’s site-packages directory.
• use <package-name> to install packages from the official Python Package Index (PyPI)
• use a <package-path> to install downloaded packages from .zip or .whl files
Do not add additional lines to allplan.pth, create your own .pth file as shown in Extending sys.path the Standard Way,
so you can update the Allplan paths with py -m allpyhelper -setlibpath -force, after you upgraded
your Allplan installation to a new release without loosing your paths, and also add this line to exendsyspath.py as
shown in Extending sys.path the Awkward Way, this is my preferred way to add my packages in development status.
PyCharm Configuration
To get syntax high lightning for PYP files (this are plain XML files), register the file extension *.pyp:
Menu: File -> Settings -> Editor -> File Types
In dialog field “Recognised File Types” select “XML”, and in the field “Registered Pattern” add “*.pyp”.
Project Configuration
For easy access to all PythonPartsScripts, I added my STDPythonParts directory as additional content root: Settings
-> Project -> Project Structure -> Add Content Root
And to quickly look into the Building Framework, I also added ETC\PythonPartsScripts as content root. You find
ETC in C:\\ProgramData\\Nemetschek\\Allplan\\2017 or use the Allmenu application (Service ->
Windows Explorer).
File Structure
PythonPart Files
Hint: Always save your files with UTF-8 encoding, especially if you use none ASCII 7-bit characters (like ÄÖÜß)
7
allpy Documentation, Release 0.1.0
The standard setting in Notepad++ for code indention for Python is tabs, change this to (4) spaces. Activate the option
“Replace by Space” (Tabs) in Settings -> Preferences -> Options -> Language -> Python
Library Folders
PythonPartScripts Folders
Development Environment
The Allplan building framework resides in the ETC directory. You can open the ETC path with Allmenu -> Sevice
-> Windows Explorer, the location should look like C:\\ProgramData\\Nemetschek\\Allplan\\2017.
The framework is in the ETC\PythonPartsScripts\GeneralScripts folder. In ETC applies the vendor policy: “Just look,
don’t touch!”.
See also:
Just Look, Don’t Touch Policy in ETC
Location of the PythonPart parameter *.pyp file: Library Folders.
Location of the PythonPart script *.py file(s): PythonPartScripts Folders.
Reload Scripts
Allplan does not reload scripts automatically, to change this behavior open the ETC path with Allmenu, the location
should look like C:\\ProgramData\\Nemetschek\\Allplan\\2017. This is the rare case you have to
break the “Just look, don’t touch!” policy. Edit the ETC\PythonPartsScripts\GeneralScripts\CreateLibraryPreview.py
script in line #56 (Allplan 2017):
# original
build_element_script = BuildingElementUtil.import_building_element_script(build_ele_
˓→list[0], False)
# changed
build_element_script = BuildingElementUtil.import_building_element_script(build_ele_
˓→list[0], True)
11
allpy Documentation, Release 0.1.0
The last parameter tells the import_building_element_script() function to reload the script.
This only updates the preview at the mouse pointer not the preview window in the side panel. And this may reduces
the performance of the preview building process in Allplan.
Since Python3 is the windows python launcher py.exe in the standard distribution included, the launcher is installed
in the C:\\Windows folder, and is therefore accessible from everywhere, so open a command line (press WIN+R
and type “cmd”) and type “py” to start the Python interpreter or “py <name>.py” to start a python script, for mor
information to py.exe see: Python docs and Python Insider
Introduction
TODO
13
allpy Documentation, Release 0.1.0
14 Chapter 4. Introduction
CHAPTER 5
allpy
TODO
15
allpy Documentation, Release 0.1.0
16 Chapter 5. allpy
CHAPTER 6
allpy.env
17
allpy Documentation, Release 0.1.0
18 Chapter 6. allpy.env
CHAPTER 7
allpy.pyp
19
allpy Documentation, Release 0.1.0
20 Chapter 7. allpy.pyp
CHAPTER 8
allpy.geo
21
allpy Documentation, Release 0.1.0
22 Chapter 8. allpy.geo
CHAPTER 9
allpy.build
23
allpy Documentation, Release 0.1.0
24 Chapter 9. allpy.build
CHAPTER 10
allpy.workbench
25
allpy Documentation, Release 0.1.0
allpy.util
27
allpy Documentation, Release 0.1.0
allpy.colors
29
allpy Documentation, Release 0.1.0
Basic PythonPartsScript
The Allplan building framework based on callback function, these function have to follow a strict naming convention.
A PythonPartScript requires at least the implementation of the following two functions
check_allplan_version() and create_element(). These functions are called by building frame-
work if you start a PythonPart, and Allplan will complain if one of this functions is missing.
check_allplan_version(build_ele, version)
Parameters
• build_ele (BuildingElement) – BuildingElement
• version (str) – Allplan version like '2017.0'
Returns True/False if given version is supported
A request by the building framework ask the PythonPart if it supports the given version. Return True if the given
version is supported.
create_element(build_ele, doc)
Parameters
• build_ele (BuildingElement) – BuildingElement
• doc (NemAll_Python_IFW_Input.DocumentAdapter) – input document
Returns tuple with created elements, handles and (optional) reinforcement.
Return type tuple(list, list[, list])
31
allpy Documentation, Release 0.1.0
By calling this function the building framework request the geometry elements, the handles and optional the
reinforcement elements created by the PythonPart.
Standard TextIds
33
allpy Documentation, Release 0.1.0
35
allpy Documentation, Release 0.1.0
Introduction
This Allplan Python API documentation should and can not replace the original documentation provided by the Allplan
company. It will always be a striped down version, explaining only the most (by myself) used features.
37
allpy Documentation, Release 0.1.0
NemAll_Python_AllplanSettings
Classes
AllplanGlobalSettings
class NemAll_Python_AllplanSettings.AllplanGlobalSettings
Class for getting global Allplan settings
AllplanGlobalSettings Methods
AllplanGlobalSettings.GetCurrentColorId() → int
AllplanGlobalSettings.GetCurrentFaceStyleId() → int
AllplanGlobalSettings.GetCurrentFontId() → int
AllplanGlobalSettings.GetCurrentHatchId() → int
AllplanGlobalSettings.GetCurrentLayerId() → int
AllplanGlobalSettings.GetCurrentPatternId() → int
AllplanGlobalSettings.GetCurrentPenId() → int
AllplanGlobalSettings.GetCurrentStrokeId() → int
AllplanLocalisationService
class NemAll_Python_AllplanSettings.AllplanLocalisationService
Class for extraction of Allplan localization settings
AllplanLocalisationService Methods
AllplanLocalisationService.AllplanLanguage() → str
39
allpy Documentation, Release 0.1.0
bul Bulgarian
deu German
eng English
fin Finnish
fra French
grc Greek
hol Dutch
hrv Croatian
ita Italian
pol Polish
rum Romanian
rus Russian
slk Slovak
spa Spanish
svn Slovenian
tch Czech
trk Turkish
ung Hungarian
dan Danish
ser Serbian
mak Macedonian
prt Portuguese
ltu Lithuanian
lva Latvian
est Estonian
ukr Ukrainian
swe Swedish
nor Norwegian
chn Chinese
kor Korean
jpn Japanese
usa USA - English
AllplanLocalisationService.Language() → str
Get the current Allplan language
Returns Allplans currently used language as a two letter description
bg Bulgarian
de German
en English
fi Finnish
fr French
el Greek
nl Dutch
hr Croatian
it Italian
pl Polish
ro Romanian
Continued on next page
AllplanPaths
class NemAll_Python_AllplanSettings.AllplanPaths
Class for getting Allplan paths
AllplanPaths Methods
AllplanPaths.GetCurPrjDesignPath() → str
AllplanPaths.GetCurPrjPath() → str
AllplanPaths.GetEtcPath() → str
AllplanPaths.GetStdDesignPath() → str
AllplanPaths.GetStdPath() → str
AllplanPaths.GetUsrPath() → str
AllplanVersion
class NemAll_Python_AllplanSettings.AllplanVersion
Class for extraction of Allplan version information
AllplanVersion Methods
AllplanVersion.MainReleaseName() → str
Returns Allplan main release name ('2016', '2017', ...)
AllplanVersion.SubReleaseName() → str
Returns Allplan sub release name ('2016.0', '2016.1', ...)
AllplanVersion.Version() → str
16.1. Classes 41
allpy Documentation, Release 0.1.0
NemAll_Python_ArchElements
Classes
AllplanElement
class NemAll_Python_ArchElements.AllplanElement
AllplanElement Methods
AllplanElement.GetAttributes(elem: AllplanElement) → object
Returns Attributes object
AllplanElement.GetCommonProperties(elem: AllplanElement) → CommonProperties
AllplanElement.GetGeometryObject(elem: AllplanElement) → object
Returns Geometry object
AllplanElement.SetAttributes(elem: AllplanElement, attributesObject)
Set the attributes object
AllplanElement.SetCommonProperties(arg1: AllplanElement, commonProp: CommonProper-
ties)
AllplanElement.SetGeometryObject(arg1: AllplanElement, geometryObject)
ArchElement
class NemAll_Python_ArchElements.ArchElement(AllplanElement)
43
allpy Documentation, Release 0.1.0
NemAll_Python_BaseElements
Classes
Attribute
class NemAll_Python_BaseElements.Attribute
AttributeByteVec
class NemAll_Python_BaseElements.AttributeByteVec(Attribute)
AttributeByteVec Methods
AttributeByteVec.__init__(*args)
Multiple method signatures:
__init__()
__init__(id: int, value: VecByteList)
AttributeByteVec.__eq__(other: AttributeByteVec) → bool
Returns True if self equals other.
AttributeByteVec Properties
AttributeByteVec.Id
AttributeByteVec.Value
45
allpy Documentation, Release 0.1.0
AttributeDate
class NemAll_Python_BaseElements.AttributeDate(Attribute)
AttributeDate Methods
AttributeDate.__init__(*args)
Multiple method signatures:
__init__()
__init__(id: int, day: int, month: int, year: int)
AttributeDate.__eq__(other: AttributeDate) → bool
Returns True if self equals other.
AttributeDate Properties
AttributeDate.Day
AttributeDate.Id
AttributeDate.Month
AttributeDate.Year
AttributeDouble
class NemAll_Python_BaseElements.AttributeDouble(Attribute)
AttributeDouble Methods
AttributeDouble.__init__(*args)
Multiple method signatures:
__init__(arg1: object)
__init__(arg1: object, id: int, value: float)
Constructor
Parameter: id Attribute id value Attribute value
AttributeDouble.__eq__(other: AttributeDouble) → bool
Returns True if self equals other.
AttributeDouble Properties
AttributeDouble.Id
AttributeDouble.Value
AttributeDoubleVec
class NemAll_Python_BaseElements.AttributeDoubleVec(Attribute)
AttributeDoubleVec Methods
AttributeDoubleVec.__init__(*args)
Multiple method signatures:
__init__()
AttributeDoubleVec.__init__id: int, value: VecDoubleList)
AttributeEnum
class NemAll_Python_BaseElements.AttributeEnum(Attribute)
AttributeEnum Methods
AttributeEnum.__init__(*args)
Multiple method signatures:
__init__()
__init__(id: int, value: int)
AttributeEnum.__eq__(other: AttributeEnum) → bool
Returns True if self equals other.
AttributeEnum Properties
AttributeEnum.Id
AttributeEnum.Value
AttributeInteger
class NemAll_Python_BaseElements.AttributeInteger(Attribute)
AttributeInteger Methods
AttributeInteger.__init__(*args)
Multiple method signatures:
__init__()
__init__(id: int, value: int)
AttributeInteger.__eq__(other: AttributeInteger) → bool
Returns True if self equals other.
AttributeInteger Properties
AttributeInteger.Id
AttributeInteger.Value
AttributeIntegerVec
class NemAll_Python_BaseElements.AttributeIntegerVec(Attribute)
AttributeIntegerVec Methods
AttributeIntegerVec.__init__(*args)
Multiple method signatures:
18.1. Classes 47
allpy Documentation, Release 0.1.0
__init__()
__init__(id: int, value: VecIntList)
AttributeIntegerVec.__eq__(other: AttributeIntegerVec) → bool
Returns True if self equals other.
AttributeIntegerVec Properties
AttributeIntegerVec.Id
AttributeIntegerVec.Value
AttributeSet
class NemAll_Python_BaseElements.AttributeSet(Boost.Python.instance)
Attribute set class
AttributeSet Methods
AttributeSet.__init__(*args)
Multiple method signatures:
__init__()
__init__(elements: List[Attribute])
AttributeSet.GetAttributes() → List[Attribute]
Returns Vector of Attribute elements
AttributeSet.SetAttributes(elements: List[Attribute])
AttributeSet.__eq__(other: AttributeSet) → bool
AttributeSet Properties
AttributeSet.Attributes
AttributeString
class NemAll_Python_BaseElements.AttributeString(Attribute)
AttributeString Methods
AttributeString.__init__(*args)
Multiple method signatures:
__init__()
__init__(id: int, value: str)
AttributeString.__eq__(other: AttributeString) → bool
AttributeString Properties
AttributeString.Id
AttributeString.Value
AttributeStringVec
class NemAll_Python_BaseElements.AttributeStringVec(Attribute)
AttributeStringVec Methods
AttributeStringVec.__init__(*args)
Multiple method signatures:
__init__()
__init__(id: int, value: VecStringList)
AttributeStringVec.__eq__(other: AttributeStringVec) → bool
AttributeStringVec Properties
AttributeStringVec.Id
AttributeStringVec.Value
Attributes
class NemAll_Python_BaseElements.Attributes(Boost.Python.instance)
Attributes class
Attributes Methods
Attributes.__init__(*args)
Multiple method signatures:
__init__()
__init__(attributeSets: List[AttributeSet])
Attributes.GetAttributeSets() → List[AttributeSet]
Attributes.SetAttributeSets(sets: List[AttributeSet])
Attributes.__eq__(other: Attributes) → bool
Attributes Properties
Attributes.AttributeSets
CommonProperties
class NemAll_Python_BaseElements.CommonProperties(Boost.Python.instance)
CommonProperties Methods
CommonProperties.__init__(*args)
Multiple method signatures:
__init__()
__init__(prop: CommonProperties)
Copy constructor
CommonProperties.GetGlobalProperties()
CommonProperties.__eq__(other: CommonProperties) → bool
CommonProperties Properties
18.1. Classes 49
allpy Documentation, Release 0.1.0
CommonProperties.Color
CommonProperties.ColorByLayer
CommonProperties.HelpConstruction
CommonProperties.Layer
CommonProperties.Pen
CommonProperties.PenByLayer
CommonProperties.Stroke
CommonProperties.StrokeByLayer
Functions
NemAll_Python_BasisElements
Classes
ARGB
class NemAll_Python_BasisElements.ARGB
ARGB class, RGB color value with alpha (transparency) channel.
ARGB Properties
ARGB.Alpha
Property for alpha channel
ARGB.Blue
Property for blue channel
ARGB.Green
Property for green channel
ARGB.Red
Property for red channel
ARGB Methods
ARGB.__init__(*args)
Multiple method signatures:
__init__()
__init__(red: int, green: int, blue: int, alpha: int)
Constructor with RGBA components.
__init__(argb: ARGB)
Copy constructor.
51
allpy Documentation, Release 0.1.0
AllplanElement
class NemAll_Python_BasisElements.AllplanElement
AllplanElement Methods
AllplanElement.GetAttributes() → object
AllplanElement.GetCommonProperties() → CommonProperties
AllplanElement.GetGeometryObject() → object
AllplanElement.SetAttributes(attributesObject: object)
AllplanElement.SetCommonProperties(commonProp: CommonProperties)
AllplanElement.SetGeometryObject(geometryObject: object)
AttributeContainer
class NemAll_Python_BasisElements.AttributeContainer(BasisElement)
AttributeContainer class
AttributeContainer Methods
AttributeContainer.__init__(*args)
Multiple method signatures:
__init__()
__init__(attributesObject: object)
BasisElement
class NemAll_Python_BasisElements.BasisElement(AllplanElement)
BitmapAreaElement
class NemAll_Python_BasisElements.BitmapAreaElement(BasisElement)
BitmapAreaElement class
BitmapAreaElement Methods
For inherited methods see: class AllplanElement
BitmapAreaElement.__init__(*args)
Multiple method signatures:
__init__()
__init__(commonProp: CommonProperties, bitmapAreaProp: BitmapAreaProperties, geometryOb-
ject: object)
BitmapAreaElement.GetBitmapAreaProperties() → BitmapAreaProperties
BitmapAreaElement.SetBitmapAreaProperties(bitmapAreaProp: BitmapAreaProperties)
BitmapAreaProperties
class NemAll_Python_BasisElements.BitmapAreaProperties
BitmapAreaProperties class
BitmapAreaProperties Properties
BitmapAreaProperties.BitmapName
BitmapAreaProperties.DirectionToReferenceLine
BitmapAreaProperties.ReferencePoint
BitmapAreaProperties.RotationAngle
BitmapAreaProperties.TransparentColor
BitmapAreaProperties.TransparentColorTolerance
BitmapAreaProperties.UseDirectionToReferenceLine
BitmapAreaProperties.UseMetricalValues
BitmapAreaProperties.UsePixelMask
BitmapAreaProperties.UseReferencePoint
BitmapAreaProperties.UseRepeatTile
BitmapAreaProperties.XOffset
BitmapAreaProperties.XScalingFactor
BitmapAreaProperties.YOffset
BitmapAreaProperties.YScalingFactor
BitmapAreaProperties Methods
BitmapAreaProperties.__eq__(other: BitmapAreaProperties) → bool
BitmapAreaProperties.__init__()
ElementGroupElement
class NemAll_Python_BasisElements.ElementGroupElement(BasisElement)
ElementGroupElement class
ElementGroupElement Methods
For inherited methods see: class AllplanElement
ElementGroupElement.__init__(*args)
Multiple method signatures:
__init__()
__init__(commonProp: CommonProperties, elementGroupProp: ElementGroupProperties, element-
GroupObjectList: list)
ElementGroupElement.GetElementGroupProperties() → ElementGroupProperties
ElementGroupElement.GetObjectList() → list
Get the list of element group objects.
ElementGroupElement.SetElementGroupProperties(ElementGroupProp: ElementGroupProp-
erties)
19.1. Classes 53
allpy Documentation, Release 0.1.0
ElementGroupProperties
class NemAll_Python_BasisElements.ElementGroupProperties
ElementGroupProperties class
ElementGroupProperties Properties
ElementGroupProperties.ModifiableFlag
ElementGroupProperties.Name
ElementGroupProperties.SubType
ElementGroupProperties Methods
ElementGroupProperties.__init__()
ElementGroupProperties.__eq__(other: ElementGroupProperties) → bool
EndSymbolsProperties
class NemAll_Python_BasisElements.EndSymbolsProperties
EndSymbolsProperties class
EndSymbolsProperties Properties
EndSymbolsProperties.EndID
EndSymbolsProperties.EndSize
EndSymbolsProperties.StartID
EndSymbolsProperties.StartSize
EndSymbolsProperties Methods
EndSymbolsProperties.__init__(*args)
Multiple method signatures:
__init__()
__init__(startID: int, startSize: float, endID: int, endSize: float)
EndSymbolsProperties.__eq__(other: EndSymbolsProperties) → bool
FaceStyleElement
class NemAll_Python_BasisElements.FaceStyleElement(BasisElement)
FaceStyleElement class
FaceStyleElement Methods
For inherited methods see: class AllplanElement
FaceStyleElement.__init__(*args)
Multiple method signatures:
__init__()
__init__(commonProp: CommonProperties, faceStyleProp: FaceStyleProperties, geometryObject:
object)
FaceStyleElement.GetFaceStyleProperties() → FaceStyleProperties
FaceStyleElement.SetFaceStyleProperties(faceStyleProp: FaceStyleProperties)
FaceStyleProperties
class NemAll_Python_BasisElements.FaceStyleProperties
FaceStyleProperties class
FaceStyleProperties Properties
FaceStyleProperties.DirectionToReferenceLine
FaceStyleProperties.FaceStyleID
FaceStyleProperties.ReferencePoint
FaceStyleProperties.RotationAngle
FaceStyleProperties.UseDirectionToReferenceLine
FaceStyleProperties.UseReferencePoint
FaceStyleProperties Methods
FaceStyleProperties.__init__()
FaceStyleProperties.__eq__(other: FaceStyleProperties) → bool
FillingElement
class NemAll_Python_BasisElements.FillingElement(BasisElement)
FillingElement class
FillingElement Methods
For inherited methods see: class AllplanElement
FillingElement.__init__(*args)
Multiple method signatures:
__init__()
__init__(commonProp: CommonProperties, gradientFillingProp: FillingProperties, geometryObject:
object)
FillingElement.GetFillingProperties() → FillingProperties
FillingElement.SetFillingProperties(gradientFillingProp: FillingProperties)
FillingProperties
class NemAll_Python_BasisElements.FillingProperties
FillingProperties class
FillingProperties Properties
FillingProperties.DirectionToReferenceLine
FillingProperties.FirstColor
FillingProperties.RotationAngle
FillingProperties.SecondColor
19.1. Classes 55
allpy Documentation, Release 0.1.0
FillingProperties.ShadingType
FillingProperties.TranslationType
FillingProperties.UseDirectionToReferenceLine
FillingProperties.UseGradientFilling
FillingProperties.VariantType
FillingProperties Methods
FillingProperties.__init__()
FillingProperties.__eq__(other: FillingProperties) → bool
HatchingElement
class NemAll_Python_BasisElements.HatchingElement(BasisElement)
HatchingElement class
HatchingElement Methods
For inherited methods see: class AllplanElement
HatchingElement.__init__(*args)
Multiple method signatures:
__init__()
__init__(commonProp: CommonProperties, hatchingProp: HatchingProperties, geometryObject:
object)
HatchingElement.GetHatchingProperties() → HatchingProperties
HatchingElement.SetHatchingProperties(hatchingProp: HatchingProperties)
HatchingProperties
class NemAll_Python_BasisElements.HatchingProperties
HatchingProperties class
HatchingProperties Properties
HatchingProperties.BackgroundColor
HatchingProperties.DirectionToReferenceLine
HatchingProperties.HatchID
HatchingProperties.IsScaleDependent
HatchingProperties.ReferencePoint
HatchingProperties.RotationAngle
HatchingProperties.UseBackgroundColor
HatchingProperties.UseReferencePoint
HatchingProperties Methods
HatchingProperties.__init__()
HatchingProperties.__eq__(other: HatchingProperties) → bool
MacroElement
class NemAll_Python_BasisElements.MacroElement(BasisElement)
MacroElement class
MacroElement Methods
For inherited methods see: class AllplanElement
MacroElement.__init__(*args)
Multiple method signatures:
__init__()
__init__(macroProp: MacroProperties, slideList: list)
Constructor
Parameters
• macroProp – Macro properties
• slideList – Slide list of macro definition
MacroElement.GetHash() → str
Get the hash value
MacroElement.GetMacroProperties() → MacroProperties
MacroElement.GetSlideList() → list
Get the slide object list.
MacroElement.SetHash(hash: str)
Set the hash value
MacroElement.SetMacroProperties(MacroProp: MacroProperties)
MacroGroupElement
class NemAll_Python_BasisElements.MacroGroupElement(BasisElement)
MacroGroupElement class
MacroGroupElement Methods
For inherited methods see: class AllplanElement
MacroGroupElement.__init__(*args)
Multiple method signatures:
__init__()
__init__(macroGroupProp: MacroGroupProperties, slideList: list)
Constructor
Parameters
• macroGroupProp – MacroGroup properties
• placementList – Placement list of macro group
__init__(commonProp: CommonProperties, macroGroupProp: MacroGroupProperties, slideList:
list)
Constructor
Parameters
19.1. Classes 57
allpy Documentation, Release 0.1.0
MacroGroupProperties
class NemAll_Python_BasisElements.MacroGroupProperties
MacroGroupProperties class
MacroGroupProperties Properties
MacroGroupProperties.Name
MacroGroupProperties Methods
MacroGroupProperties.__init__()
MacroGroupProperties.__eq__(prop: MacroGroupProperties) → bool
MacroPlacementElement
class NemAll_Python_BasisElements.MacroPlacementElement(BasisElement)
MacroPlacementElement class
MacroPlacementElement Methods
For inherited methods see: class AllplanElement
MacroPlacementElement.__init__(*args)
Multiple method signatures:
__init__()
__init__(commonProp: CommonProperties, macroPlacementProp: MacroPlacementProperties,
macro: object, reinforcementList: list)
Constructor
Parameters
• commonProp – Common properties
• macroPlacementProp – MacroPlacement properties
• macro – Macro definition element
• reinforcementList – Reinforcement elements
GetMacro() → object
Returns Macro definition element
GetMacroPlacementProperties() → MacroPlacementProperties
SetMacroPlacementProperties(macroPlacementProp: MacroPlacementProperties)
MacroPlacementProperties
class NemAll_Python_BasisElements.MacroPlacementProperties
MacroPlacementProperties class
MacroPlacementProperties Properties
MacroPlacementProperties.BillingCategory
MacroPlacementProperties.ConsiderType
MacroPlacementProperties.Craft
MacroPlacementProperties.DistortionState
MacroPlacementProperties.DomainType
MacroPlacementProperties.HasParentModificationBehaviour
Property for specific behavior for modification state
MacroPlacementProperties.HeightDefinitionType
MacroPlacementProperties.InOpeningState
Property for state if the macro placement is inside an opening
MacroPlacementProperties.LinkType
MacroPlacementProperties.Mass_V6
MacroPlacementProperties.Mass_V7
MacroPlacementProperties.Mass_V8
MacroPlacementProperties.Mass_V9
MacroPlacementProperties.Matrix
Property for matrix. Specifies location in world coordinate system
MacroPlacementProperties.MirrorState
Property for the macro placement mirrored state
MacroPlacementProperties.Name
MacroPlacementProperties.PositionNr
Property for position number
MacroPlacementProperties.SubType
MacroPlacementProperties.Type
MacroPlacementProperties.UnitFactor
MacroPlacementProperties.UseAlways2DRepInGroundView
Property for state if always 2D representation in ground view is shown.
MacroPlacementProperties.UseDrawOrder
Property for the draw order setting of the placement or the elements of the macro.
MacroPlacementProperties.UseFormat
Property for the format setting (pen, stroke, color) of the placement or the elements of the macro.
MacroPlacementProperties Methods
MacroPlacementProperties.__init__()
MacroPlacementProperties.__eq__(other: MacroPlacementProperties) → bool
19.1. Classes 59
allpy Documentation, Release 0.1.0
MacroProperties
class NemAll_Python_BasisElements.MacroProperties
MacroProperties class
MacroProperties Properties
MacroProperties.CatalogName
MacroProperties.DomainType
MacroProperties.InsertionPoint
MacroProperties.IsScaleDependent
MacroProperties.Name
MacroProperties.PositionNr
MacroProperties.SubType
MacroProperties.UnitFactor
MacroProperties Methods
MacroProperties.__init__()
MacroProperties.__eq__(other: MacroProperties) → bool
MacroSlideElement
class NemAll_Python_BasisElements.MacroSlideElement(BasisElement)
MacroSlideElement class
MacroSlideElement Methods
For inherited methods see: class AllplanElement
MacroSlideElement.__init__(*args)
Multiple method signatures:
__init__()
__init__(macroSlideProp: MacroSlideProperties, objectList: list)
MacroSlideElement.GetMacroSlideProperties() → MacroSlideProperties
MacroSlideElement.GetObjectList() → list
Get the slide object list
MacroSlideElement.SetMacroSlideProperties(macroSlideProp: MacroSlideProperties)
MacroSlideProperties
class NemAll_Python_BasisElements.MacroSlideProperties
MacroSlideProperties class
MacroSlideProperties Properties
MacroSlideProperties.EndScaleRange
Property for end reference scale of slide
MacroSlideProperties.OffsetOfReferencePoint1
Property for first offset value to reference point
MacroSlideProperties.OffsetOfReferencePoint2
Property for second offset value to reference point
MacroSlideProperties.ReferencePoint
MacroSlideProperties.ResizeSettingVx
Property for resize setting for x direction
MacroSlideProperties.ResizeSettingVy
Property for resize setting for y direction
MacroSlideProperties.ResizeSettingVz
Property for resize setting for z direction
MacroSlideProperties.StartScaleRange
Property for start reference scale of slide
MacroSlideProperties.Type
Property for type of slide
MacroSlideProperties.VisibilityGeo2D
Property for geometry 2D visibility of slide
MacroSlideProperties.VisibilityGeo3D
Property for geometry 3D visibility of slide
MacroSlideProperties.VisibilityLayerA
Property for layer A visibility of slide
MacroSlideProperties.VisibilityLayerB
Property for layer B visibility of slide
MacroSlideProperties.VisibilityLayerC
Property for layer C visibility of slide
MacroSlideProperties Methods
MacroSlideProperties.__init__()
MacroSlideProperties.__eq__(other: MacroSlideProperties) → bool
ModelElement2D
class NemAll_Python_BasisElements.ModelElement2D(BasisElement)
ModelElement2D class
ModelElement2D Methods
For inherited methods see: class AllplanElement
ModelElement2D.__init__(*args)
Multiple method signatures:
__init__()
__init__(commonProp: CommonProperties, geometryObject: object)
__init__(commonProp: CommonProperties, patternCurveProp: PatternCurveProperties, endSymbol-
Prop: EndSymbolsProperties, geometryObject: object)
ModelElement2D.GetEndSymbolsProperties() → EndSymbolsProperties
ModelElement2D.GetPatternCurveProperties() → PatternCurveProperties
ModelElement2D.GetTransformationList() → list
19.1. Classes 61
allpy Documentation, Release 0.1.0
ModelElement2D.SetEndSymbolsProperties(endSymbolsProp: EndSymbolsProperties)
ModelElement2D.SetPatternCurveProperties(patternCurveProp: PatternCurveProperties)
ModelElement2D.SetTransformationList(transformationList: list)
ModelElement3D
class NemAll_Python_BasisElements.ModelElement3D(BasisElement)
ModelElement3D class
ModelElement3D Methods
For inherited methods see: class AllplanElement
ModelElement3D.__init__(*args)
Multiple method signatures:
__init__()
__init__(commonProp: CommonProperties, geometryObject: object)
__init__(commonProp: CommonProperties, BrepIsoLinesU: int, BrepIsoLinesV: int, geometryObject:
object)
__init__(commonProp: CommonProperties, textureDefinition: TextureDefinition, geometryObject:
object)
__init__(commonProp: CommonProperties, textureDefinition: TextureDefinition, BrepIsoLinesU: int,
BrepIsoLinesV: int, geometryObject: object)
__init__(commonProp: CommonProperties, textureDefinition: TextureDefinition, textureMapping:
TextureMapping, geometryObject: object)
__init__(commonProp: CommonProperties, textureDefinition: TextureDefinition, textureMapping:
TextureMapping, BrepIsoLinesU: int, BrepIsoLinesV: int, geometryObject: object)
ModelElement3D.GetTextureDefinition() → TextureDefinition
Get the texture definition
Return: Texture definition (surface filename)
ModelElement3D.GetTextureMapping() → TextureMapping
ModelElement3D.GetTransformationList() → list
ModelElement3D.SetTextureDefinition(textureDefinition: TextureDefinition)
ModelElement3D.SetTextureMapping(textureMapping: TextureMapping)
ModelElement3D.SetTransformationList(transformationList: list)
PatternCurveProperties
class NemAll_Python_BasisElements.PatternCurveProperties
PatternCurveProperties class
PatternCurveProperties Properties
PatternCurveProperties.AlignmentType
PatternCurveProperties.Height
PatternCurveProperties.IntersectionType
PatternCurveProperties.IsDrawReferenceCurve
PatternCurveProperties.IsLockedToCorner
PatternCurveProperties.IsMirrorPattern
PatternCurveProperties.IsScaleDependent
PatternCurveProperties.PatternID
PatternCurveProperties.Width
PatternCurveProperties Methods
PatternCurveProperties.__init__()
PatternCurveProperties.__eq__(other: PatternCurveProperties) → bool
PatternElement
class NemAll_Python_BasisElements.PatternElement(BasisElement)
PatternElement class
PatternElement Methods
For inherited methods see: class AllplanElement
PatternElement.__init__()
Multiple method signatures:
__init__()
__init__(commonProp: CommonProperties, patternProp: PatternProperties, geometryObject: ob-
ject)
PatternElement.GetPatternProperties() → PatternProperties
PatternElement.SetPatternProperties(PatternProp: PatternProperties)
PatternProperties
class NemAll_Python_BasisElements.PatternProperties
PatternProperties class
PatternProperties Properties
PatternProperties.BackgroundColor
PatternProperties.IsScaleDependent
PatternProperties.PatternID
PatternProperties.PlacementType
PatternProperties.ReferencePoint
PatternProperties.RotationAngle
PatternProperties.UseBackgroundColor
PatternProperties.UseReferencePoint
PatternProperties.XScalingFactor
PatternProperties.YScalingFactor
19.1. Classes 63
allpy Documentation, Release 0.1.0
PatternProperties Methods
PatternProperties.__init__()
PatternProperties.__eq__(other: PatternProperties) → bool
Symbol2DElement
class NemAll_Python_BasisElements.Symbol2DElement(BasisElement)
Symbol2DElement class
Symbol2DElement Methods
For inherited methods see: class AllplanElement
Symbol2DElement.__init__(*args)
Multiple method signatures:
__init__()
__init__(commonProp: CommonProperties, Symbol2DProp: Symbol2DProperties, geometryObject:
object)
Symbol2DElement.GetSymbol2DProperties() → Symbol2DProperties
Symbol2DElement.SetSymbol2DProperties(symbol2DProp: Symbol2DProperties)
Symbol2DProperties
class NemAll_Python_BasisElements.Symbol2DProperties
Symbol2DProperties class
Symbol2DProperties Properties
Symbol2DProperties.Height
Symbol2DProperties.IsScaleDependent
Symbol2DProperties.PrimaryPointNumber
Symbol2DProperties.RotationAngle
Symbol2DProperties.SecondaryPointNumber
Symbol2DProperties.SymbolID
Symbol2DProperties.Width
Symbol2DProperties Methods
Symbol2DProperties.__init__()
Symbol2DProperties.__eq__(other: Symbol2DProperties) → bool
Symbol3DElement
class NemAll_Python_BasisElements.Symbol3DElement(BasisElement)
Symbol3DElement class
Symbol3DElement Methods
For inherited methods see: class AllplanElement
Symbol3DElement.__init__(*args)
Multiple method signatures:
__init__()
__init__(commonProp: CommonProperties, Symbol3DProp: Symbol3DProperties, geometryObject:
object)
Symbol3DElement.GetSymbol3DProperties() → Symbol3DProperties
Symbol3DElement.SetSymbol3DProperties(symbol3DProp: Symbol3DProperties)
Symbol3DProperties
class NemAll_Python_BasisElements.Symbol3DProperties
Symbol3DProperties class
Symbol3DProperties Properties
Symbol3DProperties.ControlPointOffset
Symbol3DProperties.DescriptionText
Symbol3DProperties.Height
Symbol3DProperties.IsScaleDependent
Symbol3DProperties.IsStation
Symbol3DProperties.PrimaryPointNumber
Symbol3DProperties.RotationAngle
Symbol3DProperties.SecondaryPointNumber
Symbol3DProperties.StationCode
Symbol3DProperties.SymbolID
Symbol3DProperties.Width
Symbol3DProperties Methods
Symbol3DProperties.__init__()
Symbol3DProperties.__eq__(other: Symbol3DProperties) → bool
TextElement
class NemAll_Python_BasisElements.TextElement(BasisElement)
TextElement class
TextElement Methods
For inherited methods see: class AllplanElement
TextElement.__init__(*args)
Multiple method signatures:
__init__()
__init__(commonProp: CommonProperties, textProp: TextProperties, text: str, geometryObject: ob-
ject)
TextElement.GetText() → str
19.1. Classes 65
allpy Documentation, Release 0.1.0
TextElement.GetTextProperties() → TextProperties
TextElement.SetText(text: str)
TextElement.SetTextProperties(TextProp: TextProperties)
TextProperties
class NemAll_Python_BasisElements.TextProperties
TextProperties class
TextProperties Properties
TextProperties.Alignment
TextProperties.BackgroundColor
TextProperties.ColumnSlopeAngle
TextProperties.Expansion
TextProperties.Font
TextProperties.FontAngle
TextProperties.HasBackgroundColor
TextProperties.HasTextFrame
TextProperties.Height
TextProperties.IsScaleDependent
TextProperties.LineFeed
TextProperties.TextAngle
TextProperties.TextFrameColor
TextProperties.TextFramePen
TextProperties.TextFrameStroke
TextProperties.Type
TextProperties.Width
TextProperties Methods
TextProperties.__init__()
TextProperties.__eq__(other: TextProperties) → bool
TextureDefinition
class NemAll_Python_BasisElements.TextureDefinition(Boost.Python.instance)
TextureDefinition class
TextureDefinition Properties
TextureDefinition.SurfacePath
TextureDefinition Methods
TextureDefinition.__init__(*args)
Multiple method signatures:
__init__()
__init__(surfacePath: str)
Constructor
Parameters surfacePath – Surface path of texture definition
TextureDefinition.__eq__(other: TextureDefinition) → bool
TextureMapping
class NemAll_Python_BasisElements.TextureMapping(Boost.Python.instance)
TextureMapping class
TextureMapping Properties
TextureMapping.MappingAngle
TextureMapping.MappingType
TextureMapping.PhongAngle
TextureMapping.ReferenceEdge
TextureMapping.ReferenceFace
TextureMapping.UVCoordinates
TextureMapping.XOffset
TextureMapping.XScale
TextureMapping.YOffset
TextureMapping.YScale
TextureMapping Methods
TextureMapping.__init__(*args)
Multiple method signatures:
__init__()
__init__(mappingType: TextureMappingType, mappingAngle: float, scaleX: float, scaleY: float, off-
setX: float, offsetY: float, phongAngle: float, refFace: int, refEdge: int)
Constructor
Parameters
• mappingType – Mapping type
• mappingAngle – Mapping angle
• scaleX – Mapping scale in X-axis
• scaleY – Mapping scale in Y-axis
• offsetX – X offset
• offsetY – Y offset
• phongAngle – Angle for Phong light model
• refFace – Reference face
• refEdge – Reference edge
19.1. Classes 67
allpy Documentation, Release 0.1.0
ENums
CombinationType
class NemAll_Python_BasisElements.CombinationType
Combination types
CombinationType.eVx
CombinationType.eVy
CombinationType.eVz
ConsiderType
class NemAll_Python_BasisElements.ConsiderType(Boost.Python.enum)
consider types
ConsiderType.eConsiderAutomatic
ConsiderType.eConsiderCeilingOpening
ConsiderType.eConsiderCeilingRecess
ConsiderType.eConsiderCeilingSurface
ConsiderType.eConsiderDoorOpening
ConsiderType.eConsiderFloorSurface
ConsiderType.eConsiderNiche
ConsiderType.eConsiderNothing
ConsiderType.eConsiderRecess
ConsiderType.eConsiderWindowOpening
HeightDefinitionType
class NemAll_Python_BasisElements.HeightDefinitionType
Height definition types
HeightDefinitionType.eAverage
HeightDefinitionType.eComponent
HeightDefinitionType.eMacro
HeightDefinitionType.eNone
LinkType
class NemAll_Python_BasisElements.LinkType
Link types
LinkType.eLinkNothing
LinkType.eLinkToCeilingSurface
LinkType.eLinkToFloorSurface
LinkType.eLinkToRoofSlab
LinkType.eLinkToRoom
MacroSlideType
class NemAll_Python_BasisElements.MacroSlideType(Boost.Python.enum)
Macro slide types
MacroSlideType.eCode
MacroSlideType.eExtension
MacroSlideType.eGeometry
MacroSlideType.eReinforcement
MacroSlideType.eReport
MacroSlideType.eUndergroundCadaster
PatternCurveAlignment
class NemAll_Python_BasisElements.PatternCurveAlignment
Pattern curve alignment types of the pattern curve property
PatternCurveAlignment.eCenter
19.2. ENums 69
allpy Documentation, Release 0.1.0
PatternCurveAlignment.eLeft
PatternCurveAlignment.eRight
PatternCurveIntersectionType
class NemAll_Python_BasisElements.PatternCurveIntersectionType
Pattern intersection types of the pattern curve property
PatternCurveIntersectionType.eDisabled
PatternCurveIntersectionType.eJoint
PatternCurveIntersectionType.eMiter
PatternCurveIntersectionType.eSeamless
PlacementType
class NemAll_Python_BasisElements.PlacementType
Placement types of the pattern property
PlacementType.eFitting
PlacementType.eInsideFitting
PlacementType.eOutsideFitting
ShadingType
class NemAll_Python_BasisElements.ShadingType
Shading types of the filling property
ShadingType.eFromCenter
ShadingType.eFromCorner
ShadingType.eLinear
ShadingType.eRound
SubType
class NemAll_Python_BasisElements.SubType
Sub types of the element group property
SubType.eMultiLine3D
SubType.eMultiLine3D_Group
SubType.eUseNoSpecialSubType
TextAlignment
class NemAll_Python_BasisElements.TextAlignment
Text alignment types
TextAlignment.eLeftBottom
TextAlignment.eLeftMiddle
TextAlignment.eLeftTop
TextAlignment.eMiddleBottom
TextAlignment.eMiddleMiddle
TextAlignment.eMiddleTop
TextAlignment.eRightBottom
TextAlignment.eRightMiddle
TextAlignment.eRightTop
TextType
class NemAll_Python_BasisElements.TextType
Text types
TextType.eFormularText
TextType.eNormalText
TextType.eVariableText
TextureMappingType
class NemAll_Python_BasisElements.TextureMappingType
eCube from each side
eWall mainly from the front view
eRoof mainly from the top view
eGround only from the top view
eCylinder Cylindrical mapping
eSphere Spherical mapping
eUV UV mapping
TextureMappingType.eCube
TextureMappingType.eCylinder
TextureMappingType.eGround
TextureMappingType.eRoof
TextureMappingType.eSphere
TextureMappingType.eUV
TextureMappingType.eWall
19.2. ENums 71
allpy Documentation, Release 0.1.0
TransitionType
class NemAll_Python_BasisElements.TransitionType
Transition types of the filling property
TransitionType.eNoTransition
TransitionType.eOneColorTransition
TransitionType.eTwoColorTransition
VariantType
class NemAll_Python_BasisElements.VariantType
Variant types of the filling property
VariantType.eVariant1
VariantType.eVariant2
VariantType.eVariant3
VariantType.eVariant4
NemAll_Python_BasisElements.eFromCenter
NemAll_Python_BasisElements.eFromCorner
NemAll_Python_BasisElements.eGeometry
NemAll_Python_BasisElements.eInsideFitting
NemAll_Python_BasisElements.eJoint
NemAll_Python_BasisElements.eLeft
NemAll_Python_BasisElements.eLinear
NemAll_Python_BasisElements.eLinkNothing
NemAll_Python_BasisElements.eLinkToCeilingSurface
NemAll_Python_BasisElements.eLinkToFloorSurface
NemAll_Python_BasisElements.eLinkToRoofSlab
NemAll_Python_BasisElements.eLinkToRoom
NemAll_Python_BasisElements.eMacro
NemAll_Python_BasisElements.eMiter
NemAll_Python_BasisElements.eMultiLine3D
NemAll_Python_BasisElements.eMultiLine3D_Group
NemAll_Python_BasisElements.eNoTransition
NemAll_Python_BasisElements.eNone
NemAll_Python_BasisElements.eOneColorTransition
NemAll_Python_BasisElements.eOutsideFitting
NemAll_Python_BasisElements.eReinforcement
NemAll_Python_BasisElements.eReport
NemAll_Python_BasisElements.eRight
NemAll_Python_BasisElements.eRound
NemAll_Python_BasisElements.eSeamless
NemAll_Python_BasisElements.eTwoColorTransition
NemAll_Python_BasisElements.eUndergroundCadaste
NemAll_Python_BasisElements.eUseNoSpecialSubType
NemAll_Python_BasisElements.eVariant1
NemAll_Python_BasisElements.eVariant2
NemAll_Python_BasisElements.eVariant3
NemAll_Python_BasisElements.eVariant4
NemAll_Python_BasisElements.eVx
NemAll_Python_BasisElements.eVy
NemAll_Python_BasisElements.eVz
NemAll_Python_Geometry
Angle
class NemAll_Python_Geometry.Angle
Represents an angle.
Angle Properties
Angle.Deg
Get and set angle as float in degree:
angle.Deg = 90
Angle.Rad
Get and set angle as float in radians:
angle.Rad = math.pi/2
Angle Methods
Angle.__init__(angle=0: float):
Initializer method for constructing new Angle() objects:
75
allpy Documentation, Release 0.1.0
Angle.__float__() → float
‘Magic’ method for float casting support:
angle_in_rad_as_float = float(angle)
if self == other:
pass
if self != other:
pass
angle += value
Vector2D
class NemAll_Python_Geometry.Vector2D
Vector2D Properties
Vector2D.X
Get and set vector x direction value.
Vector2D.Y
Get and set vector y direction value.
Vector2D Methods
Vector2D.__init__(*args):
Initializer, multiple signatures:
Vector2D.__init__()
Initialize vector with x=0, y=0.
Vector2D.__init__(angle: Angle, length: float)
Create vector from the angle and from the length.
Parameters
• angle – base angle in radians
• length – length of vector (must be greater then zero).
Vector2D.__init__(x: float, y: float)
Initialize vector from single coordinates.
Vector2D.__init__(startPoint: Point2D, endPoint: Point2D)
Initialize vector from two Point2D objects.
Vector2D.__init__(endPoint: Point2D)
Initialize vector from one Point2D object. (startPoint = 0, 0)
Vector2D.__init__(vec: Vector3D)
Initialize vector from a Vector3D object, like Vector2D(vec.X, vec.Y)
Vector2D.Set(*args)
Set new value, multiple signatures:
Set(vec2: Vector2D)
Set(x: float, y: float)
Set(startPoint: Point2D, endPoint: Point2D)
Vector2D.GetCoords() → tuple
Get coordinates as 2-tuple (x, y).
Vector2D.Values() → list
Get coordinates as Python list [x, y].
Vector2D.GetAngle() → Angle
Get vector angle. Returns Angle in a range [0, 2*PI] (normalized 2pi).
Vector2D.GetAngleSigned() → Angle
Get vector angle. Returns Angle in a range [-PI..0..PI]
Vector2D.GetLength() → float
Get vector length.
Vector2D.IsZero() → bool
Check the coordinates (0.0, 0.0) (binary comparison)
Vector2D.Reverse() → Vector2D
Returns vector with reversed orientation.
Vector2D.Normalize(length: float=1)
Normalize vector. self = Vn(a1 * length / ||Va||, a2 * length / ||Va||)
Vector2D.Orthogonal(counterClockwise: bool) → Vector2D
Returns orthogonal vector. counterClockwise determines the orientation of orthogonal vector.
Vector2D.CrossProduct(vec: Vector2D) → Vector3D
Returns the Cross(vector) product. self = self x vec
Vector2D.DotProduct(vec: Vector2D) → float
Returns the Dot(scalar) product. Result = self . vec = self.X * self.Y + vec.X * vec.Y
Vector2D.__eq__(other: Vector2D) → bool
Returns True if self equals other, otherwise False.
Vector2D.__add__(vec: Vector2D) → Vector2D
Addition operator. Result = self + vec
Vector2D.__iadd__(vec: Vector2D) → self
Inplace addition operator. self = self + vec
Vector2D.__isub__(vec: Vector2D) → self
Inplace subtraction operator. self = self - vex
Vector2D.__mul__(argument)
Vector multiplication, multiple signature:
__mul__(vec2: Vector2D) → Vector3D
Vector2D x Vector2D: Cross (vector) product
__mul__(matrix: Matrix2D) → Point2D
Vector2D * Matrix2D: Matrix transformation.
__mul__(factor: float) → Vector2D
Vector2D * float: Multiply the vector by a factor (scalar multiplication).
Vector2D.__imul__(argument) → self
Inplace vector multiplication, multiple signatures:
__imul__(matrix: Matrix2D) → self
Vector2D * Matrix2D: Matrix transformation. self = self * matrix
__imul__(factor: float) → self
Vector2D * float: Multiply the vector by a factor (scalar multiplication). self = self * factor
Vector2D.__truediv__(divider: float) → Vector2D
Divide the vector by a factor (scalar multiplication). Result = self / divider
Vector2D.__idiv__(divider: float) → self
Divide the vector by a factor (scalar multiplication) inplace. self = self / divider
Vector3D
class NemAll_Python_Geometry.Vector3D
Vector3D Properties
Vector3D.X
Get and set vector x direction value.
Vector3D.Y
Get and set vector y direction value.
Vector3D.Z
Get and set vector z direction value.
Vector3D Methods
Vector3D.__init__(*args)
Initializer, multiple signatures:
__init__()
Initialize vector with x=0, y=0, z=0.
__init__(vec: Vector2D)
Initialize vector from a Vector2D, z coordinate is set to zero.
__init__(vec: Vector3D)
Initialize vector from a Vector3D.
__init__(x: float, y: float, z: float)
Initialize vector from single coordinates.
__init__(startPoint: Point3D, endPoint: Point3D)
Initialize vector from two Point3D objects.
__init__(endPoint: Point3D)
Initialize vector from one Point3D object. (startPoint = 0, 0, 0)
Vector3D.Set(*args)
Set new value, multiple signatures:
Set(vec3: Vector3D)
Set(x: float, y: float, z: float)
Set(startPoint: Point3D, endPoint: Point3D)
Vector3D.GetCoords() → tuple
Get coordinates as 3-tuple (x, y, z).
Vector3D.Values() → list
Get coordinates as Python list [x, y, z].
Vector3D.GetLength() → float
Get vector length.
Vector3D.GetLengthSquare() → float
Get vector length without square-root in calculation.
Vector3D.IsZero() → bool
Check the coordinates (0.0, 0.0, 0.0) (binary comparison)
Vector3D.Reverse() → Vector3D
Returns vector with reversed orientation.
Vector3D.Normal(vec: Vector3D) → Vector3D
Does the same as Cross(vector) product but does not change the operands. result = self x vec
Vector3D.Normalize(length:float=1.0)
Normalize vector. self = Vn(a1 * length / ||Va||, a2 * length / ||Va||)
Vector3D.Project(vec: Vector3D) → Vector3D
Projection operator. Result = <Vb,Va>/<Va,Va> . Va
Vector3D.CrossProduct(vec: Vector3D)
Cross(vector) product operator. self = self x vec
Vector3D.DotProduct(vec: Vector3D) → float
Dot(scalar) product. Result = self . vec = self.X * self.Y + vec.X * vec.Y
Vector3D.__eq__(other: Vector3D) → bool
Returns True if self equals other, oteherwise False.
Vector3D.__add__(vec: Vector3D) → Vector3D
Addition operator. Result = self + vec
Vector3D.__iadd__(vec: Vector3D) → self
Inplace addition operator. self = self + vec
Vector3D.__sub__(vec: Vector3D) → Vector3D
Subtraction operator. Result = self - vec
Vector3D.__isub__(vec: Vector3D) → self
Inplace subtraction operator. self = self - vec
Vector3D.__mul__(argument)
Multiple method signatures:
__mul__(vec3: Vector3D) → Vector3D
Cross (vector) product
__mul__(matrix: Matrix2D) → Point2D
Matrix2D transformation.
__mul__(matrix: Matrix3D) → Point3D
Matrix3D transformation.
__mul__(factor: float) → Vector3D
Multiply the vector by a factor (scalar multiplication).
Vector3D.__imul__(argument)
Inplace vector multiplication, multiple signatures:
__imul__(vec3: Vector3D) → self
Cross (vector) product. self = self x vec3
__imul__(matrix: Matrix2D) → self
Matrix2D transformation. self = self * matrix
__imul__(matrix: Matrix3D) → self
Matrix3D transformation. self = self * matrix
__imul__(factor: float) → self
Multiply the vector by a factor (scalar multiplication). self = self * factor
Vector3D.__idiv__(divider: float) → Vector3D
Divide the vector by a factor (scalar division)
Vector3D.__truediv__(devider: float) → Vector3D
Divide the vector by a factor (scalar division)
Point2D
class NemAll_Python_Geometry.Point2D
Point2D Properties
Point2D.X
Get and set point x coordinate value.
Point2D.Y
Get and set point y coordinate value.
Point2D Methods
Point2D.__init__(*args):
Initializer, multiple method signatures:
Point2D.__init__()
Initialize point with x=0, y=0.
Point2D.__init__(point: Point2D)
Initialize point with point.X, point.Y.
Point2D.__init__(point: Point3D)
Initialize point with point.X, point.Y, ignores point.Z.
Point2D.__init__(x: float, y: float)
Initialize point with x, y.
Point2D.__init__(refPoint: Point2D, point: Point2D)
Initialize point from point in local coordinate system. self = refPoint + point.
Point2D.Set(*args)
Multiple method signatures:
Set(point: Point2D)
Initialize from Point2D.
Set(x: float, y: float)
Initialize from x, y coordinates.
Point2D.GetCoords() → tuple
Get x, y coordinates as Python tuple.
Point2D.Values() → list
Get x, y coordinates as Python list.
Point2D.GetDistance(point: Point2D) → float
Get distance to point.
Point2D.IsZero() → bool
Check the coordinates (0, 0).
Point2D.__eq__(other: Point2D) → bool
Returns True if self equals other, otherwise False.
Point2D.__add__(argument) → Point2D
Multiple method signatures:
__add__(vec: Vector2D) → Point2D
Move the point by Vector2D.
__add__(point: Point2D) → Point2D
Move the point by vector (as Point2D).
Point3D
class NemAll_Python_Geometry.Point3D
Point3D Properties
Point3D.X
Get and set point x coordinate value.
Point3D.Y
Get and set point y coordinate value.
Point3D.Z
Get and set point z coordinate value.
Point3D Methods
Point3D.__init__(*args):
Initializer, multiple method signatures:
Point3D.__init__()
Initialize point with x=0, y=0, z=0.
Point3D.__init__(point: Point3D)
Initialize point with point.X, point.Y, point.Z
Point3D.__init__(point: Point2D)
Initialize point with point.X, point.Y, self.Z=0
Point3D.__init__(refPoint: Point3D, point: Point3D)
Initialize point from point in local coordinate system. self = refPoint + point
Point3D.__init__(x: float, y:float, z: float)
Initialize point with x, y, z.
Point3D.Set(*args)
Multiple method signatures:
Set(point: Point3D)
Initialize from Point3D.
Set(x: float, y: float, z: float)
Initialize from x, y, z coordinates.
Point3D.GetCoords() → tuple
Get x, y, z coordinates as Python tuple.
Point3D.Values() → list
Get x, y, z coordinates as Python list.
Point3D.GetDistance(point: Point3D) → float
Get distance to point.
Point3D.IsZero() → bool
Check the coordinates (0, 0, 0).
Point3D.__eq__(other: Point3D) → bool
Returns True if self equals other, otherwise False.
Point3D.__ne__(other: Point3D) → bool
Returns True if self NOT equals other, otherwise False.
Point3D.__add__(argument) → Point3D
Multiple method signatures:
__add__(vec: Vector3D) → Point3D
Move the point by Vector3D.
__add__(point: Point3D) → Point3D
Move the point by vector (as Point3D).
Point translation by point. Result = self + point
This is not standard math operation and is implemented only as practical use case for point moving in
Allplan. In this case point is treated like a Vector3D.
Point3D.__iadd__(point: Point3D) → self
Inplace point translation by Point3D. self = self + point
This is not standard math operation and is implemented only as practical use case for point moving in Allplan.
In this case point is treated like a Vector3D.
Point3D.__sub__(argument) → Point3D
Multiple method signatures:
__sub__(vec: Vector3D) → Point3D
Move the point by reversed Vector3D.
__sub__(point: Point3D) → Point3D
Point translation by negative point. Result = self - Point
This is not standard math operation and is implemented only as practical use case for point moving in
Allplan. In this case point is treated like a Vector3D.
Point3D.__isub__(point: Point3D) → Point3D
Point translation by negative Point3D. Result = self - point
This is not standard math operation and is implemented only as practical use case for point moving in Allplan.
In this case point is treated like a Vector3D.
Point3D.__mul__(argument) → Point3D
Multiple method signatures:
__mul__(matrix: Matrix:3D) → Point3D
Matrix transformation. Result = self * matrix.
__mul__(factor: float) → Point3D
Scale vector by factor. Result = self * factor.
Point3D.__truediv__(divider: float) → Point3D
Divide operator. Result = self.X / divider, self.Y / divider, self.Z / divider
Point3D.__idiv__(divider: float) → self
Divide operator. self.X = self.X / divider; self.Y = self.Y / divider; self.Z = self.Z / divider
GeometryEdge
class NemAll_Python_Geometry.GeometryEdge
Geometry edge. Identification of any edge via point indices, not via point coordinates.
GeometryEdge Properties
GeometryEdge.EndIndex
GeometryEdge.StartIndex
GeometryEdge Methods
GeometryEdge.__init__(*args)
Multiple method signatures:
__init__()
Default initializer.
__init__(startIndex: int, endIndex: int)
__init__(other: GeometryEdge)
Initialize object from other GeometryEdge object.
__init__(edge: Kanten_t)
Initialize object from Kanten_t object.
GeometryEdge.GetEndIndex() → int
GeometryEdge.GetStartIndex() -> int)
GeometryEdge.Set(edge: Kanten_t)
GeometryEdge.SetEndIndex(index: int)
GeometryEdge.SetStartIndex(index: int)
GeometryEdge.__eq__(other: GeometryEdge)
Returns True if self equals other.
Kanten_t
class NemAll_Python_Geometry.Kanten_t
old Allplan structur, anf/end begins with 1.
Kanten_t Methods
Kanten_t.__init__()
Default initializer.
Kanten_t Properties
Kanten_t.anf
Kanten_t.end
OrientedEdge
class NemAll_Python_Geometry.OrientedEdge
Identification of any edge via edge handle and orientation (positive, negative).
OrientedEdge Properties
OrientedEdge.EdgeHandle
OrientedEdge.Positive
OrientedEdge Methods
OrientedEdge.__init__(*args)
Multiple method signatures:
__init__()
__init__(edgeHandle: int, positiveOrientation: bool)
Parameters
• edgeHandle – edge handle
• positiveOrientation – True for positive, False for negative
__init__(orientedEdge: OrientedEdge)
Copy constructor
OrientedEdge.GetEdgeHandle() → int
OrientedEdge.HasPositiveOrientation() → bool
Returns True for positive orientation, False for negative orientation.
OrientedEdge.Set(*args)
Multiple method signatures:
Set(orientedEdge: OrientedEdge)
Initialize edge from old Allplan structure.
Set(edgeHandle: int, positiveOrientation: bool)
OrientedEdge.SetEdgeHandle(edgeHandle: int)
OrientedEdge.SetOrientation(positiveOrientation: bool)
OrientedEdge.__eq__(other: OrientedEdge) → bool
Returns True if self equals other.
Matrix2D
class NemAll_Python_Geometry.Matrix2D
2D transformation matrix.
Matrix data organization in memory:[0 ... 8] indexes of array values, index [0, 1] and [3, 4] for rotation and
scaling and index [6, 7] for translation.
Index Col0 Col1 Col2
Row0 0 1 2
Row1 3 4 5
Row2 6 7 8
All operations are correct only in geometry calculation context and can not be used for calculating with regular
4x4 matrix.
Matrix2D.__init__()
Multiple method signatures:
__init__()
Initialize matrix with identity matrix.
__init__(matrix)
Initialize with matrix.
Matrix2D.__getitem__(index:int) → float
Get matrix element at specified index. This method throws an Exception when index is out of range.
Matrix2D.SetValue(index: int, value: float) → bool
Set the matrix element at a specified position. Use this method when you don’t want to catch exception by
[] - operator (__getitem__). Index is the position index in range [0 ... 8]. Returns True when operation was
successful (index is not out of range), otherwise False.
Matrix2D.AddDimension() → Matrix3D
From this Matrix2D object create a Matrix3D object.
Matrix2D.Determinant() → float
Calculate determinant.
Matrix2D.IsIdentity() → bool
Returns True when matrix is an identity matrix, otherwise False.
Matrix2D.SetIdentity()
Set identity matrix.
Matrix2D.Multiply(matrix: Matrix2D) → self
Inplace matrix multiplication.
Matrix2D.Reverse() → bool
Reverse matrix. This method provide geometrical inverse matrix and can not be used with regular inverse 4x4
matrix calculations. Returns True when operation was successful, otherwise False.
Matrix2D.SetReflection(axis: Axis2D)
Set matrix values only with reflection about axis.
Matrix2D.Reflection(axis: Axis2D)
Reflection across a axis of given angle.
Matrix2D.SetRotation(point:Point2D, angle:Angle)
Set matrix only with values for rotation about point and angle.
Matrix2D.Rotation(point: Point2D, angle:Angle)
Set matrix values to provide a rotation transformation about a given point and angle.
Matrix2D.SetScaling(scaleX:float, scaleY:float)
Initialize matrix only with values for scaling by scaleX and scaleY.
Matrix2D.Scaling(scaleX:float, scaleY:float)
Set matrix values to provide a scaling transformation about scaleX and scaleY.
Matrix2D.SetTranslation(vec: Vector2D)
Set matrix only with values for translation by vec.
Matrix2D.Translate(vec:Vector2D)
Set matrix values to provide a translation by vec.
Matrix2D.__add__(matrix: Matrix2D) → Matrix2D
Matrix addition,
Matrix2D.__iadd__(matrix: Matrix2D) → self
Inplace matrix addition.
Matrix2D.__sub__(matrix: Matrix2D) → Matrix2D
Matrix subtraction.
Matrix2D.__isub__(matrix: Matrix2D) → self
Inplace matrix subtraction.
Matrix2D.__mul__(matrix: Matrix2D) → Matrix2D
Matrix multiplication.
Matrix2D.__imul__(matrix: Matrix2D) → self
Inplace matrix multiplication.
Matrix3D
class NemAll_Python_Geometry.Matrix3D
Matrix data organization in memory: [0 ... 15] indexes of array values, index [0, 1, 2], [4, 5, 6] and [8, 9, 10] for
rotation, scaling and shrinking, [12, 13, 14] for translation.
Index Col0 Col1 Col2 Col3
Row0 0 1 2 3
Row1 4 5 6 7
Row2 8 9 10 11
Row3 12 13 14 15
All operations are correct only in geometry calculation context and can not be used for calculating with regular
4x4 matrix.
Matrix3D.__init__(*args)
Multiple method signatures:
__init__()
Initialize matrix with identity matrix.
__init__(proj: eProjectionMatrixType)
Initialize matrix for given projection type.
__init__(matrix: Matrix3D)
Initialize with a Matrix3D object.
__init__(v0, v1, ..., v14, v15)
Initialize matrix with explicit values, requires 16 float values in index order.
__init__(values: list)
Initialize matrix with explicit values, requires 16 float values in index order in a Python list.
Matrix3D.SetValues(v0, v1, ..., v14, v15)
Sets explicit each matrix-element, requires 16 float values in index order.
Matrix3D.SetValue(index:int, value:float) → bool
Set matrix element at specified index. Returns True when operation successful (index is not out of range),
otherwise False.
Matrix3D.SetIdentity()
Set identity matrix.
Matrix3D.IsIdentity() → bool
Returns True when matrix is an identity matrix, otherwise False.
Matrix3D.GetVectorX() → Vector3D
Get vector X, values at index positions [0, 1, 2].
Matrix3D.GetVectorY() → Vector3D
Get vector Y, values at index positions [4, 5, 6].
Matrix3D.GetVectorZ() → Vector3D
Get vector Z, values at index positions [8, 9, 10].
Matrix3D.ReduceZDimension() → Matrix2D
Create a 2D matrix from this 3D matrix, returns a Matrix2D initialized with values from following index
positions: [0, 1, 3], [4, 5, 7], [12, 13, 15].
Matrix3D.GetScaleX() → float
Matrix3D.GetScaleY() → float
Matrix3D.GetScaleZ() → float
Matrix3D.GetScaling() → tuple
Get scaling factors from matrix. Returns a 3-tuple (scaleX, scaleY, scaleZ).
Matrix3D.GetTranslationVector() → Vector3D
Get translation vector of matrix. Returns Vector3D initialized with values from index positions [12, 13, 14].
Matrix3D.Determinant() → float
Calculate determinant.
Matrix3D.GaussInvert() → bool
Calculate inverse matrix by Gauss inplace. Returns True when operation was successful, otherwise False.
Matrix3D.LaplaceTransform()
Calculate transformation matrix by Laplace inplace.
Matrix3D.Reverse() → bool
Reverse matrix. This method provide geometrical inverse matrix and can not be used with regular inverse 4x4
matrix calculations. Returns True when operation was successful, otherwise False.
Matrix3D.Transpose()
Transpose matrix. All transform-services multiply transformation-matrix from the right side: If you need the
result as it would be multiplication from the left side you need the transposed Matrix.
Matrix3D.Multiply(matrix: Matrix3D) → self
Inplace matrix multiplication.
Matrix3D.Reflection(plane: Plane3D)
Reflection across a plane.
Matrix3D.SetReflection(plane: Plane3D)
Set values of matrix only with reflection.
Matrix3D.SetProjection(proj: eProjectionMatrixType)
Set values of matrix only for the required projection.
Matrix3D.Rotation(line: Line3D, angle:Angle) → bool
Set values of matrix for given rotation operation, line is the axis of rotation. Returns True when successful,
otherwise False.
Matrix3D.SetRotation(line: Line3D, angle:Angle) → bool
Set values of matrix only for given rotation operation, line is the axis of rotation. Returns True when successful,
otherwise False.
Matrix3D.Scaling(scaleX: float, scaleY: float, scaleZ: float)
Set values of matrix for given scaling operation.
Matrix3D.SetScaling(scaleX: float, scaleY: float, scaleZ: float)
Set values of matrix only for given scaling operation.
Matrix3D.Translate(vec: Vector3D)
Set values of matrix for given translation operation.
Matrix3D.SetTranslate(vec: Vector3D)
Set values of matrix only for given translation operation.
Matrix3D.__getitem__(index: int) → float
Get the matrix element at a specified index position.
Matrix3D.__add__(matrix: Matrix3D) → Matrix3D
Matrix addition.
Matrix3D.__iadd__(matrix: Matrix3D) → self
Inplace matrix addition.
Matrix3D.__sub__(matrix: Matrix3D) → Matrix3D
Matrix subtraction.
Matrix3D.__isub__(matrix: Matrix3D) → self
Inplace matrix subtraction.
Matrix3D.__mul__(matrix: Matrix3D) → Matrix3D
Matrix multiplication.
Matrix3D.__imul__(matrix: Matrix3D) → self
Inplace matrix multiplication.
ApproximationSettings
class NemAll_Python_Geometry.ApproximationSettings
Class holding approximation options.
ApproximationSettings.__init__(*args)
Multiple method signatures:
__init__(oType: eApproximationSettingsType, value: float)
Other members will be set to 0. Types can be found in GeometryEnums.h
__init__(options: ApproximationSettings)
Copy constructor.
ApproximationSettings.GetDensity() → float
ApproximationSettings.GetMaxAngle() → Angle
ApproximationSettings.GetMaxDistance() → float
ApproximationSettings.GetMaxLength() → float
ApproximationSettings.GetMinLength() → float
ApproximationSettings.GetSegmentation() → int
ApproximationSettings.GetType() → eApproximationSettingsType
ApproximationSettings.IsBRepTesselation() → bool
ApproximationSettings.IsMaxDistance() → bool
ApproximationSettings.IsMaxLength(...) → bool
ApproximationSettings.IsSegmentation(...) → bool
ApproximationSettings.SetBRepTesselation(density: float, maxAngle:Angle, minLength:float,
maxLength:float)
Set all settings for BRep3D tesselation.
ApproximationSettings.SetMaxDistance(maxDistance: float)
ApproximationSettings.SetMaxLength(maxLength: float)
ApproximationSettings.SetSegmentation(segmentation: int)
ApproximationSettings.__eq__(other: ApproximationSettings) → bool
Returns True if self equals other, otherwise False.
ApproximationSettings.__ne__(comp: ApproximationSettings)
Returns True if self NOT equals other, otherwise False.
Axis2D
class NemAll_Python_Geometry.Axis2D
** Axis2D Properties**
Axis2D.AxisPoint
Axis2D.AxisRefPoint
Axis2D.AxisRelPoint
Axis2D.AxisVector
Axis3D Methods
Axis2D.__init__(*args)
Multiple method signatures:
__init__()
Default initializer.
__init__(axis: Axis2D)
Initialize from Axis2D object.
__init__(axisPoint: Point2D, vector: Vector2D)
Reference point is initialized to (0, 0), axisPoint in WCS.
__init__(refPoint: Point2D, axisPoint: Point2D, vector: Vector2D)
axisPoint in local coordinate system.
AxisPlacement2D
class NemAll_Python_Geometry.AxisPlacement2D
Placement is given by reference point and direction vector of local x-axis.
AxisPlacement2D Properties
AxisPlacement2D.Direction
AxisPlacement2D.RefPoint
AxisPlacement2D Methods
AxisPlacement2D.__init__(*args)
__init__()
Default initializer.
__init__(placement: AxisPlacement2D)
Initialize from AxisPlacement2D object.
__init__(refPoint: Point2D, dirVector: Vector2D)
Initializer which fully constructs the element.
AxisPlacement2D.GetDirection() → Vector2D
AxisPlacement2D.GetRefPoint() → Point2D
AxisPlacement2D.GetYDirection() → Vector2D
Get direction of local y-axis.
AxisPlacement2D.IsValid() → bool
Returns True if the placement is valid, otherwise False.
AxisPlacement2D.SetDirection(vec: Vector2D)
AxisPlacement2D.SetRefPoint(point: Point2D)
AxisPlacement2D.__eq__(other: AxisPlacement2D) → bool
Returns True if self equals other, otherwise False.
Axis3D
class NemAll_Python_Geometry.Axis3D
Axis3D Properties
Axis3D.AxisPoint
Axis3D.AxisRefPoint
Axis3D.AxisRelPoint
Axis3D.AxisVector
Axis3D Methods
Axis3D.__init__(*args)
Multiple method signatures:
__init__()
Default initializer.
__init__(axis: Axis3D)
Initialize from Axis3D object.
__init__(axisPoint: Point3D, vector: Vector3D)
Reference point is initialized to (0, 0, 0), axisPoint in WCS.
__init__(refPoint: Point3D, axisPoint: Point3D, vector: Vector3D)
axisPoint in local coordinate system.
__init__(line: Line3D)
Initialize from Line3D object.
Axis3D.GetAxisPoint() → Point3D
Get first axis point in world coordinate system.
Axis3D.GetAxisPoint2() → Point3D
Get second axis point in world coordinate system.
Axis3D.GetAxisRelPoint() → Point3D
Get first axis point in local coordinate system.
Axis3D.GetAxisRelPoint2() → Point3D
Get second axis point in local coordinate system
Axis3D.GetRefPoint() → Point3D
Axis3D.GetVector() → Vector3D
Axis3D.Set(*args)
Multiple method signatures:
Set(axis: Axis3D)
Set values from Axis3D object.
Set(refPoint: Point3D, axisPoint: Point3D, vector: Vector3D)
axisPoint in local coordinate system.
Axis3D.SetAxisPoint(point: Point3D)
Axis3D.SetAxisRelPoint(point: Point3D)
Axis3D.SetRefPoint(point: Point3D)
Axis3D.SetVector(vec: Vector3D)
Axis3D.__eq__(other: Axis3D) → bool
Returns True if self equals other, otherwise False.
AxisPlacement3D
class NemAll_Python_Geometry.AxisPlacement3D
Placement is given by Origin and 2 direction vectors - local x-axis and local z-axis, y-axis is computed on
demand.
AxisPlacement3D Properties
Data descriptors defined here:
AxisPlacement3D.Origin
AxisPlacement3D.XDirection
AxisPlacement3D.ZDirection
AxisPlacement3D Methods
AxisPlacement3D.__init__(*args)
Multiple method signatures:
__init__()
Default Initializer
__init__(placement: AxisPlacement3D)
Initialize from AxisPlacement3D object.
__init__(refPoint: Point3D)
Initialize with only reference point.
__init__(refPoint: Point3D, xVec: Vector3D, zVec: Vector3D)
initialize which fully constructs the element.
__init__(matrix: Matrix3D)
initialize from Matrix3D.
AxisPlacement3D.CalcGlobalPoint(point: Point3D) → Point3D
Calculate global point from local coordinate system.
AxisPlacement3D.CalcLocalPoint(point: Point3D) → Point3D
Calculate local point from global point.
AxisPlacement3D.GetOrigin() → Point3D
AxisPlacement3D.GetRotationMatrix() → Matrix3D
AxisPlacement3D.GetTransformationMatrix() → Matrix3D
AxisPlacement3D.GetXDirection() → Vector3D
AxisPlacement3D.GetYDirection() → Vector3D
AxisPlacement3D.GetZDirection() → Vector3D
AxisPlacement3D.IsValid() → bool
Returns True if this is a valid placement, otherwise False.
AxisPlacement3D.RotateAroundLocalZAxis()
Rotate self around local Z-axis.
AxisPlacement3D.Set(origin: Point3D, xVec: Vector3D, zVec: Vector3D)
AxisPlacement3D.SetOrigin(point: Point3D)
AxisPlacement3D.SetXDirection(vec: Vector3D)
AxisPlacement3D.SetZDirection(vec: Vector3D)
AxisPlacement3D.__eq__(other: AxisPlacement3D) → bool
Returns true if self equals other, otherwise False.
List Classes
class NemAll_Python_Geometry.AbstractList
All <Type>List objects implementing the methods of AbstractList, but AbstractList is not a real de-
fined class, it is just a helping construct in this documentation introduced by me. Negative indexing is supported,
index -1 references the last element, -2 the second last and so on. List slicing is also supported.
AbstractList.__init__()
Default initializer, creates an empty list.
AbstractList.__contains__(item) → bool
Returns True if list contains item, otherwise False
AbstractList.__delitem__(index)
Delete item at index from list.
AbstractList.__getitem__(index) → object
Get item at index. Raises IndexError if index is out of range.
AbstractList.__iter__() → iterator
Returns an iterator over all items in list, usage:
AbstractList.__len__() → int
Returns count of items in list.
AbstractList.__setitem__(index, item)
Set item at index. Raises IndexError if index is out of range.
AbstractList.append(item)
Append one item to this list.
AbstractList.extend(items: list)
Append all items to this list.
For the most types is a list type defined like Line2DList, here are only some useful types, because they are used as
argument and return types.
class NemAll_Python_Geometry.Vector2DList(AbstractList)
class NemAll_Python_Geometry.Vector3DList(AbstractList)
class NemAll_Python_Geometry.Point2DList(AbstractList)
class NemAll_Python_Geometry.Point3DList(AbstractList)
Path
class NemAll_Python_Geometry.Path
Path Methods
Path.Clear()
Clear all geometries from path
Path.Count() → int
Count of geometries stored in path.
Path.IsEmpty() → bool
Path.Remove(index: int) → int
Remove geometry at the specified index, returns an error code.
Path.Reverse()
Reverse orientation of the PathElement.
PolyPoints2D
class NemAll_Python_Geometry.PolyPoints2D
PolyPoints2D Properties
PolyPoints2D.EndPoint
PolyPoints2D.EndRelPoint
PolyPoints2D.RefPoint
PolyPoints2D.StartPoint
PolyPoints2D.StartRelPoint
PolyPoints2D Methods
PolyPoints2D.Clear()
PolyPoints2D.Count() → int
PolyPoints2D.Empty() → bool
PolyPoints2D.EqualRef(other: PolyPoints2D)) → bool
Returns True if self equals other.
PolyPoints2D.GetEndPoint() → Point2D
PolyPoints2D.GetEndRelPoint() → Point2D
PolyPoints2D.GetLastPoint() → Point2D
PolyPoints2D.GetPoint(index: int) → Point2D
PolyPoints2D.GetPointIndex(point: Point2D) → tuple
Returns (True if a point was found, Found index)
PolyPoints2D.GetPointIndexes(point: Point2D) → tuple
Get indexes of the given point, in case that several points in the spline will have the same coordinates.
Returns (True if at least one point was found, Found indexes)
PolyPoints2D.GetRefPoint() → Point2D
PolyPoints2D.GetRelPoint(index: int) → Point2D
Get point at index in local coordinate system.
PolyPoints2D.GetStartPoint() → Point2D
PolyPoints2D.GetStartRelPoint() → Point2D
PolyPoints2D.Insert(*args) → bool
Multiple method signatures:
Insert(polyPoints: PolyPoints2D, index: int) → bool
Insert vector of points at specific index, returns True when operation was successful.
Insert(point: Point2D, index: int) → bool
Insert point at specific index, returns True when operation was successful.
PolyPoints2D.Remove(index: int) → bool
Remove point at specific index, returns True when operation was successful.
PolyPoints2D.RemoveLastPoint() → bool
Remove the last point, returns True when operation was successful.
PolyPoints2D.Reserve(newCount: int)
Reallocate container capacity for newCount points.
PolyPoints2D.Resize(newSize: int)
Specifies a new size for the points vector.
PolyPoints2D.Reverse()
Reverse the point order inplace.
PolyPoints2D.SetEndPoint(point: Point2D)
PolyPoints2D.SetPoint(point: Point2D, index: int)
Set point at given index.
PolyPoints2D.SetRefPoint(refPoint: Point2D)
PolyPoints2D.SetRelPoint(point: Point2D, index: int)
Set point at given index in relative coordinate system.
PolyPoints2D.SetStartPoint(point: Point2D)
PolyPoints2D.ToLineChain() → Point2DList
Get polyline as list of Line2D objects.
PolyPoints2D.__getitem__(index: index) → Point2D
Get point at position from index. Used world coordinates.
PolyPoints2D.__iadd__(point: Point2D) → self
Add point in world coordinates inplace.
PolyPoints3D
class NemAll_Python_Geometry.PolyPoints3D
PolyPoints3D Properties
PolyPoints3D.EndPoint
PolyPoints3D.EndRelPoint
PolyPoints3D.RefPoint
PolyPoints3D.StartPoint
PolyPoints3D.StartRelPoint
PolyPoints3D Methods
PolyPoints3D.Clear()
Remove all points from vector.
PolyPoints3D.Count() → int
PolyPoints3D.Empty() → bool
PolyPoints3D.EqualRef(other: PolyPoints3D) → bool
Returns True if self equals other.
PolyPoints3D.GetEndPoint() → Point3D
PolyPoints3D.GetEndRelPoint() → Point3D
PolyPoints3D.GetLastPoint() → Point3D
PolyPoints3D.GetPoint(index: int) → Point3D
Get point at index in world coordinate system.
PolyPoints3D.GetPointIndex(point: Point3D) → tuple
Get index of the given point.
Returns tuple (True if a point was found, Found index)
PolyPoints3D.GetPointIndexes(point: Point3D) → tuple
Get indexes of the given point, in case that several points in the spline will have the same coordinates.
Returns tuple (True if at least one point was found, Found indexes)
PolyPoints3D.GetRefPoint() → Point3D
PolyPoints3D.GetRelPoint(index: int) → Point3D
Get point at index in local coordinate system.
PolyPoints3D.GetStartPoint() → Point3D
PolyPoints3D.GetStartRelPoint() → Point3D
PolyPoints3D.Insert(*args)
Multiple method signatures:
Insert(polyPoints: PolyPoints3D, index: int) → bool
Insert vector of points at specific index, returns True when operation was successful.
PolygonalArea
class NemAll_Python_Geometry.PolygonalArea
PolygonalArea Methods
PolygonalArea.AppendEdge(edge: GeometryEdge) → object
Append edge (appendPolygonEdge).
Returns Error code
PolygonalArea.GetComponentsCount() → int
PolygonalArea.GetEdge(index: int) → tuple
Get edge at index.
Returns tuple (Error code, edge of polygon)
PolygonalArea.GetEdges() → tuple
Returns (Error code, vector of all edges)
PolygonalArea.GetEdgesCount() → int
2D Object Classes
Arc2D
class NemAll_Python_Geometry.Arc2D
Arc2D could be a circular or elliptical arc. All angles are given as central angles. In case of an elliptical arc the
ellipse angle and the central angle do not correspond. All angles are normalized to the range [-PI ... 2PI]. The winding
direction of the arc could either be in clockwise or in counterclockwise direction.
Arc2D Properties
Arc2D.AxisAngle
Get and set the axis angle as property
Arc2D.Center
Get and set the center point as property
Arc2D.CenterRel
Get and set the center point in the relative coordinate system as property
Arc2D.CounterClockwise
Get and set the counter clockwise flag as property
Arc2D.DeltaAngle
Get the delta angle as property
Arc2D.EndAngle
Get and set the end angle as property
Arc2D.EndPoint
Get and set the end point as property
Arc2D.EndRelPoint
Get the end point in the relative coordinate system as property
Arc2D.MajorRadius
Get and set the major radius as property
Arc2D.MinorRadius
Get and set the minor radius as property
Arc2D.RefPoint
Get and set the reference point as property
Arc2D.StartAngle
Get and set the start angle as property
Arc2D.StartPoint
Get and set the start point as property
Arc2D.StartRelPoint
Get the start point in the relative coordinate system as property
Arc2D Methods
Arc2D.__init__(*args)
Initializer variants for constructing new Arc2D objects:
Arc2D.GetEndPoint() → Point2D
Get end point in world coordinate system.
Arc2D.GetEndRelPoint() → Point2D
Get end point in relative coordinate system
Arc2D.GetEndTangent() → Vector2D
Get tangent vector (unit vector) at the end point.
Arc2D.GetMajorRadius() → float
Arc2D.GetMinorRadius() → float
Arc2D.GetPoint(angle: Angle) → Point2D
Get point on arc in world coordinate system. Angle is the central angle of the point.
Arc2D.GetRefPoint() → Point2D
Get reference point in world coordinate system. The reference point is center of the local coordinate system.
Arc2D.GetStartAngle() → Angle
Arc2D.GetStartPoint() → Point2D
Get start point in world coordinate system.
Arc2D.GetStartRelPoint() → Point2D
Get start point in relative coordinate system.
Arc2D.GetStartTangent() → Vector2D
Get tangent vector (unit vector) at the start point of arc.
Arc2D.IsAngleOnArc(angle: Angle) → bool
Returns true if the given angle lies on the arc, otherwise False.
Arc2D.IsCircle() → bool
Returns true if ellipse is circle (major radius equals minor radius), otherwise False
Arc2D.IsClosed() → bool
Returns True if arc is closed, otherwise False.
Arc2D.IsCounterClockwise() → bool
Returns True if winding direction is counterclockwise, otherwise False.
Arc2D.Reverse()
Reverse of current arc. Swap start angle and end angle and flips orientation.
Arc2D.SetAxisAngle(angle: Angle)
Set the angle of the major axis.
Arc2D.SetCenter(center. Point2D)
Arc2D.SetCenterRel(center: Point2D)
Set center point in local coordinate system.
Arc2D.SetCounterClockwise(counterclockwise: bool)
Set the winding direction of the arc. True for counter clockwise, else False.
Arc2D.SetEndAngle(angle: Angle)
Arc2D.SetEndPoint(endpoint: Point2D)
Set the end point in world coordinate system
Arc2D.SetMajorRadius(radius: float)
Arc2D.SetMinorRadius(radius: float)
Arc2D.SetRefPoint(refPoint: Point2D)
Set reference point, center of the local coordinate system.
Arc2D.SetStartAngle(angle: Angle)
Arc2D.SetStartPoint(startPoint: Point2D)
Set the start point in world coordinate system.
Arc2D.Supplement()
Convert to supplementary arc. Orientation of arc will not be changed.
Arc2D.__eq__(other: Arc2D) → bool
Returns True if self equals other, otherwise False.
Arc2D.__mul__(matrix: Matrix2D) → Arc2D
Matrix transformation.
BSpline2D
class NemAll_Python_Geometry.BSpline2D(PolyPoints2D)
Class for 2D (non uniform, rational) B-spline geometry. Needs type NemAll_Python_Utility.
VecDoubleList.
BSpline2D Properties
For inherited properties see: PolyPoints2D
BSpline2D.Degree
BSpline2D.Knots
BSpline2D.Weights
BSpline2D Methods
For inherited methods see: PolyPoints2D
BSpline2D.__init__(*args)
Multiple method signatures:
__init__()
Default initializer.
__init__(points: Point2DList, weights: VecDoubleList, knots: VecDoubleList, degree: int)
Full specified initialisation.
__init__(other: BSpline2D)
Initialize from other BSpline2D object.
BSpline2D.Clear()
Clear data, getting invalid state.
BSpline2D.CreateLine2D(line: Line2D) → BSpline2D
Create BSpline2D object from Line2D.
BSpline2D.Get() → tuple
Returns (list of points, list of weights, list of knots, degree)
BSpline2D.GetDegree() → int
BSpline2D.GetKnots() → VecDoubleList
BSpline2D.GetWeights() → VecDoubleList
Get control points weights
BSpline2D.IsClosed() → bool
BSpline2D.IsRational() → bool
BSpline2D.IsValid() → bool
BSpline2D.Reverse()
Reverse current BSpline by PolyPoints2D.Reverse() and swapping tangents.
BSpline2D.Set(points: Point2DList, weights: VecDoubleList, knots: VecDoubleList, degree: int)
BSpline2D.SetDegree(degree: int)
BSpline2D.SetKnots(knots: VecDoubleList)
BSpline2D.SetWeights(weights: VecDoubleList)
BSpline2D.__eq__(other: BSpline2D) → bool
Returns True if self equals other, otherwise False.
BoundingBox2D
class NemAll_Python_Geometry.BoundingBox2D
Representation of a 2D bounding box.
BoundingBox2D Properties
BoundingBox2D.Angle
BoundingBox2D.Max
BoundingBox2D.Min
BoundingBox2D Methods
BoundingBox2D.__init__(*args)
Multiple method signatures:
__init__()
Default initializer. Set min point to (DBL_MAX, DBL_MAX) and max point to (-DBL_MAX, -
DBL_MAX), angle is 0.
__init__(angle: Angle)
Set angle and set min point to (DBL_MAX, DBL_MAX) and max point to (-DBL_MAX, -DBL_MAX).
__init__(min: Point2D, max: Point2D, angle: Angle)
Full specified initialisation.
__init__(bbox: BoundingBox2D)
Initialize from other BoundingBox2D object.
__init__(minMax: MinMax2D)
Initialize from other MinMax2D object.
BoundingBox2D.Deflate(*args)
Multiple method signatures:
Deflate(x: float, y: float)
Deflate in x and y axis.
Deflate(size. float)
Deflate in x, y axis concurrently.
BoundingBox2D.Get() → tuple
Get minimum point, maximum point and angle
Returns (minimum point in local coordinate system, maximum point in local coordinate system,
direction of X axis of new coordinate system)
BoundingBox2D.GetAngle() → Angle
Get direction of X axis of new coordinate system.
BoundingBox2D.GetBoxPoint(t: eBoxPoint) → Point2D
Get world point of a dedicated location of the box.
BoundingBox2D.GetCenter() → Point2D
Get box center point in local coordinate system.
BoundingBox2D.GetCenterPoint() → Point2D
Get world point at center of box.
BoundingBox2D.GetHeight() → float
Get height of box in local system.
BoundingBox2D.GetMax() → Point2D
Get maximum point in local coordinate system.
BoundingBox2D.GetMaxPoint() → Point2D
Get world point at maximum of box.
BoundingBox2D.GetMin() → Point2D
Get minimum point in local coordinate system.
BoundingBox2D.GetMinPoint() → Point2D
Get world point at maximum of box
BoundingBox2D.GetWidth() → float
Get width of box in local system
BoundingBox2D.Inflate(*args)
Multiple method signatures:
Inflate(x: float, y: float)
Inflate in x and y axis.
Inflate(size: float)
Inflate in x, y axis concurrently.
BoundingBox2D.IsContaining(*args) → bool
Multiple method signatures:
IsContaining(point: Point2D) → bool
Returns True if point inside this bounding box, otherwise False.
IsContaining(bbox: BoundingBox2D) → bool
Returns True if bbox is inside this bounding box, otherwise False.
IsContaining(minmax: MinMax2D) → bool
Returns True if minmax box is inside this bounding box, otherwise False.
BoundingBox2D.IsValid() → bool
BoundingBox2D.Overlaps(*args) → bool
Multiple method signatures:
Overlaps(bbox: BoundingBox2D) → bool
Returns True if bbox does overlap this bounding box, otherwise False.
Overlaps(minmax: MinMax2D) → bool
Returns True if minmax box does overlap this bounding box, otherwise False.
BoundingBox2D.Reset(angle: Angle)
Reset bounding box and set initial angle. Set min point to (DBL_MAX, DBL_MAX) and max point to (-
DBL_MAX, -DBL_MAX).
BoundingBox2D.Set(min: Point2D, max: Point2D, angle: Angle)
BoundingBox2D.SetAngle(angle: Angle)
Set direction of X axis of new coordinate system.
BoundingBox2D.SetHeight(height: float)
Set height of box in local system. Computed from Min point.
BoundingBox2D.SetMax(max: Point2D)
Set maximum point in local coordinate system.
BoundingBox2D.SetMin(min: Point2D)
Set minimum point in local coordinate system.
BoundingBox2D.SetWidth(width: float)
Set width of box in local system. Computed from Min point.
BoundingBox2D.__add__(*args) → BoundingBox2D
Multiple method signatures:
__add__(bbox: BoundingBox2D) → BoundingBox2D
Expands this bounding box by the box given in parameter bbox.
__add__(minmax: MinMax2D) → BoundingBox2D
Expands the bounding box by the MinMax2D box given in parameter minmax.
BoundingBox2D.__eq__(other: BoundingBox2D) → bool
Returns true if self equals other, otherwise False.
BoundingBox2D.__getitem__(index: int) → Point2D
Get the corners of bounding box.
Parameters index – corner index: 0 = left bottom, 1 = right bottom, 2 = right top, 3 = left top
BoundingBox2D.__iadd__(*args) → self
Multiple method signatures:
__iadd__(bbox: BoundingBox2D) → self
Expands self by the box given in parameter bbox inplace.
__iadd__(minmax: MinMax2D) → self
Expands self by the box given in parameter minmax inplace.
__iadd__(point: Point2D) → self
Expands self by point inplace.
ClosedArea2D
This is (maybe?) just a helper construction and do not really show up in the 2D model space.
class NemAll_Python_Geometry.ClosedArea2D
Representation class for 2D geometry closed (path bounded) area.
ClosedArea2D Properties
ClosedArea2D.InnerList
Get the inner path list as property
ClosedArea2D.OuterCurve
Get and set the outer path as property
ClosedArea2D Methods
ClosedArea2D.__init__(*args)
Multiple method signature:
__init__()
Default initializer.
__init__(other: ClosedArea2D)
Initialize from other ClosedArea2D object.
ClosedArea2D.AddInnerCurve(path: Path2D) → bool
Add new inner curve, returns True if operation was successful, otherwise False.
ClosedArea2D.Clear()
Clear all the components of this Area.
ClosedArea2D.GetInnerCurve(index: int) → Path2D
Get the inner path at given index.
ClosedArea2D.GetInnerList() → Path2DList
ClosedArea2D.GetOuterCurve() → Path2D
ClosedArea2D.InnerCount() → int
ClosedArea2D.IsValid() → bool
ClosedArea2D.SetOuterCurve(path: Path2D)
ClosedArea2D.__eq__(other: ClosedArea2D) → bool
Returns true if self equals other, otherwise False.
ClosedAreaComposite2D
This is (maybe?) just a helper construction and do not really show up in the 2D model space.
class NemAll_Python_Geometry.ClosedAreaComposite2D
Representation class for 2D geometry closed (path bounded) area composite.
ClosedAreaComposite2D Properties
ClosedAreaComposite2D.ProfileList
ClosedAreaComposite2D Methods
ClosedAreaComposite2D.__init__(*args)
Multiple method signatures:
__init__()
Default initializer.
__init__(other: ClosedAreaComposite2D)
Initialize object from other ClosedAreaComposite2D object.
ClosedAreaComposite2D.Add(area: ClosedArea2D) → bool
Add new area, returns true if operation was successful, otherwise False.
ClosedAreaComposite2D.Clear()
Clothoid2D
class NemAll_Python_Geometry.Clothoid2D
Representation class for 2D clothoid.
Clothoid2D Properties
Clothoid2D.EndCurvature
Clothoid2D.EndPoint
Clothoid2D.IsReversed
Clothoid2D.Length
Clothoid2D.Parallel
Clothoid2D.RefPoint
Clothoid2D.StartCurvature
Clothoid2D.StartPoint
Clothoid2D.StartVector
Clothoid2D.Type
Clothoid2D Methods
Clothoid2D.__init__(*args)
Multiple method signature:
__init__() → None
Default initializer.
__init__(other: Clothoid2D)
Initialize object from other Clothoid2D object.
Clothoid2D.GetEndCurvature() → float
Clothoid2D.GetEndPoint() → Point2D
Get end point in world coordinate system.
Clothoid2D.GetEndRelPoint() → Point2D
Get the end point in relative coordinate system
Clothoid2D.GetIsReversed() → bool
Clothoid2D.GetLength() → float
Clothoid2D.GetParallel() → float
Get parallel of clothoid.
Clothoid2D.GetRefPoint() → Point2D
Clothoid2D.GetStartCurvature() → float
Clothoid2D.GetStartPoint() → Point2D
Get start point in world coordinate system.
Clothoid2D.GetStartRelPoint() → Point2D
Get the start point in relative coordinate system.
Clothoid2D.GetStartVector() → Vector2D
Clothoid2D.GetType() → eClothoidType
Clothoid2D.Reverse()
Reverse orientation of the Clothoid inplace.
Clothoid2D.Set(other: Clothoid2D)
Initialize clothoid from other Clothoid2D object.
Clothoid2D.SetEndCurvature(curvature: float)
Clothoid2D.SetEndPoint(point: Point2D)
Set end point in world coordinate system.
Clothoid2D.SetEndRelPoint(point: Point2D)
Set end point in local coordinate system.
Clothoid2D.SetLength(length: float)
Clothoid2D.SetParallel(parallel: float)
Set parallel of clothoid.
Clothoid2D.SetRefPoint(point: point2D)
Clothoid2D.SetReversed(flag: bool)
Set orientation, set flag True for reversed or False for normal orientation.
Clothoid2D.SetStartCurvature(curvature: float)
Clothoid2D.SetStartPoint(point: Point2D)
Clothoid2D.SetStartRelPoint(point: Point2D)
Clothoid2D.SetStartVector(vec: Vector2D)
Clothoid2D.SetType(type: eClothoidType)
Clothoid2D.__eq__(other: Clothoid2D)
Returns true if self equals other, otherwise False.
Clothoid2D.__mul__(matrix: Matrix2D) → Clothoid2D
Matrix transformation.
Line2D
class NemAll_Python_Geometry.Line2D
Line2D Properties
Line2D.EndPoint
Line2D.EndRelPoint
Line2D.RefPoint
Line2D.StartPoint
Line2D.StartRelPoint
Line2D Methods
Line2D.__init__(*args)
Multiple method signatures:
__init__()
__init__(line: Line2D)
__init__(line: Line3D)
__init__(start: Point2D, end: Point2D)
__init__(start: Point2D, vec: Vector2D)
__init__(startX: float, startY: float, endX: float, endY: float)
__init__(refPoint: Point2D, start: Point2D, end: Point2D)
Line2D.EqualRef(line: Line2D) → bool
Test for equal reference points
Line2D.Extend(delta: float)
Line2D.GetAngle() → Angle
Line2D.GetCenterPoint() → Point2D
Get the center point in world coordinate system
Line2D.GetCoords() → tuple
Get coordinates in world coordinate.
Returns (startX, startY, endX, endY)
Line2D.GetEndPoint() → Point2D
Line2D.GetEndRelPoint() → Point2D
Line2D.GetRefPoint() → Point2D
Line2D.GetStartPoint() → Point2D
Line2D.GetStartRelPoint() → Point2D
Line2D.GetVector() → Vector2D
Line2D.IsPoint() → bool
Check, whether the line is a point (start point equal end point).
Line2D.Reverse()
Reverse orientation of the line inplace.
Line2D.Set(line: Line2D)
Multiple method signatures:
Set(line: Line2D)
Set properties from line.
Set(startX: float, startY: float, endX: float, endY: float)
Set line points in world coordinate system.
Set(start: Point2D, end: Point2D)
Set line points in world coordinate system.
Set(refPoint: Point2D, start: Point2D, end: Point2D)
Used local coordinate system for start- and end point.
Line2D.SetEndPoint(point: Point2D)
Line2D.SetEndRelPoint(point: Point2D)
Line2D.SetRefPoint(refPoint: Point2D)
Set reference point in world coordinate system. Coordinates of points will be recalculated to the new reference
point.
Line2D.SetStartPoint(point: Point2D)
Line2D.SetStartRelPoint(point: Point2D)
Line2D.TrimEnd(delta: float)
Trim line at the end, delta > 0 shortens the line, delta < 0 extend the line.
Line2D.TrimStart(delta: float)
Trim line at the start, delta > 0 shortens the line, delta < 0 extend the line.
Line2D.__eq__(other: Line2d) → bool
Returns True if self equals other.
Line2D.__mul__(matrix: Matrix2D) → Line2D
Matrix transformation.
MinMax2D
class NemAll_Python_Geometry.MinMax2D
MinMax2D Properties
MinMax2D.Max
MinMax2D.Min
MinMax2D.SizeX
MinMax2D.SizeY
MinMax2D Methods
MinMax2D.__init__(*args)
Multiple method signatures:
__init__()
__init__(min: Point2D, max: Point2D)
__init__(point: Point2D)
__init__(minmax: MinMax2D)
Copy constructor.
MinMax2D.Deflate(*args)
Multiple method signatures:
Deflate(size: float)
Deflate in x, y, z axis concurrently.
Deflate(xFactor: float, yFactor: float)
Deflate in x and y axis.
MinMax2D.Get() → tuple
Returns a tuple (minimum point, maximum point)
MinMax2D.GetCenter() → Point2D
Get box center point
MinMax2D.GetMax() → Point2D
MinMax2D.GetMin() → Point2D
MinMax2D.GetSizeX() → float
MinMax2D.GetSizeY() → float
MinMax2D.Inflate(*args)
Multiple method signatures:
Inflate(xFactor: float, yFactor: float)
Inflate and deflate minmax box.
Inflate(size: float)
Inflate in x, y, z axis concurrently.
MinMax2D.IsContaining(box: MinMax2D) → bool
Is box inside this box.
MinMax2D.IsValid() → bool
MinMax2D.Overlaps(box: MinMax2D) → bool
Does box overlap this box.
MinMax2D.Set(min: Point2D, max: Point2D)
MinMax2D.SetMax(point: Point2D)
MinMax2D.SetMin(point: Point2D)
MinMax2D.__add__(other: MinMax2D) → MinMax2D
Expand MinMax2D box.
MinMax2D.__eq__(other: MinMax2D) → bool
Return True if self equals other.
MinMax2D.__iadd__(*args)
Multiple method signatures:
__iadd__(other: MinMax2D) → MinMax2D
Expand MinMax2D box inplace.
__iadd__(point: Point2D) → MinMax2D
Expand MinMax2D box inplace.
Path2D
class NemAll_Python_Geometry.Path2D(Path)
Class for 2D path geometry
Path2D Methods
Inherited methods see: Path
Path2D.__init__(*args)
Multiple method signatures:
__init__()
__init__(path: Path2D)
Copy constructor
Path2D.Add(*args)
Multiple method signatures:
Add(object) → eGeometryErrorCode
Add object to this path, start or end point of appended element has to be equal to start or end point of path.
Add(path: Path2D) → eGeometryErrorCode
Add path to this path, start or end point of appended path has to be equal to start or end point of path.
Path2D.GetEndPoint() → Point2D
Path2D.GetEndRelPoint() → Point2D
Path2D.GetStartPoint() → Point2D
Path2D.GetStartRelPoint() → Point2D
Path2D.IsClosed() → bool
Path2D.IsItPossibleToAddElement(object) → bool
Check if object can be added to this path.
Path2D.IsValid() → bool
Path2D.IsValidCurveType(object) → bool
Check if object is supported by Path2D.
Path2D.SetEndPoint(point: Point2D)
Path2D.SetStartPoint(point: Point2D)
Path2D.__eq__(other: Path2D) → bool
Returns True if self equals other.
Path2D.__iadd__(*args)
Append operator, start or end point of appended element has to be equal to start or end point of path.
Multiple method signatures:
__iadd__(other: Path2D) → Path2D
__iadd__(line: Line2D) → Path2D
__iadd__(polyline: Polyline2D) → Path2D
__iadd__(spline: Spline2D) → Path2D
__iadd__(clothoid: Clothoid2D) → Path2D
__iadd__(arc: Arc2D) → Path2D
__iadd__(object) → Path2D
Polygon2D
class NemAll_Python_Geometry.Polygon2D(PolyPoints2D)
For constructing a polygon from a bunch of points, the following rules must be fulfilled: This class does not
‘auto-close’ polygons. A quadratic shape with ‘4’ edges has to be defined by passing 5 points to a construc-
tor. For such an object, the Count() method will return ‘5’ accordingly. The orientation of points must be
monotonous. It can be either clockwise or counter-clockwise. The polygon must not self-intersect itself. You
can create instances of polygons that self-intersects or have alternating orientation, but in those cases some
methods will report errors, throw or return wrong calculation results.
Each polygon is compound from one or more components. Component is a loop. Component represent solid
element or hole element, it depend on orientation of loop (counter-clockwise is solid element, clockwise is hole).
When polygon is created from more compounds, then each compound must be closed (first and last point are
equal) and first and last point of hole polygon are equal too.
For better polygon creation you can use Polygon2DBuilder class.
Polygon2D Methods
Inherited methods see: PolyPoints2D
Polygon2D.__init__(*args)
Multiple method signatures:
__init__()
__init__(polygon: Polygon2D)
Copy constructor.
Polygon2D.GetSegments() → tuple
Returns tuple (error code, vector of polygon segments)
Polygon2D.IsValid() → bool
Check if the polygon is valid. (has at least 3 points)
Polygon2D.Normalize(normalizeType: ePolygonNormalizeType, extra_smooth: bool)
Normalize Polygon2D using huge old algorithm, adding points at line crossings, reorganizing the lines, correct-
ing gaps, ...
Parameters
• normalizeType – type of Polygon2D normalization
• extra_smooth – Including extra smooth
Polygon2D.NormalizeNoThrow(normalizeType: ePolygonNormalizeType, extra_smooth: bool) → ob-
ject
Normalize Polygon2D, same as Normalize, but method doesn’t throw exception, just return error code.
Returns Error code (eOK, eAllocError, eStructuralError)
Polygon2D.Reverse()
Reverse the point order inplace, separately for every subpolygon.
Polygon2D.__eq__(other: Polygon2D) → bool
Returns true if self equals other.
Polygon2D.__iadd__(point: Point2D) → self
Append point inplace.
Polygon2D.__setitem__(index: int, point: Point2D)
Set point at given index.
PolygonalArea2D
class NemAll_Python_Geometry.PolygonalArea2D(PolygonalArea)
Class for 2D polygonal area geometry.
PolygonalArea2D Properties
PolygonalArea2D.RefPoint
PolygonalArea2D Methods
PolygonalArea2D.__init__(*args)
Multiple method signtures:
__init__()
__init__(verticesCount: int, edgesCount: int)
Create initialized 2D polygonal area with expected vertices and edges count.
__init__(refPoint: Point2D, verticesCount: int, edgesCount: int)
Create initialized 2D polygonal area with expected vertices and edges count.
__init__(polygon: PolygonalArea2D)
Copy constructor.
PolygonalArea2D.AppendRelVertex(vertex: Point2D) → tuple
Append vertex in local coordinate system.
Returns tuple(Error code, index of vertex)
PolygonalArea2D.AppendVertex(vertex: Point2D) → tuple
Append vertex in world coordinate system.
Returns tuple(Error code, index of vertex)
PolygonalArea2D.EqualRef(polygon: PolygonalArea2D) → bool
Test for equal reference points.
PolygonalArea2D.GetEdgeVertices(edgeIndex: int) → tuple
Returns tuple(Error code, start point of the edge in WCS, end point of the edge in WCS)
PolygonalArea2D.GetPolygon() → tuple
Eturn tuple(Error code, polygon)
PolygonalArea2D.GetRefPoint(*args) → Point2D
PolygonalArea2D.GetRelVertex(vertexIndex: int) → tuple
Get vertex in local coordinate system.
Returns tuple(Error code, vertex in local coordinate system)
PolygonalArea2D.GetVertex(vertexIndex: int) → tuple
Get vertex in world coordinate system.
Returns tuple(Error code, vertex in world coordinate system)
PolygonalArea2D.SetRefPoint(refPoint: Point2D) → object
Set reference point in world coordinate system.
Eeturn Error code
PolygonalArea2D.__eq__(other: PolygonalArea2D) → bool
Returns True if self equals other.
PolygonalArea2D.__getitem__(vertexIndex: int) → Point2D
Get point in WCS at specified index.
PolygonalArea2D.__iadd__(*args)
Multiple method signature:
__iadd__(polygonalarea: PolygonalArea2D) → self
Append polygonalare inplace.
__iadd__(polygon: Polygon2D) → self
Append loop.
PolygonalArea2D.__mul__(matrix: Matrix2D) → PolygonalArea2D
Matrix transformation.
Polyline2D
class NemAll_Python_Geometry.Polyline2D(PolyPoints2D)
Polyline2D Methods
Inherited methods see: PolyPoints2D
Polyline2D.__init__(*args)
Multiple method signatures:
__init__()
__init__(polyline: Polyline2D)
Copy constructor.
__init__(polyline: Polyline2D, skip: int, count: int)
Copy constructor with limited scope.
Parameters
• polyline – Polyline which will be copied
• skip – count of points ignored at start.
• count – count of points copied.
__init__(polygon: Polygon2D)
If polygon have two or more components, then constructor throw Geometry exception.
Polyline2D.GetLine(index: int) → Line2D
Polyline2D.GetLines() → Line2DList
Polyline2D.IsValid() → bool
Polyline2D.LineCount() → int
Polyline2D.Reverse()
Reverse orientation of the Polyline
Polyline2D.__eq__(other: Polyline2D) → bool
Return True if self equals other.
Polyline2D.__iadd__(*args)
Multiple methods signatures:
__iadd__(polyline: Polyline2D) → self
Append all points of polyline inplace.
__iadd__(point: Point2D) → self
Append point inplace.
Spline2D
class NemAll_Python_Geometry.Spline2D(PolyPoints2D)
Spline2D Properties
Spline2D.EndVector
Spline2D.StartVector
Spline2D Methods
Inherited methods see: PolyPoints2D
Spline2D.__init__(*args)
Multiple method signature:
__init__()
__init__(spline: Spline2D)
Copy constructor.
Spline2D.GetEndVector() → Vector2D
Spline2D.GetStartVector() → Vector2D
Spline2D.IsClosed() → bool
Spline2D.Reverse()
Reverse of current spline. Reverse spline using PolyPoints.reverse and swapping tangents.
Spline2D.SetEndVector(vec: Vector2D)
Spline2D.SetStartVector(vec: Vector2D)
Spline2D.__eq__(other: Spline2D)
Returns True if self equals other.
Spline2D.__iadd__(point: Point2D) → self
Append point inplace.
Spline2D.__mul__(matrix: Matrix2D) → Spline2D
Matrix transformation.
3D Object Classes
Arc3D
class NemAll_Python_Geometry.Arc3D
Arc3D could be a circular or elliptical arc. All angles are given as central angles. In case of an elliptical arc the
ellipse angle and the central angle do not correspond. All start angle is normalized to the range [-PI ... 2PI]. The
winding direction of the arc could either be in clockwise or in counterclockwise direction.
Arc3D Properties
Arc3D.Center
Arc3D.CenterRel
Arc3D.CounterClockwise
Arc3D.DeltaAngle
Arc3D.EndAngle
Arc3D.EndPoint
Arc3D.EndRelPoint
Arc3D.MajorRadius
Arc3D.MinorRadius
Arc3D.RefPoint
Arc3D.StartAngle
Arc3D.StartPoint
Arc3D.StartRelPoint
Arc3D Methods
Arc3D.__init__(*args)
Multiple method signatures:
__init__(arc: Arc3D)
Initialize with data from Arc3D object.
__init__(center: Point3D, xDir: Vector3D, normVector: Vector3D, minor: float, major: float, star-
tAngle: float, deltaAngle: float, counterClockwise:bool=True)
All angles in radians as type float.
__init__(center: Point3D, minor: float, major: float, startAngle: float, deltaAngle: float, counter-
Clockwise: bool=True)
All angles in radians as type float.
__init__(placement: AxisPlacement3D, minor: float, major: float, startAngle: float, deltaAngle: float,
counterClockwise:bool=True)
All angles in radians as type float.
__init__(arc: Arc2D)
Initialize with data from Arc2D object.
Arc3D.Close()
Close the arc. Set the delta angle to 2Pi, to close the arc.
Arc3D.GetCenter() → Point3D
Arc3D.GetCenterRel() → Point3D
Arc3D.GetDeltaAngle() → Angle
Arc3D.GetEndAngle() → Angle
Arc3D.GetEndPoint() → Point3D
Arc3D.GetEndRelPoint() → Point3D
Arc3D.GetLocalPoint(point: Point3D) → Point3D
Get the local coordinates of a WCS point.
Arc3D.GetMajorAxis() → Vector3D
The major axis is calculated according to the plane normal and the axis angle.
Arc3D.GetMajorRadius() → float
Arc3D.GetMinorAxis() → Vector3D
The minor axis is calculated via the cross product of major axis and plane normal
Arc3D.GetMinorRadius() → float
Arc3D.GetNormVector() → Vector3D
Arc3D.GetOrigin() → Point3D
Arc3D.GetPoint(angle: Angle) → Point3D
Get point on arc with given angle in world coordinates.
Arc3D.GetPointAngle(point: Point3D) → Angle
Get the angle of a WCS point.
Arc3D.GetPointRel(angle: Angle) → Point3D
Get point on arc with given angle in relative coordinates.
Arc3D.GetRefPlacement() → AxisPlacement3D
Arc3D.GetRefPlacementRel() → AxisPlacement3D
Arc3D.GetRefPoint() → Point3D
Arc3D.GetStartAngle() → Angle
Arc3D.GetStartPoint() → Point3D
Arc3D.GetStartRelPoint() → Point3D
Arc3D.GetXAxis() → Vector3D
Get Major axis (X-Axis of the placement).
Arc3D.GetZAxis() → Vector3D
Get Normal vector of the placement.
Arc3D.IsAngleOnArc() → bool
Returns True if the given angle lies on the arc, otherwise False.
Arc3D.IsCircle() → bool
Returns True if minor radius equals major radius, otherwise False.
Arc3D.IsClockwise() → bool
Returns True if winding direction is clockwise, otherwise False.
Arc3D.IsClosed() → bool
Returns True if delta angle is 2pi, otherwise False.
Arc3D.IsCounterClockwise() → bool
Returns True if winding direction is counter clockwise, otherwise False.
Arc3D.IsEpsilonClosed() → bool
Returns True if delta angle is 2pi, otherwise False.
Arc3D.IsValid() → bool
Returns True if the arc is valid, otherwise False.
Arc3D.Reverse()
Reverse of current arc.
Arc3D.RotateAroundLocalZAxis(angle: Angle)
Rotate current arc around the Z-axis (normal vector).
Arc3D.SetCenter(center: Point3D)
Arc3D.SetCenterRel(center:Point3D)
Arc3D.SetClockwise(clockwise: bool=True)
Arc3D.SetCounterClockwise(counterClockwise: bool=True)
Arc3D.SetDeltaAngle(angle: Angle)
Arc3D.SetEndAngle(angle: Angle, counterClockwise=True)
Set the end angle and normalize it to [0,2PI[
Arc3D.SetEndPoint(point: Point3D)
Set the end point of arc in world coordinates.
Arc3D.SetMajorRadius(radius: float)
Arc3D.SetMinorRadius(radius: float)
Arc3D.SetNormVector(vec: Vector3D)
Arc3D.SetOrigin(center: Point3D)
Arc3D.SetRefPlacement(*args)
Multiple method signature:
SetRefPlacement(refPlacement: AxisPlacement3D)
SetRefPlacement(center: Point3D, xAxis: Vector3D, normalVec: Vector3D)
Arc3D.SetRefPlacementRel(refPlacement: AxisPlacement3D)
Set the reference placement relative to the refPoint
Arc3D.SetRefPoint(point: Point3D)
Arc3D.SetStartAngle(angle: Angle, counterClockwise: bool=True)
Set the start angle and normalize it to [0,2PI[
Arc3D.SetStartPoint(point: Point3D)
Arc3D.__eq__(other: Arc3D) → bool
Returns True if self equals other, otherwise False.
BRep3D
class NemAll_Python_Geometry.BRep3D
Boundary Representation 3D explained on Wikipedia: https://en.wikipedia.org/wiki/Boundary_representation
BRep3D Properties
BRep3D.RefPoint
BRep3D Methods
BRep3D.__init__(*args)
Multiple method signatures:
__init__()
Default initializer.
__init__(other: BRep3D)
Initialize object from other BRep3D object.
BRep3D.AreFacesNaturallyTrimmed() → bool
Returns True if all faces are naturally trimmed by their surfaces, otherwise False.
BRep3D.CreateCone(cone: Cone3D) → BRep3D
Create BRep3D as cone.
BRep3D.CreateCuboid(placement: AxisPlacement3D, length: float, width: float, height: float) →
BRep3D
Create BRep3D as cuboid.
BRep3D.CreateCylinder(placement: AxisPlacement3D, radius: float, height: float) → BRep3D
Create BRep3D as cylinder.
BRep3D.CreateSphere(placement: AxisPlacement3D, radius: float) → BRep3D
Create BRep3D as sphere
BRep3D.CreateWireBody(icurve: ???) → BRep3D
Create wire body from the curve as one edge.
BRep3D.DeleteFace(index: int) → int
Delete face specified by index from brep.
BRep3D.DeleteFaces(indices: VecULongList) → int
Delete faces specified by indices from brep.
BRep3D.GetEdgeCount() → int
BRep3D.GetEdgeCurves() → tuple
Get all edge curves as BSpline3D objects.
Return error code, result edge curves handle vector
BRep3D.GetEdgeFaceIndices(edge: int) → tuple
Get faces containing this edge (if any).
Return error code, face indices
BRep3D.GetEdgeGeometry(edge: int) → object
Get (trimmed) edge geometry.
Returns handle to geometry curve
BRep3D.GetEdgeParametricCurves() → tuple
Get parametric curves of all edges.
Returns error code, result edge curves handle vector
BRep3D.GetEdgeVertexIndices(edge: int) → tuple
Get vertex indices of the edge.
Returns error code, start vertex index, end vertex index
BRep3D.GetEdgeVertices(edge: int) → tuple
Get edge vertices.
Returns error code, start vertex, end vertex
BRep3D.GetFaceBoundaryCurves(face: int) → tuple
Get face boundary curves, curves are trimmed.
Returns error code, result geometries
BRep3D.GetFaceCount() → int
BRep3D.GetFaceEdgeNaturalTrimming(face: int, oedge:OrientedEdge) → tuple
Get edge trimming on this face.
Returns error code, result trimming
BRep3D.GetFaceEdgeOrientation(face: int, edge: int) → tuple
Get orientation of the edge in the given face.
Returns error code, result orientation (same = True or opposite = False)
BRep3D.GetFaceEdges(face: int) → tuple
Get face edges together with their orientations.
Returns error code, result edges
BRep3D.GetFaceFlags(face: int) → int
BRep3D.GetFaceGeometry(face: int) → object
Get surface geometry of the face
Returns surface geometry handle
BRep3D.GetFaceGeometryOrientation(face: int) → bool
Get surface geometry orientation of the face.
BRep3D.GetFaceLoopsCount(face: int) → int
Returns isCone: bool, result axis placement (cone bottom center, axis orientation), cone bottom
radius, cone top radius, cone height
BRep3D.IsFaceNaturallyTrimmed(face: int) → bool
Returns true if the face is naturally trimmed by its surface, otherwise False
BRep3D.IsPolyhedron() → bool
BRep3D.IsSphere() → tuple
Check if the b-rep is a sphere
Returns isSphere: bool, result axis placement (sphere center, axis orientation), sphere radius
BRep3D.IsValid() → bool
BRep3D.IsWire() → bool
Returns True if brep is wire body (has only edges), otherwise False.
BRep3D.PickEdge(rayPoint: Point3D, rayVector: Vector3D, searchRadius: float) → tuple
Pick the edge under cursor.
Returns True if any edge under cursor found, index of found edge, minimal distance between edge
and ray, nearest point on ray from edge
BRep3D.PickFace(rayPoint: Point3D, rayVector: Vector3D) → tuple
Pick the face under cursor.
Returns True if any face under cursor found, index of found face, nearest point on ray from face
(intersection point)
BRep3D.PickVertex(rayPoint: Point3D, rayVector: Vector3D, searchRadius: float) → tuple
Pick the vertex under cursor.
Returns True if any vertex under cursor found, index of found vertex, minimal distance between
vertex and ray, nearest point on ray from vertex
BRep3D.Reverse() → object
Reverse the orientation of BRep.
Returns error code
BRep3D.SetAllFacesFlags(flags: int)
Set flags to the all faces.
BRep3D.SetFaceFlags(index: int, flags: int)
Set flags to the face specified by index.
BRep3D.SetRefPoint(point: Point3D)
BRep3D.__eq__(other: BRep3D) → bool
Returns True if self equals other, otherwise False.
BSpline3D
class NemAll_Python_Geometry.BSpline3D(PolyPoints3D)
Class for 3D (non uniform, rational) B-spline geometry. Needs type NemAll_Python_Utility.
VecDoubleList.
BSpline3D Properties
For inherited properties see: PolyPoints3D
BSpline3D.Degree
BSpline3D.Knots
BSpline3D.Weights
BSpline3D.IsPeriodic
BSpline3D Methods
For inherited methods see: PolyPoints3D
BSpline3D.__init__(*args)
Multiple method signatures:
__init__()
__init__(points: Point3DList, weights: VecDoubleList, knots: VecDoubleList, degree: int, isPeriodic:
bool=False)
Full specified initialisation.
__init__(other: BSpline3D)
Initialize from other BSpline3D object.
BSpline3D.Clear()
Clear data, getting invalid state
BSpline3D.Create(curve: ICurve3D) → BSpline3D
Create BSpline3D object from ICurve3D object.
ICurve3D is an undocumented (Allplan 2017) interface class.
BSpline3D.CreateArc3D(arc: Arc3D) → BSpline3D
Create BSpline3D object from Arc3D object.
BSpline3D.CreateLine3D(line: Line3D) → BSpline3D
Create BSpline3D object from Line3D object.
BSpline3D.CreateSpline(spline: Spline3D) → BSpline3D
Create BSpline3D object from Spline3D object.
BSpline3D.Get() → tuple
Get values of BSpline.
Returns (list of points, List of weights, list of knots, degree, True if BSpline is periodic)
BSpline3D.GetDegree() → int
BSpline3D.GetIsPeriodic() → bool
BSpline3D.GetKnots() → VecDoubleList
BSpline3D.GetWeights() → VecDoubleList
BSpline3D.IsClosed() → bool
BSpline3D.IsLine() → bool
BSpline3D.IsRational() → bool
BSpline3D.IsValid() → bool
BSpline3D.Reverse()
Reverse current BSpline by PolyPoints3D.reverse() and swapping tangents.
BSpline3D.Set(points: Point3DList, weights: VecDoubleList, knots: VecDoubleList, degree: int, isPeri-
odic: bool=False)
BSpline3D.SetDegree(degree: int)
BSpline3D.SetKnots(knots: VecDoubleList)
BSpline3D.SetPeriodic(periodic: bool)
BSpline3D.SetWeights(weights: VecDoubleList)
BSpline3D.__eq__(other: BSpline3D) → bool
Returns True if self equals other, otherwise False.
BSplineSurface3D
class NemAll_Python_Geometry.BSplineSurface3D
Class for 3D (non uniform, rational) B-spline surface geometry. Needs type NemAll_Python_Utility.
VecDoubleList.
BSplineSurface3D Properties
BSplineSurface3D.Points
BSplineSurface3D.UDegree
BSplineSurface3D.UKnots
BSplineSurface3D.VDegree
BSplineSurface3D.VKnots
BSplineSurface3D.Weights
BSplineSurface3D Methods
BSplineSurface3D.__init__(*args)
Multiple method signatures:
__init__()
Default initializer.
__init__(points: Point3DList, weights: VecDoubleList, uknots: VecDoubleList, vknots: VecDou-
bleList, udegree: int, vdegree: int, isUPeriodic: bool, isVPeriodic: bool, isUClosed: bool,
isVClosed: bool)
Full specified initialisation.
__init__(other: BSplineSurface3D)
Initialize from other BSplineSurface3D object.
BSplineSurface3D.Clear()
Clear data, getting invalid state.
BSplineSurface3D.Get() → tuple
Returns (control points, control points weights, knots in u direction, knots in v direction, degree
in u direction, degree in v direction, periodic in u direction, periodic in v direction, closed in u
direction, closed in v direction)
BSplineSurface3D.GetCenterPoint() → Point3D
BSplineSurface3D.GetNormalVector(uv: Point2D) → tuple
Evaluate normal vector for given parameters.
Returns (error code, result vector)
BSplineSurface3D.GetPoints() → Point3DList
Get all control points.
BSplineSurface3D.GetUDegree() → int
Get surface u-degree.
BSplineSurface3D.GetUKnots() → VecDoubleList
Get u-knot vector.
BSplineSurface3D.GetUPointsCount() → int
Get control points count in u-direction.
BSplineSurface3D.GetVDegree() → int
Get surface v-degree.
BSplineSurface3D.GetVKnots() → VecDoubleList
Get v-knot vector.
BSplineSurface3D.GetVPointsCount() → int
Get control points count in v-direction.
BSplineSurface3D.GetWeights() → VecDoubleList
Get control points weights.
BSplineSurface3D.IsPlanar() → bool
BSplineSurface3D.IsRational() → bool
BSplineSurface3D.IsValid() → bool
BSplineSurface3D.Set(points: Point3DList, weights: VecDoubleList, uknots: VecDoubleList, vknots:
VecDoubleList, udegree: int, vdegree: int, isUPeriodic: bool, isVPeriodic: bool,
isUClosed: bool, isVClosed: bool)
BSplineSurface3D.SetUDegree(degree: int)
BSplineSurface3D.SetUKnots(knots: VecDoubleList)
BSplineSurface3D.SetVDegree(degree: int)
BSplineSurface3D.SetVKnots(knots: VecDoubleList)
BSplineSurface3D.SetWeights(weights: VecDoubleList)
BSplineSurface3D.__eq__(other: BSplineSurface3D) → bool
Returns True if self equals other, otherwise False.
ClippedSweptSolid3D
class NemAll_Python_Geometry.ClippedSweptSolid3D
Representation class for solid created by extrusion of area with borders of a plane at the bottom and a plane at
the top in world z - axis direction.
ClippedSweptSolid3D Properties
ClippedSweptSolid3D.BottomPlane
ClippedSweptSolid3D.RefPoint
ClippedSweptSolid3D.SweptArea
ClippedSweptSolid3D.TopPlane
ClippedSweptSolid3D Methods
ClippedSweptSolid3D.__init__(...)
Multiple method signatures:
__init__()
Default initializer.
__init__(area: PolygonalArea2D, bottom: Plane3D, top: Plane3D)
Full specified initialisation.
__init__(other: ClippedSweptSolid3D)
Initialize from other ClippedSweptSolid3D object.
__init__(refPoint. Point3D, other: ClippedSweptSolid3D)
Initialize from other ClippedSweptSolid3D object.
ClippedSweptSolid3D.GetBottomPlane() → Plane3D
ClippedSweptSolid3D.GetRefPoint() → Point3D
ClippedSweptSolid3D.GetSweptArea() → PolygonalArea2D
ClippedSweptSolid3D.GetTopPlane() → Plane3D
ClippedSweptSolid3D.IsValid() → bool
ClippedSweptSolid3D.SetBottomPlane(plan: Plan3D)
ClippedSweptSolid3D.SetRefPoint(point: Point3D)
ClippedSweptSolid3D.SetSweptArea(area: PolygonalArea2D)
ClippedSweptSolid3D.SetTopPlane(plane: Plane3D)
ClippedSweptSolid3D.__eq__(other: ClippedSweptSolid3D) → bool
Returns True if self equals other, otherwise False.
ClippedSweptSolid3D.__mul__(matrix: Matrix3D) → ClippedSweptSolid3D
Matrix transformation.
ClosedArea3D
This is (maybe?) just a helper construction and do not really show up in the 3D model space.
class NemAll_Python_Geometry.ClosedArea3D
Representation class for 3D geometry area.
ClosedArea3D Properties
ClosedArea3D.RefPlacement
Get and set the reference placement 3d as property
ClosedArea3D Methods
ClosedAreaComposite3D
This is (maybe?) just a helper construction and do not really show up in the 3D model space.
class NemAll_Python_Geometry.ClosedAreaComposite3D
Representation class for 3D geometry profile composite
ClosedAreaComposite3D Properties
ClosedAreaComposite3D.ClosedAreaComposite
Get the 2d closed area composite as property
ClosedAreaComposite3D.RefPlacement
Get and set the reference placement 3d as property
ClosedAreaComposite3D Methods
ClosedAreaComposite3D.__init__(*args)
Multiple method signatures:
__init__()
Default initializer.
__init__(other: ClosedAreaComposite3D)
Initialize object from other ClosedAreaComposite3D object.
ClosedAreaComposite3D.Add(profile: ClosedArea2D) → bool
Add new 2D profile, returns True if operation was successful, otherwise False.
ClosedAreaComposite3D.Clear()
ClosedAreaComposite3D.GetClosedAreaComposite() → ClosedAreaComposite2D
ClosedAreaComposite3D.GetRefPlacement() → AxisPlacement3D
ClosedAreaComposite3D.IsEmpty() → bool
ClosedAreaComposite3D.SetRefPlacement(placement: AxisPlacement3D)
ClosedAreaComposite3D.__eq__(other: ClosedAreaComposite3D) → bool
Returns True if self equals other.
Cone3D
class NemAll_Python_Geometry.Cone3D
Cone3D Properties
Cone3D.Apex
Cone3D.LocalPlacement
Cone3D.MajorRadius
Cone3D.MinorRadius
Cone3D Methods
Cone3D.__init__(*args)
Multiple method signatures:
__init__()
Default initializer.
__init__(other: Cone3D)
Initialize object from other Cone3D object.
__init__(axis: AxisPlacement3D, radiusMajor:float, radiusMinor: float, apex: Point3D)
Initialize cone with reference placement axis. Height of the Cone is z-coordinate of the Apex.
__init__(radiusMajor: float, radiusMinor: float, apex: Point3D)
Height of the Cone is z-coordinate of the Apex.
Cone3D.GetApex() → Point3D
Get Apex of the Cone in the local coordinate system
Cone3D.GetApexParent() → Point3D
Get Apex of the Cone in the parent coordinate system
Cone3D.GetCenter() → Point3D
Cone3D.GetHeight() → float
Cone3D.GetLocalPlacement() → AxisPlacement3D
Cone3D.GetMajorRadius() → float
Cone3D.GetMinMax() → MinMax3D
Cone3D.GetMinorRadius() → float
Cone3D.GetXAxis() → Vector3D
Get X-Axis of the placement of the Cone
Cone3D.GetZAxis() → Vector3D
Get Z - axis of the placement of the Cone
Cone3D.IsCircular() → bool
Cone3D.IsOblique() → bool
Perpendicularity check for the Cone.
Cone3D.IsValid() → bool
Cone3D.SetApex(apex: Point3D)
Set Apex in the local coordinate system.
Cone3D.SetApexParent(apex: Point3D)
Set Apex in the parent coordinate system
Cone3D.SetCenter(center: Point3D)
Cone3D.SetHeight(height: float)
Cone3D.SetLocalPlacement(axis: AxisPlacement3D)
Set Local Placement.
Cone3D.SetMajorRadius(radius: float)
Cone3D.SetMinorRadius(radius: float)
Cone3D.__eq__(other: Conde3D) → bool
Returns True if self is equal to other.
ConicalSurface3D
class NemAll_Python_Geometry.ConicalSurface3D
3D conical surface
ConicalSurface3D Properties
ConicalSurface3D.Placement
ConicalSurface3D.Radius
ConicalSurface3D.SemiAngle
ConicalSurface3D Methods
ConicalSurface3D.__init__(*args)
Multiple method signatures:
__init__()
Default initializer.
__init__(axis: AxisPlacement3D, radius: float, angle: Angle)
Full specified initializer.
__init__(other: ConicalSurface3D)
Initialize object from other ConicalSurface3D object.
ConicalSurface3D.Get() → tuple
Returns (placement of conical surface, radius of conical surface in placement, semi angle of conical
surface)
ConicalSurface3D.GetPlacement(...) → AxisPlacement3D
Returns placement - point + axis vector + reference direction vector
ConicalSurface3D.GetRadius() → float
ConicalSurface3D.GetSemiAngle() → Angle
ConicalSurface3D.IsValid() → bool
ConicalSurface3D.Set(axis: AxisPlacement3D, radius: float, angle: Angle)
Set all surface members.
ConicalSurface3D.SetPlacement(axis: AxisPlacement3D)
Sets the position of conical surface.
Parameters axis – placement - point + axis vector + reference direction vector
ConicalSurface3D.SetRadius(radius: float)
ConicalSurface3D.SetSemiAngle(angle: Angle)
ConicalSurface3D.__eq__(other: ConicalSurface3D)
Returns True if self equals other.
Cuboid3D
class NemAll_Python_Geometry.Cuboid3D
Cuboid3D Properties
Cuboid3D.HeightVector
Cuboid3D.LengthVector
Cuboid3D.RefPoint
Cuboid3D.StartPoint
Cuboid3D.WidthVector
Cuboid3D Methods
Cuboid3D.__init__(*args)
Multiple method signatures:
__init__()
Default initializer.
__init__(other: Cuboid3D)
Initialize object from other Cuboid3D object.
__init__(refPoint: Point3D, start: Point3D, vecX: Vector3D, vecY: Vector3D, vecZ: Vector3D)
Full specified initializer.
Cuboid3D.GetBottomFacePolygon() → Polygon3D
Get the boundary polygon of bottom face of the cuboid.
Cuboid3D.GetGroundPlane() → Plane3D
Get ground plane ( ref point + Z-vector ).
Cuboid3D.GetHeight() → float
Returns size of Z-vector.
Cuboid3D.GetLength() → float
Return size of X-vector.
Cuboid3D.GetRefPoint() → Point3D
Cuboid3D.GetRelStartPoint() → Point3D
Get start point in relative coordinates.
Cuboid3D.GetStartPoint() → Point3D
Get start point in world coordinates.
Cuboid3D.GetTopFacePolygon() → Polygon3D
Get the boundary polygon of top face of the cuboid.
Cuboid3D.GetVector(index: int) → Vector3D
Get vector at given index.
Cuboid3D.GetWidth() → float
Return size of Y-vector.
Cuboid3D.Set(*args)
Multiple method signatures:
Set(refPoint: Point3D, start: Point3D, vecX: Vector3D, vecY: Vector3D, vecZ: Vector3D)
Set all attributes.
Set(other: Ciuboid3D)
Set values from other Cuboid3D object.
Cuboid3D.SetHeight(height: float)
height is the new size of Z-vector.
Cuboid3D.SetLength(length: float)
length is the new size of X-vector.
Cuboid3D.SetRefPoint(point: Point3D)
Cuboid3D.SetStartPoint(start: Point3D)
Cuboid3D.SetVector(vec: Vector3D, index: int)
Cuboid3D.SetWidth(width: float)
width is the new size of Y-vector.
Cuboid3D.__eq__(other: Cuboid3D) → bool
Returns True if self equals other.
Cylinder3D
class NemAll_Python_Geometry.Cylinder3D
Cylinder3D Properties
Cylinder3D.Apex
Cylinder3D.LocalPlacement
Cylinder3D.MajorRadius
Cylinder3D.MinorRadius
Cylinder3D Methods
Cylinder3D.__init__(*args)
Multiple method signatures:
__init__()
Default initializer.
__init__(other: Cylinder3D)
Initialize object from other Cylinder3D object.
__init__(refPlacement: AxisPlacement3D, radiusMajor: float, radiusMinor: float, apex: Point3D)
Full specified initializer in reference placement. Height of the cylinder is z-coordinate of the Apex.
__init__(radiusMajor: float, radiusMinor: float, apex: Point3D)
Full specified initializer in WCS. Height of the cylinder is z-coordinate of the Apex.
Cylinder3D.GetApex() → Point3D
Get Apex of the Cylinder in the local coordinate system
Cylinder3D.GetApexParent() → Point3D
Get Apex of the Cylinder in the parent coordinate system
Cylinder3D.GetBottomCenter() → Point3D
Cylinder3D.GetCenter() → Point3D
Cylinder3D.GetHeight() → float
Cylinder3D.GetLocalPlacement() → AxisPlacement3D
Cylinder3D.GetMajorRadius() → float
Cylinder3D.GetMinMax() → MinMax3D
Cylinder3D.GetMinorRadius() → float
Cylinder3D.GetSilhouetteLines(viewMatrix: Matrix3D, bPerspective: bool) → Line3DList
Get silhouette lines of cylinder, bPerspective flag determines the use of central projection.
Cylinder3D.GetTopCenter() → Point3D
Cylinder3D.GetXAxis() → Vector3D
Get X-Axis of the placement of the Cylinder
Cylinder3D.GetYAxis() → Vector3D
Get Y-Axis of the placement of the Cylinder
Cylinder3D.GetZAxis() → Vector3D
Get Z - axis of the placement of the Cylinder
Cylinder3D.IsCircular() → bool
Cylinder3D.IsOblique() → bool
Perpendicularity check of the Cylinder
Cylinder3D.IsValid()
Cylinder3D.SetApex(apex: Point3D)
Set Apex in the local coordinate system
Cylinder3D.SetApexParent(apex: Point3D)
Set Apex in the parent coordinate system
Cylinder3D.SetCenter(center: Point3D)
Cylinder3D.SetHeight(height: float)
Cylinder3D.SetLocalPlacement(*args)
Multiple method signatures:
SetLocalPlacement(axis: AxisPlacement3D)
SetLocalPlacement(center: Point3D, xAxis: Vector3D, zAxis: Vector3D)
Cylinder3D.SetMajorRadius(radius: float)
Cylinder3D.SetMinorRadius(radius: float)
Cylinder3D.__eq__(other: Cylinder3D) → bool
Returns true if self equals other.
Ellipsoid3D
class NemAll_Python_Geometry.Ellipsoid3D
Ellipsoid3D Properties
Ellipsoid3D.LocalPlacement
Ellipsoid3D.XRadius
Ellipsoid3D.YRadius
Ellipsoid3D.ZRadius
Ellipsoid3D Methods
Ellipsoid3D.__init__(*args)
__init__()
Default initializer.
__init__(other: Ellipsoid3D)
initialize object from other Ellipsoid3D object.
__init__(refPlacement: AxisPlacement3D, radiusX: float, radiusY: float, radiusZ: float)
Full specified initialisation in reference placement.
__init__(radiusX: float, radiusY: float, radiusZ: float)
Full specified initialisation in WCS, center = (0, 0, 0)
Ellipsoid3D.GetCenter() → Point3D
Ellipsoid3D.GetIsoLines(uSegmentsCount: int, vSegmentsCount: int) → Arc3DList
GetLocalPlacement() → AxisPlacement3D
Ellipsoid3D.GetSilhouetteContour(viewMatrix: Matrix3D, bPerspective: bool) → Arc3D
Flage bPerspective determines the use of central perspective.
Ellipsoid3D.GetXAxis() → Vector3D
Get X-Axis of the placement of the Ellipsoid
Ellipsoid3D.GetXRadius() → float
Ellipsoid3D.GetYAxis() → Vector3D
Get Y-Axis of the placement of the Ellipsoid
Ellipsoid3D.GetYRadius() → float
Ellipsoid3D.GetZAxis() → Vector3D
Get Z - axis of the placement of the Ellipsoid
Ellipsoid3D.GetZRadius() → float
Ellipsoid3D.IsSphere() → bool
Ellipsoid3D.IsValid() → bool
Ellipsoid3D.SetCenter(center: Point3D)
Ellipsoid3D.SetLocalPlacement(*args)
Multiple method signatures:
SetLocalPlacement(axis: AxisPlacement3D)
SetLocalPlacement(center: Point3D, xAxis: Vector3D, zAxis: Vector3D)
Ellipsoid3D.SetXRadius(radius: float)
Ellipsoid3D.SetYRadius(radius: float)
Ellipsoid3D.SetZRadius(radius: float)
Ellipsoid3D.__eq__(other: Ellipsoid3D) → bool
Returns True if self equals other.
ExtrudedAreaSolid3D
class NemAll_Python_Geometry.ExtrudedAreaSolid3D(Boost.Python.instance)
Create solid by extruding an area along a given direction vector. The extrude area is defined by an
PolygonalArea3D object.
ExtrudedAreaSolid3D Properties
ExtrudedAreaSolid3D.Direction
ExtrudedAreaSolid3D.ExtrudedArea
ExtrudedAreaSolid3D.RefPoint
ExtrudedAreaSolid3D Methods
ExtrudedAreaSolid3D.__init__(*args)
Multiple method signatures:
__init__()
Default initializer.
__init__(other: ExtrudedAreaSolid3D)
Initialize object from other ExtrudedAreaSolid3D object.
__init__(other: ExtrudedAreaSolid3D, refPoint. Point3D)
Initialize object from other ExtrudedAreaSolid3D object.
ExtrudedAreaSolid3D.GetDirection() → Vector3D
ExtrudedAreaSolid3D.GetExtrudedArea() → PolygonalArea3D
ExtrudedAreaSolid3D.GetRefPoint() → Point3D
ExtrudedAreaSolid3D.IsValid() → bool
ExtrudedAreaSolid3D.SetDirection(vec: Vector3D)
Set direction for extrusion.
ExtrudedAreaSolid3D.SetExtrudedArea(area: PolygonalArea3D)
Set extruded area.
ExtrudedAreaSolid3D.SetRefPoint(refPoint: Point3D)
ExtrudedAreaSolid3D.__eq__(other: ExtrudedAreaSolid3D) → bool
Returns True if self equals other.
ExtrudedAreaSolid3D.__mul__(matrix: Matrix3D) → ExtrudedAreaSolid3D
Matrix transformation.
Line3D
class NemAll_Python_Geometry.Line3D
Line3D Properties
Line3D.EndPoint
Line3D.EndRelPoint
Line3D.RefPoint
Line3D.StartPoint
Line3D.StartRelPoint
Line3D Methods
Line3D.__init__(*args)
.. method:: Line3D.__init__(arg1: object)
__init__(line: Line2D)
Copy Line2D object to Line3D object set z = 0.0
__init__(line: Line3D)
Copy Line3D object.
__init__(start: Point3D, end: Point3D)
Constructs a 3D line from start to end in world coordinates.
__init__(start: Point3D, vec: Vector3D)
Constructs a 3D line from start to start+vec in world coordinates.
__init__(startX: float, startY: float, startZ: float, endX: float, endY: float, endZ: float)
Constructs a 3D line from 6 floats in world coordinates.
__init__(refPoint: Point3D, start: Point3D, end: Point3D)
Constructs a 3D line in local coordinate system.
Line3D.EqualRef(line: Line3D) → bool
Test if reference points are equal.
Line3D.GetCenterPoint() → Point3D
Get the center point in world coordinate system
Line3D.GetCoords() → tuple
Get the coordinates in world coordinate system as tuple (startX, startY, startZ, endX, endY, endZ).
Line3D.GetEndPoint() → Point3D
Line3D.GetEndRelPoint() → Point3D
Line3D.GetRefPoint() → Point3D
Line3D.GetStartPoint() → Point3D
Line3D.GetStartRelPoint() → Point3D
Line3D.GetVector() → Vector3D
Get the vector from start to end point.
Line3D.Is2DLine() → bool
Check, whether the line is a 2D line (both z coordinates are 0.)
Line3D.IsPoint() → bool
Check, whether the line is a point (start point equal end point).
Line3D.Reverse()
Reverse orientation of the line inplace.
Line3D.Set(*args)
Multiple method signatures:
Set(startX: float, startY: float, startZ: float, endX: float, endY: float, endZ: float)
Set line points in world coordinate system from 6 floats.
Set(line: Line3D)
Set line from other 3D line.
Set(start: Point3D, end: Point3D)
Initialize from two points.
Set start- and end points in world coordinate system.
Set(refPoint: Point3D, start: Point3D, end: Point3D)
Set start- and end points in local coordinate system.
Line3D.SetEndPoint(point: Point3D)
Line3D.SetEndRelPoint(point: Point3D)
Line3D.SetRefPoint(refPoint: Point3D)
Line3D.SetStartPoint(point: Point3D)
Line3D.SetStartRelPoint(point: Point3D)
Line3D.TrimEnd(delta: float)
Trim line at the end, delta > 0 shortens the line, delta < 0 extend the line.
Line3D.TrimStart(delta: float)
Trim line at the beginning, delta > 0 shortens the line, delta < 0 extend the line.
Line3D.__eq__(other: Line3D) → bool
Returns True if self equlas other.
Line3D.__mul__(*args) → Line3D
Multiple method signatures:
__mul__(matrix: Matrix2D) → Line3D
2D matrix transformation.
MinMax3D
class NemAll_Python_Geometry.MinMax3D
MinMax3D Properties
MinMax3D.Max
MinMax3D.Min
MinMax3D.SizeX
MinMax3D.SizeY
MinMax3D.SizeZ
MinMax3D Methods
MinMax3D.__init__(*args)
Multiple method signatures:
__init__()
Default initializer.
__init__(min: Point3D, max: Point3D)
Initialize MinMax box with given MIN and MAX points.
__init__(point: Point3D)
Initialize MinMax box with given point.
__init__(minmax: MinMax3D)
Copy constructor.
MinMax3D.Deflate(*args)
Multiple method signatures:
Deflate(size: float)
Deflate in x, y, z axis concurrently.
Deflate(xFactor: float, yFactor: float, xFactor: float)
Deflate in x, y and z axis.
MinMax3D.Get() → tuple
Get minimum and maximum point as tuple (minimum point, maximum point).
MinMax3D.GetCenter() → Point3D
Get box center point
MinMax3D.GetMax() → Point3D
MinMax3D.GetMin() → Point3D
MinMax3D.GetSizeX() → float
MinMax3D.GetSizeY() → float
MinMax3D.GetSizeZ() → float
MinMax3D.Inflate(*args)
Multiple method signatures:
Path3D
class NemAll_Python_Geometry.Path3D(Path)
Class for 3D path geometry
Path3D Methods
Inherited methods see: Path
Path3D.__init__(*args)
Multiple method signatures:
__init__()
__init__(path: Path3D)
Copy constructor
__init__(p1: Point3D, p2: Point3D)
Constructor defines a polyline of 2 points as path.
__init__(p1: Point3D, p2: Point3D, p3: Point3D)
Constructor defines a polyline of 3 points as path.
__init__(p1: Point3D, p2: Point3D, p3: Point3D, p4: Point3D)
Constructor defines a polyline of 4 points as path.
__init__(p1: Point3D, p2: Point3D, p3: Point3D, p4: Point3D, p5: Point3D)
Constructor defines a polyline of 5 points as path.
Path3D.Add(*args)
Add object to this path, start or end point of appended element has to be equal to start or end point of path
Multiple method signatures:
Add(object) → eGeometryErrorCode
Add(path: Path3D) → eGeometryErrorCode
Path3D.DefinitionPoints() → Polyline3D
Extracts all definition points of the path. (join points of sub curves in this path)
Path3D.FirstDefinitionPoint() → Point3D
Extracts the first definition point of the path.
Path3D.GetEndPoint() → Point3D
Path3D.GetEndRelPoint() → Point3D
Path3D.GetStartPoint() → Point3D
Path3D.GetStartRelPoint() → Point3D
Path3D.IsClosed() → bool
Path3D.IsItPossibleToAddElement(*args)
Multiple method signatures:
IsItPossibleToAddElement(object) → bool
Check if the geometry can be added into path Path3D.
IsItPossibleToAddElement(object, tolerance: float) → bool
Check if the geometry can be added into path Path3D (with possible noncontinuous).
Path3D.IsValid() → bool
Path3D.IsValidCurveType(object) → bool
Check if the geometry is supported by Path3D.
Path3D.SetEndPoint(point: Point3D)
Path3D.SetStartPoint(point: Point3D)
Path3D.__eq__(other: Path3D) → bool
Returns true if self equals other.
Path3D.__iadd__(*args) → self
Append operator, start or end point of appended element has to be equal to start or end point of path.
Multiple method signatures:
__iadd__(path: Path3D) → self
__iadd__(line: Line3D) → self
__iadd__(polyline: Polyline3D) → self
__iadd__(arc: Arc3D) → self
__iadd__(spline: Spline3D) → self
__iadd__(bspline: BSpline3D) → self
Plane3D
class NemAll_Python_Geometry.Plane3D
Plane3D Properties
Plane3D.Point
Plane3D.Vector
Plane3D Methods
Plane3D.__init__(*args)
Multiple method signatures:
__init__()
__init__(plane: Plane3D)
Copy constructor
__init__(point: Point3D, normalVector: Vector3D)
Create 3D Plane with given point and vector.
__init__(p1: Point3D, p2: Point3D, p3: Point3D)
Create 3D Plane from three points. If plane can not be computed, then constructor throw geometry excep-
tion ‘Plane3D Incorrect parameters’.
__init__(axis: Axis3D)
Create a plane from a 3D axis
Plane3D.CalcPlaneVectors( -> tuple
Calc X and Y axis vectors for plane, returns tuple (x-vector, y-vector)
Plane3D.GetPoint() → Point3D
Get 3D Plane reference point
Plane3D.GetTransformationMatrix() → Matrix3D
Get transformation matrix for given plane 3D.
Plane3D.GetVector() → Vector3D
Get the Normal Vector.
Plane3D.Set(point: Point3D, normalVector: Vector3D)
Set plane properties from point and vector.
Plane3D.SetPoint(point: Point3D)
Set reference point.
Plane3D.SetVector(vec: Vector3D)
Set the Normal Vector.
Plane3D.__eq__(other: Plane3D) → Plane3D
Returns True if self equals other.
Plane3D.__mul__(*args)
Multiple method signatures:
__mul__(matrix: Matrix2D) → Plane3D
2D matrix transformation.
__mul__(matrix: Matrix3D) → Plane3D
3D matrix transformation.
Polygon3D
class NemAll_Python_Geometry.Polygon3D(PolyPoints3D)
Polygon3D Methods
Inherited methods see: PolyPoints3D
Polygon3D.__init__(*args)
Multiple method signatures:
__init__()
__init__(polygon: Polygon3D)
Copy constructor.
Polygon3D.GetPlane() → Plane3D
Polygon3D.IsValid() → bool
Polygon3D.IsValidStatus() → tuple
Returns tuple (valid True/False, reason if polygon is invalid)
Polygon3D.Normalize(normalizeType: ePolygonNormalizeType, extra_smooth: bool)
Normalization of 3D polygon.
Parameters
• normalizeType – Normalization type
• extra_smooth – Increase level of details
Polygon3D.NormalizeNoThrow(normalizeType: ePolygonNormalizeType, extra_smooth: bool) → ob-
ject
Normalize 3D polygon, same as Normalize, but method doesn’t throw exception, just return error code.
Parameters
• normalizeType – Normalization type
• extra_smooth – Increase level of details
Returns Error code (eOK, eAllocError, eStructuralError, eWrongShape)
Polygon3D.Reverse()
Reverse the point order inplace, separately for every subpolygon.
Polygon3D.__eq__(other: Polygon3D) → bool
Returns True if self equals other.
Polygon3D.__iadd__(*args)
Inplace append operator.
Multiple method signatures:
__iadd__(polygon: Polygon3D) → self
__iadd__(point: Point3D) → self
Polygon3D.__mul__(matrix: matrix3D) → Polygon3D
Matrix transformation
PolygonalArea3D
class NemAll_Python_Geometry.PolygonalArea3D(PolygonalArea)
Class for 3D polygonal area geometry
PolygonalArea3D Properties
PolygonalArea3D.RefPoint
PolygonalArea3D Methods
PolygonalArea3D.__init__(*args)
Multiple method signatures:
__init__()
__init__(verticesCount: int, edgesCount: int)
Create initialized 3D polygonal area with expected vertices and edges count.
__init__(refPoint: Point3D, verticesCount: int, edgesCount: int)
Create initialized 3D polygonal area with expected vertices and edges count.
__init__(apolygon: PolygonalArea3D)
Parameter: polygon 3D polygonal area which will be copied.
PolygonalArea3D.AppendRelVertex(vertex: Point3D) → tuple
Append vertex in local coordinate system.
Returns tuple(Error code, index of vertex)
PolygonalArea3D.AppendVertex(vertex: Point3D) → tuple
Append vertex in world coordinate system.
Returns tuple(Error code, index of vertex)
PolygonalArea3D.EqualRef(polygon: PolygonalArea3D) → bool
Test for equal reference points.
PolygonalArea3D.GetEdgeVertices(edgeIndex: int) → tuple
Get edge vertices.
Returns tuple(Error code, start point of the edge in WCS, end point of the edge in WCS)
PolygonalArea3D.GetPolygon() → tuple
Returns tuple(Error code, polygon)
PolygonalArea3D.GetRefPoint() → Point3D
PolygonalArea3D.GetRelVertex(vertexIndex: int) → tuple
Get vertex in local coordinate system.
Returns tuple(Error code, vertex in local coordinate system)
PolygonalArea3D.GetVertex(vertexIndex: int) → tuple
Get vertex in world coordinate system.
Returns (Error code, vertex in WCS)
PolygonalArea3D.Reverse() → object
Reverse the point order of boundary polygons of the area.
Returns Error code
PolygonalArea3D.SetRefPoint(refPoint: Point3D) → object
Returns Error code.
Polyhedron3D
class NemAll_Python_Geometry.Polyhedron3D
Polyhedron3D represents a 3D solid defined by vertices, edges and faces. Polyhedron includes table of vertices, table
of edges and table of faces. Each table is zero based indexed.
Edge is defined via GeometryEdge as two indices into vertices table. Geometry edge is default oriented from start to
end index.
Face is defined via PolyhedronFace as a vector of oriented edges. Oriented edge (OrientedEdge) has EdgeHandle and
orientation flag. EdgeHandle is index into polyhedron table of all edges, it mean that values of EdgeHandle can be
from range [0..EdgesCount-1]. This handle can be increased and decreased in standard way. When orientation flag is
true, then orientation is same as GeometryEdge (from Start to End index), if flag is false then orientation is backward
(from End to Start index).
Polyhedron3D Methods
Polyhedron3D.__init__(*args)
Multiple method signatures:
__init__()
__init__(polyhedronType: PolyhedronType, verticesCount: int, edgesCount: int, facesCount: int, neg-
ativeOrientation: bool)
The Count parameters have sense only for appropriate polyhedron type and specified a memory allocation
size - performance optimization. In case of any error, constructor throw an exception.
see also PolyhedronType
__init__(polyhedron: Polyhedron3D)
Copy constructor
Polyhedron3D.AppendEdge(edge: GeometryEdge) → object
Append edge, in Allplan 2017 not accessible from Python.
Returns Error code
Polyhedron3D.Clear(*args)
Mulitple method signatures:
Clear()
Clear all vertices, edges and faces. Type and vertices, edges, faces preallocation size of polyhedron will be
preserved.
Clear(verticesCount: int, edgesCount: int, facesCount: int, negativeOrientation: bool)
Clear all vertices, edges and faces.
The Count parameters have sense only for appropriate polyhedron type and specified a memory allocation
size - performance optimization. In case of any error, constructor throw an exception.
Polyhedron3D.CreateCuboid(*args)
Mulitple method signature:
CreateCuboid(p1: Point3D, p2: Point3D) → Polyhedron3D
Static constructor for cuboid
Parameters
• p1 – lower point of min/max box that states the cuboid’s size
• p2 – lower point of min/max box that states the cuboid’s size
CreateCuboid(box: MinMax3D) → Polyhedron3D
Static constructor for cuboid
Parameters box – min/max box that states the cuboid’s size
CreateCuboid(dx: float, dy: float, dz: float) → Polyhedron3D
Create the cuboid from the three size values
Parameters
• dx – cuboid’s size in x direction
• dy – cuboid’s size in y direction
• dz – cuboid’s size in z direction
Polyhedron3D.CreateFace(expectedEdges: int) → PolyhedronFace
Create face and append it to polyhedron, returns created face.
Polyhedron3D.DeleteEdge(edgeIndex: int) → object
Delete edge at specified index.
Returns Error code
Polyhedron3D.DeleteFace(faceIndex: int) → object
Delete face at specified index.
Returns Error code
Polyhedron3D.EqualRef(polyhedron: Polyhedron3D) → bool
Test for equal reference point.
Polyhedron3D.GetEdge(*args)
Multiple method signatures:
GetEdge(edgeIndex: int) → tuple
Get edge at the specified index.
Returns tuple(Error code, Filled edge)
PolyhedronFace
class NemAll_Python_Geometry.PolyhedronFace(Boost.Python.instance)
All constructors are prohibited, only Polyhedron3D can instantiate this class. This behavior is dependant on old
Allplan architecture and can be changed.
PolyhedronFace Methods
PolyhedronFace.__init__(face: PolyhedronFace)
Copy constructor
PolyhedronFace.AppendEdge(*args)
Multiple method signatures:
AppendEdge(edgeHandle: int, positiveOrientation: bool)
Append edge to face.
AppendEdge(edge: OrientedEdge)
Append edge to face.
PolyhedronFace.AppendEdges(edges: OrientedEdgeList)
Append edges to face.
PolyhedronFace.GetEdge(edgeIndex: int) → tuple
Get the edge index on specified position
Returns tuple(error: bool, edge index)
PolyhedronFace.GetEdges() → OrientedEdgeList
PolyhedronFace.GetEdgesCount() → int
PolyhedronFace.GetFlags() → int
PolyhedronFace.SetFlags(flags: int)
Polyline3D
class NemAll_Python_Geometry.Polyline3D(PolyPoints3D)
Polyline3D Methods
Inherited methods see: PolyPoints3D
Polyline3D.__init__(*args)
Multiple method signatures:
__init__()
__init__(polyline: Polyline3D)
Copy constructor.
__init__(polyline: Polyline3D, skip: int, count: int)
Copy constructor with limited scope.
Parameters
• polyline – Polyline which will be copied
• skip – count of points ignored at start.
• count – count of points copied.
Polyline3D.GetLine(index: int) → Line3D
Polyline3D.GetLines() → Line3DList
Polyline3D.IsPlanar() → tuple
Check if polyline is on one plane.
Return tuple(True/False if polyline is on one plane, calculated plane if True)
Polyline3D.IsValid() → bool
Polyline3D.LineCount() → int
Polyline3D.Reverse()
Reverse Polyline orientation.
Polyline3D.__eq__(other: Polyline3D) → bool
Returns True if self equals other.
Polyline3D.__iadd__(*args)
Multiple method signatures:
__iadd__(polyline: Polyline3D) → self
Append all points of polyline inplace.
__iadd__(point: Point3D) → self
Append point inplace.
__iadd__(line: Line3D) → self
Append all points of line inplace.
Parameter: line Line3D which will be added to the polyline
Spline3D
class NemAll_Python_Geometry.Spline3D(PolyPoints3D)
Spline3D Properties
Spline3D.EndVector
Spline3D.StartVector
Spline3D Methods
Inherited methods see: PolyPoints3D
Spline3D.__init__(*args)
Multiple method signatures:
__init__()
__init__(spline: Spline3D)
Copy constructor.
__init__(spline: Spline2D, z: float=0)
Copy constructor.
Spline3D.CalculateEndVector() → Vector3D
Spline3D.CalculatePoint(param: float) → Point3D
Calculates point on spline at position param.
Spline3D.CalculateStartVector() → Vector3D
Spline3D.GetControlPoints() → tuple
Compute bezier control points.
Returns tuple(error code, vector of control points)
Spline3D.GetEndVector() → Vector3D
Spline3D.GetStartVector() → Vector3D
Spline3D.IsClosed() → bool
Spline3D.IsCollinear() → bool
Return True if spline is collinear - all control points are on same line.
Spline3D.IsPlanar() → tuple
Returns tuple(True if planar, if True the plane)
Spline3D.Reverse()
Reverse of current spline, reverse spline using PolyPoints.reverse() and swapping tangents.
Spline3D.SetEndVector(vec: Vector3D)
Spline3D.SetStartVector(vec: Vector3D)
Spline3D.__eq__(other: Spline3D) → bool
Returns True if self equals other.
Spline3D.__iadd__(point: Point3D) → self
Append point inplace.
Service Classes
Service classes do not represent an object, instead they provide static class methods to modify other objects. Most
service classes have no properties and can not (and need not) instantiated from Python.
ChamferCalculus
class NemAll_Python_Geometry.ChamferCalculus
Class for chamfer calculation between two objects.
ChamferCalculus.Calculate(*args)
Multiple method signatures:
Calculate(polyhedron: Polyhedron3D, chamferWidth: float) → tuple
Calculate chamfer on all edges of given Polyhedron3D.
Returns error code, resulting polyhedron
Calculate(polyhedron: Plyhedron3D, edges: VecSizeTList, chamferWidth: float, propagation: bool)
→ tuple
Calculate chamfer on selected edges of given Polyhedron3D, set propagation=True for propagation of
neighboring edges.
Returns error code, resulting polyhedron
Calculate(brep: BRep3D, chamferWidth: width) → tuple
Calculate chamfer on all edges of given BRep3D.
Returns error code, resulting BRep
Calculate(brep: BRep3D, edges: VecSizeTList, chamferWidth: float, propagation. bool) → tuple
Calculate chamfer on selected edges of given BRep3D, set propagation=True for propagation of neighbor-
ing edges.
Returns error code, resulting BRep
ChamferCalculus.CalculateApplicableChamfers(*args)
Calculates applicable chamfer lines between two objects.
Multiple method signatures:
CalculateApplicableChamfers(line1: Line2D, line2: Line2D, intersectionPoint: Point2D,
chamferWidth: width) → Line2DList
Calculates four applicable chamfer lines.
Returns calculated 4 applicable chamfer lines
CalculateApplicableChamfers(igeo1, igeo2, plane3D: Plane3D, intersectionPoint. Point3D,
chamferWidth: float) → Line3DList
Calculates four applicable chamfer lines as Line2DList object.
Parameters
• igeo1 – Geometry of first object
• igeo2 – Geometry of second object
• plane3D – 3D plane in which objects lie
• intersectionPoint – Intersection point of 2 chamfered objects
• chamferWidth – Chamfer width
Comparison
class NemAll_Python_Geometry.Comparison
Class for comparison between two objects.
Comparison.Equal(first, second, tol: float) → bool
Returns True if first equals second with given tolerance.
Multiple method signatures:
Equal(first: float, second: float, tol: float) → bool
Equal(first: Point2D, second: Point2D, tol: float) → bool
Equal(first: Point3D, second: Point3D, tol: float) → bool
Equal(first: Vector2D, second: Vector2D, tol: float) → bool
Equal(first: Vector3D, second: Vector3D, tol: float) → bool
Equal(first: Line2D, second: Line2D, tol: float) → bool
Equal(first: Line3D, second: Line3D, tol: float) → bool
Equal(first: Spline2D, second: Spline2D, tol: float) → bool
Equal(first: Clothoid2D, second: Clothoid2D, tol: float) → bool
Equal(first: Arc2D, second: Arc2D, tol: float) → bool
Equal(first: Arc3D, second: Arc3D, tol: float) → bool
Equal(first: BSpline2D, second: BSpline2D, tol: float) → bool
DivisionPoints
FilletCalculus2D
class NemAll_Python_Geometry.FilletCalculus2D
Class for fillet3d calculation between two 2D objects
FilletCalculus2D Methods
FilletCalculus2D.__init__(*args)
Multiple method signatures:
__init__(geoObj1: IGeometry, geoObj2: IGeometry, radius: float)
__init__(line1: Line2D, line2: Line2D, radius: float)
__init__(line: Line2D, arc: Arc2D, radius: float)
__init__(arc1: Arc2D, arc2: Arc2D, radius: float)
__init__(arc: Arc2D, point: Point2D)
__init__(line: Line2D, point: Point2D)
FilletCalculus2D.ClickedOnObject(*args)
Multiple method signatures:
FilletCalculus3D
class NemAll_Python_Geometry.FilletCalculus3D(Boost.Python.instance)
Class for 3D fillet3d calculation. This class cannot be instantiated from Python.
FilletCalculus3D Methods
FilletCalculus3D.Calculate(*args)
Multiple method signatures:
Calculate(line1: Line3D, line2: Line3D, radius: float) → tuple
Calculate fillet3d between two coplanar 3d lines
Returns (error code, resulting first Line3D, resulting second Line3D, calculated fillet3d)
Calculate(line1: Line3D, line2: Line3D) → tuple
Calculate fillet3d between two parallel non collinear 3d lines. The end point of the first line must lie on
the same plane as start point of the second line and plane is perpendicular to both lines.
Returns (error code, calculated fillet3d)
Calculate(line1: Line3D, endPoint: eLinePointIdentification, polyline: Polyline3D, startLineIndex:
int, endLineIndex: int, radius: float) → tuple
Calculate fillet3d between line1 and line2. Line2 is created as line between end point of line1 (by parameter
endPoint) and point from polyline (limited with startPointIndex and endPointIndex).
Parameters
• line1 – Line 1 for fillet3d
• endPoint – Sign for line2 (from where point of line1 should be start line2)
• polyline – Polyline (buffer of end points for line2)
• startLineIndex – Start point index for polyline
• endLineIndex – End point index for polyline
• radius – radius of fillet3d
Returns (error code, Line 1 from fillet3d calculation, Line 2 from fillet3d calculation, Calculated
fillet3d)
Calculate(polyhedron: Polyhedron3D, edges: VecSizeTList, radius: float, propagation: bool) →
tuple
Calculate fillet3d on selected edges of given Polyhedron3D.
Parameters
TransformCoord
class NemAll_Python_Geometry.TransformCoord
Functions for point transformation between the local and global element coordinate system. This class cannot
be instantiated from Python.
TransformCoord.PointGlobal(*args)
Transforms a local 2D point p, or local x distance into a global 3D point. The local coordinate is defined by a
Line2D, Arc2D, Polygon2D, Line3D object.
PointGlobal(arg1: Polygon2D, xdist: float) → Point3D
Transform a local x distance to a global 3D point
PointGlobal(axis: Line3D, xdist: float) → Point3D
Transform a local x distance to a global 3D point. axis defines the x-axis of the local 2D coordinate system
in world coordinates.
PointGlobal(arg1: Arc2D, xdist: float) → Point3D
Transform a local x distance to a global 3D point.
PointGlobal(axis: Line2D, xdist: float) → Point3D
Transform a local x distance to a global 3D point. axis defines the x-axis of the local 2D coordinate system
in world coordinates.
PointGlobal(axis: Line2D, p: Point2D) → Point3D
Transform a local 2D point to a global 3D point. axis defines the x-axis of the local 2D coordinate system
in world coordinates.
TransformCoord.PointLocal(*args)
Transforms a global point p (2D/3D) into a local 2D coordinate system. The local coordinate is defined by a
Line2D, Polyline2D, Arc2D, Polygon2D, Line3D object.
PointLocal(arg1: Polyline2D, p: Point2D) → Point2D
Transform a global 2D point to a local 2D point
ENum Classes
PolyhedronType
class NemAll_Python_Geometry.PolyhedronType
Type of polyhedron visual representation
PolyhedronType.tEdges
PolyhedronType.tFaces
PolyhedronType.tInvalid
PolyhedronType.tVolume
Offset3DPlane
class NemAll_Python_Geometry.Offset3DPlane
Definition of plane on which offset of 3D elements will be calculated
Offset3DPlane.eNoPlane
Offset3DPlane.eXY
Offset3DPlane.eXZ
Offset3DPlane.eYZ
eApproximationSettingsType
class NemAll_Python_Geometry.eApproximationSettingsType
Type of Approximation setting. Used for identification of Approximation settings type.
eApproximationSettingsType.ASET_BREP_TESSELATION
eApproximationSettingsType.ASET_MAX_DISTANCE
eApproximationSettingsType.ASET_MAX_LENGTH
eApproximationSettingsType.ASET_SEGMENTATION
eBoolOpResult
class NemAll_Python_Geometry.eBoolOpResult
Used for an identification of boolean operation’s result.
eBoolOpResult.eClip
eBoolOpResult.eInside
eBoolOpResult.eOutside
eBoxPoint
class NemAll_Python_Geometry.eBoxPoint
Dedicated location of the box
4 8 3
9 5 7
1 6 2
eBoxPoint.eCenter
eBoxPoint.eLeftBottom
eBoxPoint.eLeftTop
eBoxPoint.eMiddleBottom
eBoxPoint.eMiddleLeft
eBoxPoint.eMiddleRight
eBoxPoint.eMiddleTop
eBoxPoint.eRightBottom
eBoxPoint.eRightTop
eClothoidType
class NemAll_Python_Geometry.eClothoidType
Clothoid type identification
eClothoidType.eClothoid
eClothoidType.eParabolaGeneral
eClothoidType.eParabolaQuadratic
eFilletErrorCode
class NemAll_Python_Geometry.eFilletErrorCode
Enumeration of error codes for Fillet
eFilletErrorCode.eERROR_LINES_ARENOT_COPLANAR
eFilletErrorCode.eERROR_LINES_ARE_COLLINEAR
eFilletErrorCode.eERROR_LINES_ARE_NOT_PARALLEL
eFilletErrorCode.eERROR_LINES_ARE_PARALLEL
eFilletErrorCode.eERROR_NO_FILLET_CREATED
eFilletErrorCode.eERROR_ZEROO_LINE_LENGTH
eFilletErrorCode.eNO_ERROR
eGeometryErrorCode
class NemAll_Python_Geometry.eGeometryErrorCode(Boost.Python.enum)
Geometry error codes
eGeometryErrorCode.eAllocError
eGeometryErrorCode.eError
eGeometryErrorCode.eInvalid3DLine
eGeometryErrorCode.eOK
eGeometryErrorCode.eOutOfRange
eGeometryErrorCode.eStructuralError
eGeometryErrorCode.eWarpedPolygonalFace
eGeometryErrorCode.eWrongShape
eLinePointIdentification
class NemAll_Python_Geometry.eLinePointIdentification
Start and end point identification, used for better identification of start and end point.
eLinePointIdentification.END_POINT
eLinePointIdentification.START_POINT
ePolygonHealingSettings
class NemAll_Python_Geometry.ePolygonHealingSettings
Type of Healing settings for polygon, used for identification of Healing settings type for polygon.
ePolygonHealingSettings.PHSET_NOMODIFY
ePolygonHealingSettings.PHSET_NORMALIZE
ePolygonNormalizeType
class NemAll_Python_Geometry.ePolygonNormalizeType
Type of Polygon2D normalization.
ePolygonNormalizeType.DEFAULT_NORM_TYPE
ePolygonNormalizeType.HATCHING_MEASUR_NORM_TYPE
ePolygonNormalizeType.HATCHING_NORM_TYPE
ePolygonNormalizeType.SIDEFACE_NORM_TYPE
ePolygonNormalizeType.STARTPOINT_NORM_TYPE
ePolyhedronHealingSettings
class NemAll_Python_Geometry.ePolyhedronHealingSettings
Type of Healing settings for polyhedron, used for identification of Healing settings type for polyhedron.
ePolyhedronHealingSettings.HSET_NOMODIFY
ePolyhedronHealingSettings.HSET_TILT
ePolyhedronHealingSettings.HSET_TRIANGULATE
ePolyhedronHealingSettings.HSET_UNKNOWN
eProjectionMatrixType
class NemAll_Python_Geometry.eProjectionMatrixType
Type of projection in Matrix3D, used for an identification of what kind of projection is in Matrix3D.
eProjectionMatrixType.BOTTOM_2D
eProjectionMatrixType.FREE_3D
eProjectionMatrixType.FRONT_2D
eProjectionMatrixType.LEFT_2D
eProjectionMatrixType.REAR_2D
eProjectionMatrixType.RIGHT_2D
eProjectionMatrixType.TOP_2D
eServiceResult
class NemAll_Python_Geometry.eServiceResult
Service results
eServiceResult.NO_ERR
eSplitResult
class NemAll_Python_Geometry.eSplitResult
Used for split operation’s result.
eSplitResult.eSplitInvalidArgs
eSplitResult.eSplitInvalidGeometry
eSplitResult.eSplitNone
eSplitResult.eSplitOk
eSurfaceTrimParam
class NemAll_Python_Geometry.eSurfaceTrimParam
Trimming curve surface param for naturally trimmed surfaces.
eSurfaceTrimParam.eTrimUMaxValue
eSurfaceTrimParam.eTrimUMaxValueReverse
eSurfaceTrimParam.eTrimUMinValue
eSurfaceTrimParam.eTrimUMinValueReverse
eSurfaceTrimParam.eTrimUndefined
eSurfaceTrimParam.eTrimVMaxValue
eSurfaceTrimParam.eTrimVMaxValueReverse
eSurfaceTrimParam.eTrimVMinValue
eSurfaceTrimParam.eTrimVMinValueReverse
eValidationStatusPolygon3D
class NemAll_Python_Geometry.eValidationStatusPolygon3D
Validation status of 3D Polygon.
eValidationStatusPolygon3D.VS_COLINEAR
eValidationStatusPolygon3D.VS_NOT_COPLANAR
Functions
CalcAngle
CalcLength
CalcMass
CalcMinMax
CalcSurface
CalcVolume
Convert3DRotation
CreateBRep3D
CreateFrustumOfPyramid
CreateLoftedBRep3D
CreatePlanarBRep3D
CreatePolygon3DFromIndex
CreatePolyhedron
NemAll_Python_Geometry.CreatePolyhedron(*args) → tuple
Returns tuple(error code, 3D Polyhedron)
NemAll_Python_Geometry.CreatePolyhedron(polyhedronType: PolyhedronType, verticesCount:
int, edgeCount: int, faceCount: int, negativeOri-
entation: bool) → tuple
Create and initialize new Polyhedron3D
Parameters
• polyhedronType – Polyhedron type - edges, faces or volume.
• verticesCount – Count of expected vertices.
• edgeCount – Count of expected edges.
• faceCount – Count of expected faces.
• negativeOrientation – True for negative orientation.
NemAll_Python_Geometry.CreatePolyhedron(solid: ClippedSweptSolid3D) → tuple
Create polyhedron from input parametric solid
NemAll_Python_Geometry.CreatePolyhedron(solid: ExtrudedAreaSolid3D) → tuple
Create polyhedron from input parametric solid
NemAll_Python_Geometry.CreatePolyhedron(cylinder: Cylinder3D, countOfSegments: int) →
tuple
Create polyhedron from input Cylinder
NemAll_Python_Geometry.CreatePolyhedron(brep: BRep3D, options: ApproximationSettings)
→ tuple
Create polyhedron as approximation of arbitrary BRep3D
Parameters
• brep – arbitrary BRep3D
• options – approximation settings
NemAll_Python_Geometry.CreatePolyhedron(polygon: Polygon3D) → tuple
Create polyhedron from Polygon3D
NemAll_Python_Geometry.CreatePolyhedron(line: Line3D) → tuple
Create polyhedron from Line3D
NemAll_Python_Geometry.CreatePolyhedron(lines: Line3DList) → tuple
Create polyhedron from vector of 3D lines
NemAll_Python_Geometry.CreatePolyhedron(polyline: Polyline3D) → tuple
Create polyhedron from Polyline3D
NemAll_Python_Geometry.CreatePolyhedron(igeo: object, options: ApproximationSettings) →
tuple
Create polyhedron from arbitrary solid
Parameters
• igeo – Reference to IGeometry3D
• options – ApproximationSettings structure holding options for approximation
NemAll_Python_Geometry.CreatePolyhedron(base: Polygon3D, path: Polyline3D) → tuple
Create translation polyhedron from base polygon and path
Parameters
• base – base polygon
• path – translation path
NemAll_Python_Geometry.CreatePolyhedron(base: Polygon2D, refPoint: Point2D, path: Poly-
line3D) → tuple
Create translation polyhedron from base polygon and path
Parameters
• base – base polygon 2D
• refPoint – reference point used for transformation
• path – translation path
NemAll_Python_Geometry.CreatePolyhedron(polygon: Polygon2D, bottomPlane: Plane3D, top-
Plane: Plane3D) → tuple
Create translation polyhedron from 2D polygon, bottom and top plane.
Parameters
• polygon – polygon 2D
• bottomPlane – the bottom plane
• topPlane – the top plane
NemAll_Python_Geometry.CreatePolyhedron(baseOutline: Polygon2D, leftOffset: float, rightOff-
set: float, frontOffset: float, backOffset: float, bot-
tomPlane: Plane3D, topPlane: Plane3D) → tuple
Create conical polyhedron from 2D polygon, given offsets, bottom and top plane
Parameters
• baseOutline – base outline polygon 2D (rectangle of 4 points)
• leftOffset – offset from base outline on the left side
• rightOffset – offset from base outline on the right side
• frontOffset – offset from base outline on the front side
• backOffset – offset from base outline on the back side
• bottomPlane – element’s bottom plane
• topPlane – element’s top plane
NemAll_Python_Geometry.CreatePolyhedron(startPolygon: Polygon3D, endPolygon: Poly-
gon3D) → tuple
Create a polyhedron from a 3D start and end polygon
Parameters
• startPolygon – Start polygon
• endPolygon – End polygon
CreatePolyline3DFromIndex
CreateRailSweptBRep3D
CreateRevolvedBRep3D
CreateSweptBRep3D
CreateSweptPolyhedron3D
DeletePolyhedronLastFace
GetRotationMatrix
Parameters
• zeroPoint – Rotation point
• angle – Rotation angle
NemAll_Python_Geometry.GetRotationMatrix(axis: Axis3D, angle: Angle) → Matrix3D
Creates 3D rotation matrix
Parameters
• axis – Rotation axis
• angle – Rotation angle
NemAll_Python_Geometry.GetRotationMatrix(line: Line3D, angle: Angle) → Matrix3D
Creates 3D rotation matrix
Parameters
• line – Rotation line, extended to axis
• angle – Rotation angle
IntersectionCalculus
IntersectionCalculusEx
MakeIntersection
MakeSubtraction
MakeUnion
Move
Offset
Rotate
Split
Transform
ASET_BREP_TESSELATION = eApproximationSettingsType.ASET_BREP_TESSELATION
ASET_MAX_DISTANCE = eApproximationSettingsType.ASET_MAX_DISTANCE
ASET_MAX_LENGTH = eApproximationSettingsType.ASET_MAX_LENGTH
ASET_SEGMENTATION = eApproximationSettingsType.ASET_SEGMENTATION
BOTTOM_2D = eProjectionMatrixType.BOTTOM_2D
DEFAULT_NORM_TYPE = ePolygonNormalizeType.DEFAULT_NORM_TYPE
END_POINT = eLinePointIdentification.END_POINT
FREE_3D = eProjectionMatrixType.FREE_3D
FRONT_2D = eProjectionMatrixType.FRONT_2D
FT_CC_CONCETRIC = eFilletType.FT_CC_CONCETRIC
FT_CC_NO_INTERSECTION = eFilletType.FT_CC_NO_INTERSECTION
FT_CC_ONE_INTERSECTION = eFilletType.FT_CC_ONE_INTERSECTION
FT_CC_TWO_INTERSECTION = eFilletType.FT_CC_TWO_INTERSECTION
FT_KK_KURVE_ELEMENTS = eFilletType.FT_KK_KURVE_ELEMENTS
FT_KK_PARALLEL_KURVE_ELEMENTS = eFilletType.FT_KK_PARALLEL_KURVE_ELEMENTS
FT_LC_NO_INTERSECTION = eFilletType.FT_LC_NO_INTERSECTION
FT_LC_ONE_INTERSECTION = eFilletType.FT_LC_ONE_INTERSECTION
FT_LC_TWO_INTERSECTION = eFilletType.FT_LC_TWO_INTERSECTION
FT_LL_INTERSECTION_AT_THE_END = eFilletType.FT_LL_INTERSECTION_AT_THE_END
FT_LL_INTERSECTION_ON_LINE = eFilletType.FT_LL_INTERSECTION_ON_LINE
FT_LL_INTERSECTION_OUT_OF_LINES = eFilletType.FT_LL_INTERSECTION_OUT_OF_LINES
FT_LL_PARALLEL_LINES = eFilletType.FT_LL_PARALLEL_LINES
FT_UNKNOWN = eFilletType.FT_UNKNOWN
HATCHING_MEASUR_NORM_TYPE = ePolygonNormalizeType.HATCHING_MEASUR_NORM_TYPE
HATCHING_NORM_TYPE = ePolygonNormalizeType.HATCHING_NORM_TYPE
HSET_NOMODIFY = ePolyhedronHealingSettings.HSET_NOMODIFY
HSET_TILT = ePolyhedronHealingSettings.HSET_TILT
HSET_TRIANGULATE = ePolyhedronHealingSettings.HSET_TRIANGULATE
HSET_UNKNOWN = ePolyhedronHealingSettings.HSET_UNKNOWN
LEFT_2D = eProjectionMatrixType.LEFT_2D
PHSET_NOMODIFY = ePolygonHealingSettings.PHSET_NOMODIFY
PHSET_NORMALIZE = ePolygonHealingSettings.PHSET_NORMALIZE
REAR_2D = eProjectionMatrixType.REAR_2D
RIGHT_2D = eProjectionMatrixType.RIGHT_2D
SIDEFACE_NORM_TYPE = ePolygonNormalizeType.SIDEFACE_NORM_TYPE
STARTPOINT_NORM_TYPE = ePolygonNormalizeType.STARTPOINT_NORM_TYPE
START_POINT = eLinePointIdentification.START_POINT
TOP_2D = eProjectionMatrixType.TOP_2D
VS_COLINEAR = eValidationStatusPolygon3D.VS_COLINEAR
VS_NOT_COPLANAR = eValidationStatusPolygon3D.VS_NOT_COPLANAR
eAllocError = eGeometryErrorCode.eAllocError
eCenter = eBoxPoint.eCenter
eClip = eBoolOpResult.eClip
eClothoid = eClothoidType.eClothoid
eERROR_LINES_ARENOT_COPLANAR = eFilletErrorCode.eERROR_LINES_ARENOT_COPLANAR
eERROR_LINES_ARE_COLLINEAR = eFilletErrorCode.eERROR_LINES_ARE_COLLINEAR
eERROR_LINES_ARE_NOT_PARALLEL = eFilletErrorCode.eERROR_LINES_ARE_NOT_PARALLEL
eERROR_LINES_ARE_PARALLEL = eFilletErrorCode.eERROR_LINES_ARE_PARALLEL
eERROR_NO_FILLET_CREATED = eFilletErrorCode.eERROR_NO_FILLET_CREATED
eERROR_ZEROO_LINE_LENGTH = eFilletErrorCode.eERROR_ZEROO_LINE_LENGTH
eError = eGeometryErrorCode.eError
eInside = eBoolOpResult.eInside
eInvalid3DLine = eGeometryErrorCode.eInvalid3DLine
eLeftBottom = eBoxPoint.eLeftBottom
eLeftTop = eBoxPoint.eLeftTop
eMiddleBottom = eBoxPoint.eMiddleBottom
eMiddleLeft = eBoxPoint.eMiddleLeft
eMiddleRight = eBoxPoint.eMiddleRight
eMiddleTop = eBoxPoint.eMiddleTop
eNO_ERROR = eFilletErrorCode.eNO_ERROR
eNoPlane = Offset3DPlane.eNoPlane
eOK = eGeometryErrorCode.eOK
eOutOfRange = eGeometryErrorCode.eOutOfRange
eOutside = eBoolOpResult.eOutside
eParabolaGeneral = eClothoidType.eParabolaGeneral
eParabolaQuadratic = eClothoidType.eParabolaQuadratic
eRightBottom = eBoxPoint.eRightBottom
eRightTop = eBoxPoint.eRightTop
eSplitInvalidArgs = eSplitResult.eSplitInvalidArgs
eSplitInvalidGeometry = eSplitResult.eSplitInvalidGeometry
eSplitNone = eSplitResult.eSplitNone
eSplitOk = eSplitResult.eSplitOk
eStructuralError = eGeometryErrorCode.eStructuralError
eTrimUMaxValue = eSurfaceTrimParam.eTrimUMaxValue
eTrimUMaxValueReverse = eSurfaceTrimParam.eTrimUMaxValueReverse
eTrimUMinValue = eSurfaceTrimParam.eTrimUMinValue
eTrimUMinValueReverse = eSurfaceTrimParam.eTrimUMinValueReverse
eTrimUndefined = eSurfaceTrimParam.eTrimUndefined
eTrimVMaxValue = eSurfaceTrimParam.eTrimVMaxValue
eTrimVMaxValueReverse = eSurfaceTrimParam.eTrimVMaxValueReverse
eTrimVMinValue = eSurfaceTrimParam.eTrimVMinValue
eTrimVMinValueReverse = eSurfaceTrimParam.eTrimVMinValueReverse
eWarpedPolygonalFace = eGeometryErrorCode.eWarpedPolygonalFace
eWrongShape = eGeometryErrorCode.eWrongShape
eXY = Offset3DPlane.eXY
eXZ = Offset3DPlane.eXZ
eYZ = Offset3DPlane.eYZ
tEdges = PolyhedronType.tEdges
tFaces = PolyhedronType.tFaces
tInvalid = PolyhedronType.tInvalid
tVolume = PolyhedronType.tVolume
NemAll_Python_IFW_Input
Classes
AddMsgInfo
class NemAll_Python_IFW_Input.AddMsgInfo
AddMsgInfo Methods
AddMsgInfo.__init__()
BaseElementAdapter
class NemAll_Python_IFW_Input.BaseElementAdapter
BaseElementAdapter Methods
BaseElementAdapter.__init__(arg1: object)
BuildingElementInputControls
class NemAll_Python_IFW_Input.BuildingElementInputControls
BuildingElementInputControls Methods
BuildingElementInputControls.__init__()
BuildingElementInputControls.CloseControls()
Close the input controls.
185
allpy Documentation, Release 0.1.0
CNOI_DocumentWrapper
class NemAll_Python_IFW_Input.CNOI_DocumentWrapper
CNOI_DocumentWrapper Methods
CNOI_DocumentWrapper.__init__()
CoordinateInput
class NemAll_Python_IFW_Input.CoordinateInput(InputViewDocumentData)
CoordinateInput Methods
CoordinateInput.__init__()
CoordinateInput.GetCurrentPoint(*args)
Get and mark the current input point.
Returns Current input point
Multiple method signatures:
GetCurrentPoint() → CoordinateInputResult
GetCurrentPoint(startPnt: Point3D) → CoordinateInputResult
End point input is possible by a distance input to the input point of the last input step.
Parameters startPnt – Starting point
GetCurrentPoint(startPnt: Point3D, bStartPnt: bool) → CoordinateInputResult
End point input is possible by a distance input to the input point of the last input step.
Parameters
• startPnt – Starting point
• bStartPnt – Starting point is active True/False.
GetCurrentPoint(bStartPnt: bool) → CoordinateInputResult
End point input is possible by a distance input to the input point of the last input step.
Parameters bStartPnt – Starting point is active True/False.
CoordinateInput.GetInputControlIntValue() → int
Get the integer value from the value input control.
CoordinateInput.GetInputControlValue(arg1: CoordinateInput) → float
Get the double value from the value input control.
CoordinateInput.GetInputPoint(*args)
Get the current input point
Returns Current input point result.
Multiple method signatures:
CoordinateInput.SetInputPlane(plane: Plane3D)
Set the input plane.
The input point will be transformed to the input plane: True/False ?????
Parameters plane – input plane
CoordinateInputMode
class NemAll_Python_IFW_Input.CoordinateInputMode
CoordinateInputMode Methods
CoordinateInputMode.__init__()
CoordinateInputResult
class NemAll_Python_IFW_Input.CoordinateInputResult
CoordinateInputResult Methods
CoordinateInputResult.__init__()
CoordinateInputResult.GetPoint() → Point3D
DocumentAdapter
class NemAll_Python_IFW_Input.DocumentAdapter
DocumentAdapter Methods
DocumentAdapter.__init__()
DocumentAdapter.GetDocumentID() → int
ElementSelect
class NemAll_Python_IFW_Input.ElementSelect
ElementSelect Methods
ElementSelect.__init__()
ElementSelect.InitSelection(arg2: InputStringConvert)
ElementSelect.IsMouseMove(mouseMsg: int) → bool
Parameters mouseMsg – Mouse message WM_xxx
HandleService
class NemAll_Python_IFW_Input.HandleService
HandleService Methods
HandleService.__init__()
InputStringConvert
class NemAll_Python_IFW_Input.InputStringConvert
InputStringConvert Methods
InputStringConvert.__init__(*args)
Multiple method signature:
__init__(arg2: int)
__init__(arg2: str) → object
Construct the InputStringConvert by a std::wstring
InputViewDocumentData
class NemAll_Python_IFW_Input.InputViewDocumentData
InputViewDocumentData Methods
InputViewDocumentData.__init__()
InputViewDocumentData.GetInputViewDocument() → DocumentAdapter
Get the input view document.
InputViewDocumentData.GetViewWorldProjection() → ViewWorldProjection
Get the view-world projection object.
ValueInputControlData
class NemAll_Python_IFW_Input.ValueInputControlData
ValueInputControlData Methods
ValueInputControlData.__init__(*args)
Multiple method signature:
__init__()
__init__(ctrlType: eValueInputControlType, bSetFocus: bool, bDisableCoord: bool)
Constructor to create a control with standard behavior defined by the control type.
Parameters
• ctrlType – Control type
• bSetFocus – True/False Set the input focus to the control
• bDisableCoord – True/False Input inside the external control disables the coordinate
controls
ViewWorldProjection
class NemAll_Python_IFW_Input.ViewWorldProjection
ViewWorldProjection Methods
ViewWorldProjection.__init__(arg1: object)
ViewWorldProjection.GetDocumentID() → int
ViewWorldProjection.GetEyePoint() → Point3D
Get eye point of current projection. (eye point = camera location)
ViewWorldProjection.GetIsoProjection() → eProjectionType
Get the isometric projection of the view.
ViewWorldProjection.GetPixelFactor() → tuple
Get factor of pixel to world coordinates. Used when you need calculate how much millimeters are one pixel.
Returns tuple(pixel factor in x direction, pixel factor in y direction)
ViewWorldProjection.GetScreenScale() → float
Get the screen scale.
ViewWorldProjection.GetSearchRadiusByPixel(pixel: int) → float
Get search radius in millimeter(?) in view size(?).
Parameters pixel – search radius in screen pixels.
ViewWorldProjection.GetViewAngle() → float
Get the rotation angle of the view.
ViewWorldProjection.GetViewPoint() → Point3D
Get view point of current projection. View point is point where you are looking (focused) (view target point?).
View point lie in plain of drawn data.
ViewWorldProjection.GetViewSize() → Vector2D
Get the size of the view.
ViewWorldProjection.GetViewZAngle() → float
Get the rotation angle of the view in z-direction. (?)
ViewWorldProjection.IsAssistWindow() → bool
ViewWorldProjection.IsCentralProjection() → bool
ViewWorldProjection.IsFreeProjection() → bool
ViewWorldProjection.IsGroundplanView() → bool
ViewWorldProjection.IsInView(pnt: Point2D) → bool
ViewWorldProjection.IsIsometricProjection() → bool
ViewWorldProjection.IsSideView() → bool
ViewWorldProjection.ProjectionToWorld(pnt: Point2D, refPnt: Point3D) → Point3D
Get the world 3D point from a projection 2D point and a reference point.
Parameters
• pnt – View Point
• refPnt – Reference point with the additional coordinate
Returns World 3D point
ViewWorldProjection.ViewPerpendicularToWorld(line3D: Line3D, pnt: Point3D) → Point3D
Transform a view perpendicular point to a world perpendicular point.
Parameters
• line3D – 3D perpendicular line
• pnt – Reference point for the perpendicular
Returns World perpendicular point
ViewWorldProjection.ViewToPixel(pnt: Point2D, bBottomTop: bool, considerZoomwindow: bool)
→ Point2D
Transform a view point to a pixel coordinate.
Parameters
• pnt – View point
• bBottomTop – True/False if the y zero point is on the bottom of the screen
• considerZoomwindow – True/False if the position is in a zoom window, then the zoom
window will be used for the calculation
Returns Pixel view point
ViewWorldProjection.ViewToWorld(pnt: Point2D, z: float) → Point3D
Transform a view point to a world point.
Parameters
• pnt – View point
• z – z-coordinate
Returns World point
ViewWorldProjection.ViewToWorldBaseZ(pnt: Point2D, zWorld: float) → Point3D
Transform a view point to a world point with resulting z-coordinate.
Parameters
• pnt – View point
• zWorld – Z-coordinate
ViewWorldProjection.WorldToWorldPlane(*args)
Multiple method signatures:
WorldToWorldPlane(pnt: Point3D, plane: Plane3D) → Point3D
Transform a world point to a plane point.
Parameters
• pnt – World point
• plane – Plane
Returns Plane point in world coordinates
WorldToWorldPlane(line: Line3D, plane: Plane3D) → Line3D
Transform a world line to a plane line.
Parameters
• line – World line
• plane – Plane
Returns Plane line in world coordinates
ENums
eProjectionType
class NemAll_Python_IFW_Input.eProjectionType
Projection type of the view
eProjectionType.EAST_VIEW
eProjectionType.FREE_ONLY_3D
eProjectionType.FREE_VIEW
eProjectionType.GROUND_PLAN
eProjectionType.NORTH_EAST_VIEW
eProjectionType.NORTH_VIEW
eProjectionType.NORTH_WEST_VIEW
eProjectionType.SOUTH_EAST_VIEW
eProjectionType.SOUTH_VIEW
eProjectionType.SOUTH_WEST_VIEW
eProjectionType.WEST_VIEW
eProjectionType.WORKING_PLANE_VIEW
eValueInputControlType
class NemAll_Python_IFW_Input.eValueInputControlType
Type of the value input control
eValueInputControlType.eANGLE_COMBOBOX
eValueInputControlType.eCONTROL_EXTERNAL
eValueInputControlType.eCONTROL_NONE
eValueInputControlType.eCOORDINATE_EDIT
eValueInputControlType.eCOORDINATE_EDIT_FIX
eValueInputControlType.eCOORDINATE_EDIT_GE0
eValueInputControlType.eCOORDINATE_EDIT_GT0
eValueInputControlType.eDIMENSION_EDIT
eValueInputControlType.eINT_COMBOBOX
eValueInputControlType.eINT_EDIT
eValueInputControlType.eNUMBER_EDIT_1
eValueInputControlType.eNUMBER_EDIT_1_GE0
eValueInputControlType.eROTATION_ANGLE_STEP
eValueInputControlType.eTEXT_EDIT
eValueInputControlType.eWALL_PLACEMENT
NemAll_Python_IFW_Input.eDIMENSION_EDIT
NemAll_Python_IFW_Input.eINT_COMBOBOX
NemAll_Python_IFW_Input.eINT_EDIT
NemAll_Python_IFW_Input.eNUMBER_EDIT_1
NemAll_Python_IFW_Input.eNUMBER_EDIT_1_GE0
NemAll_Python_IFW_Input.eROTATION_ANGLE_STEP
NemAll_Python_IFW_Input.eTEXT_EDIT
NemAll_Python_IFW_Input.eWALL_PLACEMENT
NemAll_Python_Palette
Classes
PythonWpfPalette
class NemAll_Python_Palette.PythonWpfPalette
PythonWpfPalette Methods
PythonWpfPalette.__init__()
PythonWpfPalette.Close()
PythonWpfPalette.EnableControl(arg2: str, name: int, bEnabled: bool)
Enable/disable a control
Parameters
• name – Name of the control
• bEnabled – Enabled True/False
PythonWpfPalette.GetPythonWpfPaletteBuilder() → PythonWpfPaletteBuilder
PythonWpfPalette.Open(title: str, partName: str)
Open the palette
Parameters
• title – Title
• partName – Name of the PythonPart
PythonWpfPalette.Reset(clearOnlyPages: bool)
Reset the palette for a full refresh, if clearOnlyPages is True: reset only pages, keep other dialog data settings.
199
allpy Documentation, Release 0.1.0
PythonWpfPalette.UpdateDialogData(arg2: int)
Refresh palette with current dialog data
PythonWpfPaletteBuilder
class NemAll_Python_Palette.PythonWpfPaletteBuilder
PythonWpfPaletteBuilder Methods
PythonWpfPaletteBuilder.__init__(dialogData)
Constructor
PythonWpfPaletteBuilder.AddAngleValue(description: str, name: str, value:str, page: int, ex-
panderName: str, rowName: str, bEnabled: bool)
Add a angle value to the palette.
Parameters
• description – Description
• name – Value name
• value – Value
• page – Page index
• expanderName – Expander section name
• rowName – Name of the row
• bEnabled – Control is enabled: true/false
PythonWpfPaletteBuilder.AddBarDiameter(description: str, name: str, value:str, ctrl-
Type:PaletteCtrlType, page: int, expanderName: str,
rowName: str, bEnabled: bool)
Add an bar diameter value to the palette
Parameters
• description – Description
• name – Value name
• value – Value
• ctrlType – PaletteCtrlType
• page – Page index
• expanderName – Expander section name
• rowName – Name of the row
• bEnabled – Control is enabled: true/false
PythonWpfPaletteBuilder.AddBendingRollerValue(description: str, name: str, value:str,
ctrlType:PaletteCtrlType, page: int, ex-
panderName: str, rowName: str, bEn-
abled: bool)
Add a bending roller value to the palette
Parameters
• description – Description
• name – Value name
• value – Value
• ctrlType – PaletteCtrlType
• page – Page index
• expanderName – Expander section name
• rowName – Name of the row
• bEnabled – Control is enabled: true/false
PythonWpfPaletteBuilder.AddButton(description: str, name: str, eventId: int, page: int, expander-
Name: str, rowName: str, bEnabled: bool)
Add a picture button to the palette.
Parameters
• description – Description
• name – Value name
• eventId – Value holds the event ID pressing the button
• page – Page index
• expanderName – Expander section name
• rowName – Name of the row
• bEnabled – Control is enabled: true/false
PythonWpfPaletteBuilder.AddCheckboxValue(description: str, name: str, value: int, page: int,
expanderName: str, rowName: str, bEnabled:
bool)
Add a checkbox value to the palette.
Parameters
• description – Description
• name – Value name
• value – Value
• page – Page index
• expanderName – Expander section name
• rowName – Name of the row
• bEnabled – Control is enabled: true/false
PythonWpfPaletteBuilder.AddColorValue(description: str, name: str, value: int, page: int, ex-
panderName: str, rowName: str, bEnabled: bool)
Add a color value to the palette.
Parameters
• description – Description
• name – Value name
• value – Value
• page – Page index
• expanderName – Expander section name
• rowName – Name of the row
ENums
PaletteCtrlType
class NemAll_Python_Palette.PaletteCtrlType
Types of the palette controls
PaletteCtrlType.ARRAYBUTTON
PaletteCtrlType.BUTTON
PaletteCtrlType.CANVAS
PaletteCtrlType.CHECK
PaletteCtrlType.COMBO
PaletteCtrlType.COMBOCOLOR
PaletteCtrlType.COMBODRAWINGTYPE
PaletteCtrlType.COMBOFACESTYLE
PaletteCtrlType.COMBOHATCH
PaletteCtrlType.COMBOLAYER
PaletteCtrlType.COMBOMATNAME
PaletteCtrlType.COMBOPATTERN
PaletteCtrlType.COMBOPEN
PaletteCtrlType.COMBOREINFBARDIAM
PaletteCtrlType.COMBOREINFBARGRADE
PaletteCtrlType.COMBOREINFCONCRGRADE
PaletteCtrlType.COMBOREINFMESH
PaletteCtrlType.COMBOREINFMESHGROUP
PaletteCtrlType.COMBOREINFNORM
PaletteCtrlType.COMBOSTROKE
PaletteCtrlType.EDIT
PaletteCtrlType.ELLIPS
PaletteCtrlType.GROUPBOX
PaletteCtrlType.INFIELD
PaletteCtrlType.LINE
PaletteCtrlType.PICTURE
PaletteCtrlType.PICTUREBUTTON
PaletteCtrlType.PICTURELIST
PaletteCtrlType.POLY
PaletteCtrlType.RECT
PaletteCtrlType.STATIC
PaletteCtrlType.TEXT
PaletteValueType
class NemAll_Python_Palette.PaletteValueType
Types of the palette values
PaletteValueType.ANGLE
PaletteValueType.DOUBLE
PaletteValueType.INTEGER
PaletteValueType.LENGTH
PaletteValueType.STRING
NemAll_Python_Reinforcement
Classes
Some classes just work inside an running Allplan instance, this means, to test function or classes which use this
services, you have to mock them in your development environment.
AllplanElement
class NemAll_Python_Reinforcement.AllplanElement
AllplanElement Methods
AllplanElement.GetAttributes() → object
Returns Attributes object
AllplanElement.GetCommonProperties() → CommonProperties
AllplanElement.GetGeometryObject() → object
Returns Geometry object
AllplanElement.SetAttributes(attributesObject)
AllplanElement.SetCommonProperties(commonProp: CommonProperties)
AllplanElement.SetGeometryObject(geometryObject)
AnchorageLengthService
class NemAll_Python_Reinforcement.AnchorageLengthService
Service class for the anchorage length calculation. Works just inside an running Allplan instance.
213
allpy Documentation, Release 0.1.0
AnchorageLengthService Methods
AnchorageLengthService.__init__()
AnchorageLengthService.Calculate(concreteGrade: int, steelGrade: int, diameter: float, asMesh:
float, bDoubleBar: bool, meshBarDistCross: float, bMesh:
bool, barDistance: float, roundLength: float)
AnchorageLengthService.CalculateBar(concreteGrade: int, steelGrade: int, diameter: float,
bDoubleBar: bool, barDistance: float, roundLength:
float)
AnchorageLengthService.GetAnchorageLength() → float
AnchorageLengthService.GetAnchorageType() → AnchorageType
AnchorageLengthService.GetAsFactor() → float
Get the as factor required / available
Returns As mesh factor
AnchorageLengthService.GetCompositionZone() → int
AnchorageLengthService.GetHookAngle() → float
AnchorageLengthService.GetL1() → float
AnchorageLengthService.GetL2() → float
AnchorageLengthService.GetL3() → float
AnchorageLengthService.GetLongitudinalOffset() → float
AnchorageLengthService.GetOverlapLength() → float
AnchorageLengthService.IsCompressionBar() → bool
AnchorageLengthService.SetAnchorageType(anchorageType: AnchorageType)
AnchorageLengthService.SetAsFactor(asFactor: float)
Set the as factor required / available
Parameters asFactor – As factor required / available
AnchorageLengthService.SetCompositionZone(compositionZone: int)
AnchorageLengthService.SetCompressionBar(bCompressionBar: bool)
AnchorageLengthService.SetHookAngle(hookAngle: float)
AnchorageLengthService.SetLongitudinalOffset(longitudinalOffset: float)
BarPlacement
class NemAll_Python_Reinforcement.BarPlacement(ReinfElement)
BarPlacement Methods
BarPlacement.__init__(*args)
.. method:: BarPlacement.__init__(arg1: object)
__init__(positionNumber: int, barCount: int, distVec: Vector3D, startPnt: Point3D, endPnt: Point3D,
bendingShape: BendingShape)
Constructor for linear placement.
Parameters
BarPlacement.Move(transVec: Vector3D)
Move the placement
BarPlacement.SetBendingShape(shape: BendingShape)
Set the reinforcement shape.
BarPlacement.SetDistanceVector(distVec: Vector3D)
BarPlacement.SetEndBendingShape(shape: BendingShape)
Set the reinforcement shape at the end.
BarPlacement.SetPositionNumber(positionNumber: int)
BarPlacement.SetRotationAxis(rotationAxis: Line3D)
BarPlacement.Transform(transMat: Matrix3D)
Transform the placement
BendingRollerList
class NemAll_Python_Reinforcement.BendingRollerList(NemAll_Python_Geometry.AbstractList)
BendingRollerService
class NemAll_Python_Reinforcement.BendingRollerService
Service class for the bending roller calculation. Works just inside an running Allplan instance.
BendingRollerService Methods
BendingRollerService.GetBendBendingRollerFactor(diameter: float, steelGrade: int, con-
creteGrade: int) → float
BendingRollerService.GetBendingRoller(diameter: float, steelGrade: int, concreteGrade: int,
bStirrup: bool) → float
BendingRollerService.GetBendingRollerFactor(diameter: float, steelGrade: int, concrete-
Grade: int, bStirrup: bool) → float
BendingRollerService.GetDefaultBendingRollers(norm: NormType) → VecDoubleList
BendingShape
class NemAll_Python_Reinforcement.BendingShape
BendingShape Methods
BendingShape.__init__(*args)
Multiple method signatures:
__init__()
__init__(shapePol: Polyline3D, bendingRoller: VecDoubleList, diameter: float, steelGrade: int, con-
creteGrade: int, bendingShapeType: BendingShapeType)
Constructor for reinforcement bar.
Parameters
• shapePol – Shape polyline
• bendingRoller – Bending roller
• diameter – Diameter
Parameters
• shapePol – Shape polyline
• bendingRoller – Bending roller
• meshType – Mesh type
• meshBendingDirection – Mesh bending direction
• steelGrade – Steel grade
• concreteGrade – Concrete grade (index of the global list starting from 0, -1 = use
global value from the Allplan settings)
• bendingShapeType – Bending shape type
• hookLengthStart – Hook length at the start of the shape
• hookAngleStart – Hook angle at the start of the shape
• hookTypeStart – Hook type at the start of the shape
• hookLengthEnd – Hook length at the end of the shape
• hookAngleEnd – Hook angle at the end of the shape
• hookTypeEnd – Hook type at the end of the shape
BendingShape.__init__(other: BendingShape)
Copy constructor
BendingShape.GetBendingRoller() → VecDoubleList
BendingShape.GetDiameter() → float
BendingShape.GetHookAngleEnd() → float
BendingShape.GetHookAngleStart() → float
BendingShape.GetHookLengthEnd() → float
BendingShape.GetHookLengthStart() → float
BendingShape.GetMeshBendingDirection() → MeshBendingDirection
BendingShape.GetMeshType() → str
BendingShape.GetShapePolyline() → Polyline3D
BendingShape.GetSteelGrade() → int
BendingShape.IsValid() → bool
BendingShape.Move(tranVec: Vector3D)
BendingShape.Rotate(*args)
Multiple method signatures:
Rotate(modelAngles: object)
Rotate the shape
Parameters modelAngles – Model angles
Rotate(modelAngles: object, refPnt: Point3D)
Rotate the shape
Parameters
• modelAngles – Model angles
GeometryExpansionUtil
class NemAll_Python_Reinforcement.GeometryExpansionUtil
Works just inside an running Allplan instance.
GeometryExpansionUtil Methods
GeometryExpansionUtil.__init__(*args)
Multiple method signatures:
__init__()
__init__(arg: AddMsgInfo)
GeometryExpansionUtil.GetLineAbove(ref_pnt: Point2D, base_line: Line2D, orientation: bool)
→ tuple
Get the line ‘above’ the base line and the placement point.
Parameters
• ref_pnt – 2D reference point in WCS
• base_line – base line as Line2D object, start- and end point in WCS
• orientation – True/False, swaps start- and end point of result line
Returns a tuple(success, line)
•success is True/False
•line as Line2D object, start- and end point in WCS
•success is True/False
•line as Line2D object, start- and end point in WCS
•success is True/False
•line as Line2D object, start- and end point in WCS
•z_min minimum z coordinate in WCS as float
•z_max maximum z coordinate in WCS as float
•asso_ref_ele associative reference element of type: NemAll_Python_IFW_Input.
BaseElementAdapter
•model_matrix model transformation matrix
•success is True/False
•line as Line2D object, start- and end point in WCS
HookLengthService
class NemAll_Python_Reinforcement.HookLengthService
Service class for the hook length calculation. Works just inside an running Allplan instance.
HookLengthService Methods
HookLengthService.__init__(norm: int, concreteGrade: int, steelGrade: int, bExactLength: bool)
HookLengthService.GetHookLength(hookAngle: float, hookType: HookType, diameter: float) →
float
HookLengthService.GetHookLengthPartFromBendingRoller(hookAngle: float, hookType:
HookType, diameter: float) →
float
Calculate the hook length part from the beginning of the bending roller.
MeshData
class NemAll_Python_Reinforcement.MeshData
MeshData Properties
MeshData.AsCross
Get the as in cross direction
MeshData.AsLongitudinal
Get the as in longitudinal direction
MeshData.DiameterCross
Get the diameter in cross direction
MeshData.DiameterLongitudinal
Get the diameter in longitudinal direction
MeshData.DistanceCross
Get the distance in cross direction
MeshData.DistanceLongitudinal
Get the distance in longitudinal direction
MeshData.IsDoubleBarCross
Get the double bar state in cross direction
MeshData.IsDoubleBarLongitudinal
Get the double bar state in longitudinal direction
MeshData.Label
Get the mesh label
MeshData.Length
Get the mesh length
MeshData.OverlapCross
Get the overlap in cross direction
MeshData.OverlapLongitudinal
Get the overlap in longitudinal direction
MeshData.Type
Get the mesh type
MeshData.Weight
Get the mesh weight
MeshData.Width
Get the mesh width
MeshData Methods
MeshData.__init__(*args)
Multiple method signatures:
__init__()
__init__(type: str, length: float, width: float, diameterLongitudinal: float, diameterCross: float,
asLongitudinal: float, asCross: float, distanceLongitudinal: float, distanceCross: float,
bDoubleBarLongitudinal: bool, bDoubleBarCross: bool, overlapLongitudinal: float, over-
lapCross: float, weight: float)
Constructor
Parameters
• type – Mesh type
• length – Mesh length
• width – Mesh width
• diameterLongitudinal – Diameter in longitudinal direction
• diameterCross – Diameter in cross direction
• asLongitudinal – As in longitudinal direction
• asCross – As in cross direction
• distanceLongitudinal – Distance in longitudinal direction
• distanceCross – Distance in cross direction
• bDoubleBarLongitudinal – Double bar in longitudinal direction
• bDoubleBarCross – Double bar in cross direction
• overlapLongitudinal – Overlap in longitudinal direction
• overlapCross – Overlap in cross direction
• weight – Mesh weight
MeshData.CreateLabel()
Create the label
MeshData.Format(type: str, length: float, width: float) → str
Get the mesh text.
Parameters
• type – Mesh type
• length – Mesh length
• width – Mesh width
Returns Mesh text
MeshData.GetAsBendingDirection(bendingDirection: MeshBendingDirection) → float
Get the as in bending direction.
MeshData.GetDiameterBendingDirection(bendingDirection: MeshBendingDirection) → tuple
Get the diameter in bending direction.
Returns tuple(diameter in bending direction, double bar state)
MeshData.GetDimensions() → tuple
Get the mesh dimensions
Returns tuple(mesh length, mesh width)
MeshData.GetDistanceBendingDirection(bendingDirection: MeshBendingDirection) → float
MeshPlacement
class NemAll_Python_Reinforcement.MeshPlacement(ReinfElement)
MeshPlacement Methods
MeshPlacement.__init__(*args)
Multiple method signatures:
__init__()
__init__(positionNumber: int, widthVec: Vector3D, bendingShape: BendingShape)
Constructor
Parameters
• positionNumber – Position number
• widthVec – Width vector of the mesh
• bendingShape – Mesh shape
MeshPlacement.GetBendingShape() → BendingShape
Get the shape polyline
MeshPlacement.GetPositionNumber() → int
MeshPlacement.GetWidthVector() → Vector3D
MeshPlacement.Move(transVec: Vector3D)
Move the placement.
MeshPlacement.SetBendingShape(shape: BendingShape)
Set the reinforcement shape.
MeshPlacement.SetPositionNumber(positionNumber: int)
MeshPlacement.SetWidthVector(widthVec: Vector3D)
MeshPlacement.Transform(transMat: Matrix3D)
Transform the placement
ReinfElement
class NemAll_Python_Reinforcement.ReinfElement(AllplanElement)
ReinforcementSettings
class NemAll_Python_Reinforcement.ReinforcementSettings(Boost.Python.instance)
ReinforcementSettings Methods
ReinforcementSettings.__init__(arg1: object)
ReinforcementSettings.GetBarDiameter() → float
ReinforcementSettings.GetBendingRoller() → float
ReinforcementSettings.GetConcreteGrade() → int
ReinforcementSettings.GetMeshGroup() → int
ReinforcementSettings.GetMeshType() → str
ReinforcementSettings.GetNorm() → int
ReinforcementSettings.GetSteelGrade() → int
ReinforcementShapeBuilder
class NemAll_Python_Reinforcement.ReinforcementShapeBuilder(Boost.Python.instance)
Helper class to create BendingShape objects. Works just inside an running Allplan instance.
Before adding points by AddPoint(), set as starting point by SetStartPoint(). AddPoints() does
this automatically.
ReinforcementShapeBuilder Methods
ReinforcementShapeBuilder.__init__(*args)
Multiple method signatures:
__init__()
__init__(shapePlaneMatrix: Matrix3D)
Constructor
Parameters shapePlaneMatrix – Matrix of the plane for the real shape calculation
ReinforcementShapeBuilder.AddPoint(*args)
Add an additional formwork point. Important: set a starting point by SetStartPoint().
Multiple method signatures:
AddPoint(pnt: Point2D, concreteCover: float, bendingRoller: float)
Add an end point of a geometry side. Create a local 2D bending shape in the XY-plane.
AddPoint(pnt: Point3D, concreteCover: float, bendingRoller: float)
Add an end point of a geometry side. Create a global 3D bending shape in WCS.
ReinforcementShapeBuilder.AddPoints(pointList)
Add the shape geometry points as python list of tuples. Important: append the end cover value as single float
after the last point of the bending shape. [(p1, c1), (p2, c2), (p3, c3), end_cover]
Parameters pointList – a Python list of tuples (Point2D/3D, concrete_cover[, bend-
ing_roller_factor]), the bending roller factor is optional, if absent the default bending roller at
CreateShape() is used.
ReinforcementShapeBuilder.AddSide(*args)
Add geometry side as line by two points, points as Point2D or Point3D objects.
Multiple method signatures:
AddSide(startPnt: Point2D, endPnt: Point2D, concreteCover: float, bendingRoller: float)
Add a geometry side of the shape.
Parameters
• startPnt – Start point of the geometry side
• endPnt – End point of the geometry side
• concreteCover – Concrete cover
Parameters
• startPnt – Start point of the concrete cover line at the start of the shape
• endPnt – Endpoint of the concrete cover line at the start of the shape
• concreteCover – Concrete cover
SetConcreteCoverLineStart(startPnt: Point3D, endPnt: Point3D, concreteCover: float)
ReinforcementShapeBuilder.SetConcreteCoverStart(concreteCover: float)
Set the concrete cover at the start of the shape
ReinforcementShapeBuilder.SetHookEnd(length: float, angle: float, type: HookType)
Set the hook at the end of the shape
param length Hook length (0 = calculate)
param angle Hook angle
param type Hook type
ReinforcementShapeBuilder.SetHookStart(length: float, angle: float, type: HookType)
Set the hook at the start of the shape
param length Hook length (0 = calculate)
param angle Hook angle
param type Hook type
ReinforcementShapeBuilder.SetOverlapLengthEnd(arg1: ReinforcementShapeBuilder)
Set an overlap length a the end of the shape.
ReinforcementShapeBuilder.SetOverlapLengthStart(arg1: ReinforcementShapeBuilder)
Set an overlap length a the start of the shape.
ReinforcementShapeBuilder.SetSideLengthEnd(sideLength: float)
Set the side length at the end of the shape.
ReinforcementShapeBuilder.SetSideLengthStart(sideLength: float)
Set the side length at the start of the shape.
ReinforcementShapeBuilder.SetStartPoint(*args)
Multiple method signatures:
SetStartPoint(startPnt: Point2D)
SetStartPoint(startPnt: Point3D)
ReinforcementUtil
class NemAll_Python_Reinforcement.ReinforcementUtil
ReinforcementUtil Methods
ReinforcementUtil.__init__()
ReinforcementUtil.GetNextBarPositionNumber(doc: DocumentAdapter) → int
ReinforcementUtil.GetNextMeshPositionNumber(doc: DocumentAdapter) → int
ENums
AnchorageType
class NemAll_Python_Reinforcement.AnchorageType
Types of the anchorage
AnchorageType.eAnchorageHook
AnchorageType.eAnchorageHookOneCrossBar
AnchorageType.eAnchorageStraight
AnchorageType.eAnchorageStraightOneCrossBar
AnchorageType.eAnchorageStraightTwoCrossBars
BendingShapeType
class NemAll_Python_Reinforcement.BendingShapeType(Boost.Python.enum)
Type of the bending shape
BendingShapeType.BarSpacer
BendingShapeType.CircleStirrup
BendingShapeType.ColumnStirrup
BendingShapeType.Freeform
BendingShapeType.LShapedBar
BendingShapeType.LongitudinalBar
BendingShapeType.LongitudinalBarDoubleBentOf
BendingShapeType.LongitudinalBarFourTimesBentOff
BendingShapeType.LongitudinalBarSingleBentOff
BendingShapeType.OpenStirrup
BendingShapeType.SHook
BendingShapeType.Stirrup
BendingShapeType.TorsionStirrup
HookType
class NemAll_Python_Reinforcement.HookType
Types of the hooks
HookType.eAnchorage
HookType.eAngle
HookType.eStirrup
MeshBendingDirection
class NemAll_Python_Reinforcement.MeshBendingDirection
Types of the mesh bending direction
MeshBendingDirection.CrossBars
MeshBendingDirection.LongitudinalBars
NormType
class NemAll_Python_Reinforcement.NormType
Types of the norms
NormType.eNORM_AS
NormType.eNORM_BS
NormType.eNORM_DIN
NormType.eNORM_DIN_1
NormType.eNORM_DIN_H
NormType.eNORM_EC2
NormType.eNORM_EHE
NormType.eNORM_NEN
NormType.eNORM_NF
NormType.eNORM_OE
NormType.eNORM_SIA
NormType.eNORM_SNIP
NormType.eNORM_SNIP2003
NormType.eNormNo
StirrupType
class NemAll_Python_Reinforcement.StirrupType
Types of the stirrups
StirrupType.Column
StirrupType.Diamond
StirrupType.FullCircle
StirrupType.Normal
StirrupType.Torsion
NemAll_Python_Reinforcement.eNORM_NEN
NemAll_Python_Reinforcement.eNORM_NF
NemAll_Python_Reinforcement.eNORM_OE
NemAll_Python_Reinforcement.eNORM_SIA
NemAll_Python_Reinforcement.eNORM_SNIP
NemAll_Python_Reinforcement.eNORM_SNIP2003
NemAll_Python_Reinforcement.eNormNo
NemAll_Python_Reinforcement.eStirrup
NemAll_Python_Utility
Classes
AbstractList
class NemAll_Python_Utility.AbstractList
This type does not really exists, it is just a helper class for documentation.
AbstractList Methods
AbstractList.__init__()
AbstractList.__contains__(item) → bool
AbstractList.__delitem__(item)
AbstractList.__getitem__(item) → object
AbstractList.__iter__() → object
AbstractList.__len__() → int
AbstractList.__repr__() → str
AbstractList.__setitem__(item, value)
AbstractList.append(value)
AbstractList.count(value) → int
AbstractList.extend(iterable)
AbstractList.index(value) → int
AbstractList.insert(index: int, item)
AbstractList.pop() → int
233
allpy Documentation, Release 0.1.0
SizeTList
class NemAll_Python_Utility.SizeTList(AbstractList)
VecByteList
class NemAll_Python_Utility.VecByteList(AbstractList)
VecDoubleList
class NemAll_Python_Utility.VecDoubleList(AbstractList)
VecIntList
class NemAll_Python_Utility.VecIntList(AbstractList)
VecSizeTList
class NemAll_Python_Utility.VecSizeTList(AbstractList)
VecStringList
class NemAll_Python_Utility.VecStringList(AbstractList)
VecULongList
class NemAll_Python_Utility.VecULongList(AbstractList)
Time
class NemAll_Python_Utility.Timer
Time Methods
Time.PrintTime(flag: bool)
Time.__init__(*args)
Multiple method signature:
__init__()
__init__(timer: Timer)
Functions
NemAll_Python_Utility.EnablePythonDebug()
NemAll_Python_Utility.ShowMessageBox(message: str, flags: int) → int
Allplan 2017.1
class ChamferCalculus
AppendVertex(vertex: Point3D)
Without this method it is not possible to create your own 3D objects by ‘hand’, using vertices, edges and faces.
237
allpy Documentation, Release 0.1.0
News
239
allpy Documentation, Release 0.1.0
Document License
Unless otherwise stated, the content of this document is licensed under Creative Commons Attribution-ShareAlike 3.0
License
241
allpy Documentation, Release 0.1.0
• genindex
• modindex
• search
243
allpy Documentation, Release 0.1.0
a
allpy, 15
allpy.build, 23
allpy.colors, 29
allpy.env, 17
allpy.geo, 21
allpy.pyp, 19
allpy.util, 27
allpy.workbench, 25
n
NemAll_Python_AllplanSettings, 39
NemAll_Python_ArchElements, 43
NemAll_Python_BaseElements, 45
NemAll_Python_BasisElements, 51
NemAll_Python_Geometry, 75
NemAll_Python_IFW_Input, 185
NemAll_Python_Palette, 199
NemAll_Python_Reinforcement, 213
NemAll_Python_Utility, 233
245
allpy Documentation, Release 0.1.0
247
allpy Documentation, Release 0.1.0
248 Index
allpy Documentation, Release 0.1.0
Index 249
allpy Documentation, Release 0.1.0
method), 53 method), 65
__init__() (NemAll_Python_BasisElements.ElementGroupElement
__init__() (NemAll_Python_BasisElements.TextProperties
method), 53 method), 66
__init__() (NemAll_Python_BasisElements.ElementGroupProperties
__init__() (NemAll_Python_BasisElements.TextureDefinition
method), 54 method), 66, 67
__init__() (NemAll_Python_BasisElements.EndSymbolsProperties
__init__() (NemAll_Python_BasisElements.TextureMapping
method), 54 method), 67, 68
__init__() (NemAll_Python_BasisElements.FaceStyleElement__init__() (NemAll_Python_Geometry.AbstractList
method), 54 method), 94
__init__() (NemAll_Python_BasisElements.FaceStyleProperties
__init__() (NemAll_Python_Geometry.ApproximationSettings
method), 55 method), 89
__init__() (NemAll_Python_BasisElements.FillingElement __init__() (NemAll_Python_Geometry.Arc2D method),
method), 55 100
__init__() (NemAll_Python_BasisElements.FillingProperties__init__() (NemAll_Python_Geometry.Arc3D method),
method), 56 117
__init__() (NemAll_Python_BasisElements.HatchingElement __init__() (NemAll_Python_Geometry.Axis2D method),
method), 56 90
__init__() (NemAll_Python_BasisElements.HatchingProperties
__init__() (NemAll_Python_Geometry.Axis3D method),
method), 56 92
__init__() (NemAll_Python_BasisElements.MacroElement __init__() (NemAll_Python_Geometry.AxisPlacement2D
method), 57 method), 91
__init__() (NemAll_Python_BasisElements.MacroGroupElement
__init__() (NemAll_Python_Geometry.AxisPlacement3D
method), 57 method), 93
__init__() (NemAll_Python_BasisElements.MacroGroupProperties
__init__() (NemAll_Python_Geometry.BRep3D
method), 58 method), 119
__init__() (NemAll_Python_BasisElements.MacroPlacementElement
__init__() (NemAll_Python_Geometry.BSpline2D
method), 58 method), 102
__init__() (NemAll_Python_BasisElements.MacroPlacementProperties
__init__() (NemAll_Python_Geometry.BSpline3D
method), 59 method), 123
__init__() (NemAll_Python_BasisElements.MacroProperties__init__() (NemAll_Python_Geometry.BSplineSurface3D
method), 60 method), 124
__init__() (NemAll_Python_BasisElements.MacroSlideElement
__init__() (NemAll_Python_Geometry.BoundingBox2D
method), 60 method), 103
__init__() (NemAll_Python_BasisElements.MacroSlideProperties
__init__() (NemAll_Python_Geometry.ClippedSweptSolid3D
method), 61 method), 125, 126
__init__() (NemAll_Python_BasisElements.ModelElement2D __init__() (NemAll_Python_Geometry.ClosedArea2D
method), 61 method), 106
__init__() (NemAll_Python_BasisElements.ModelElement3D __init__() (NemAll_Python_Geometry.ClosedAreaComposite2D
method), 62 method), 106
__init__() (NemAll_Python_BasisElements.PatternCurveProperties
__init__() (NemAll_Python_Geometry.ClosedAreaComposite3D
method), 63 method), 127
__init__() (NemAll_Python_BasisElements.PatternElement __init__() (NemAll_Python_Geometry.Clothoid2D
method), 63 method), 107
__init__() (NemAll_Python_BasisElements.PatternProperties
__init__() (NemAll_Python_Geometry.Cone3D method),
method), 64 127
__init__() (NemAll_Python_BasisElements.Symbol2DElement __init__() (NemAll_Python_Geometry.ConicalSurface3D
method), 64 method), 128, 129
__init__() (NemAll_Python_BasisElements.Symbol2DProperties
__init__() (NemAll_Python_Geometry.Cuboid3D
method), 64 method), 129
__init__() (NemAll_Python_BasisElements.Symbol3DElement __init__() (NemAll_Python_Geometry.Cylinder3D
method), 64, 65 method), 131
__init__() (NemAll_Python_BasisElements.Symbol3DProperties
__init__() (NemAll_Python_Geometry.DivisionPoints
method), 65 method), 151
__init__() (NemAll_Python_BasisElements.TextElement __init__() (NemAll_Python_Geometry.Ellipsoid3D
250 Index
allpy Documentation, Release 0.1.0
Index 251
allpy Documentation, Release 0.1.0
252 Index
allpy Documentation, Release 0.1.0
Index 253
allpy Documentation, Release 0.1.0
254 Index
allpy Documentation, Release 0.1.0
Index 255
allpy Documentation, Release 0.1.0
256 Index
allpy Documentation, Release 0.1.0
Index 257
allpy Documentation, Release 0.1.0
258 Index
allpy Documentation, Release 0.1.0
Index 259
allpy Documentation, Release 0.1.0
260 Index
allpy Documentation, Release 0.1.0
attribute), 70 attribute), 70
eFromCorner (in module Ne- eLinePointIdentification (class in Ne-
mAll_Python_BasisElements), 73 mAll_Python_Geometry), 157
eFromCorner (NemAll_Python_BasisElements.ShadingTypeeLinkNothing (in module Ne-
attribute), 70 mAll_Python_BasisElements), 73
eGeometry (in module NemAll_Python_BasisElements), eLinkNothing (NemAll_Python_BasisElements.LinkType
73 attribute), 69
eGeometry (NemAll_Python_BasisElements.MacroSlideType eLinkToCeilingSurface (in module Ne-
attribute), 69 mAll_Python_BasisElements), 73
eGeometryErrorCode (class in Ne- eLinkToCeilingSurface (Ne-
mAll_Python_Geometry), 157 mAll_Python_BasisElements.LinkType at-
eGround (NemAll_Python_BasisElements.TextureMappingType tribute), 69
attribute), 71 eLinkToFloorSurface (in module Ne-
eInside (NemAll_Python_Geometry.eBoolOpResult at- mAll_Python_BasisElements), 73
tribute), 156 eLinkToFloorSurface (Ne-
eInsideFitting (in module Ne- mAll_Python_BasisElements.LinkType at-
mAll_Python_BasisElements), 73 tribute), 69
eInsideFitting (NemAll_Python_BasisElements.PlacementType
eLinkToRoofSlab (in module Ne-
attribute), 70 mAll_Python_BasisElements), 73
eINT_COMBOBOX (in module Ne- eLinkToRoofSlab (NemAll_Python_BasisElements.LinkType
mAll_Python_IFW_Input), 198 attribute), 69
eINT_COMBOBOX (Ne- eLinkToRoom (in module Ne-
mAll_Python_IFW_Input.eValueInputControlType mAll_Python_BasisElements), 73
attribute), 197 eLinkToRoom (NemAll_Python_BasisElements.LinkType
eINT_EDIT (in module NemAll_Python_IFW_Input), attribute), 69
198 ELLIPS (NemAll_Python_Palette.PaletteCtrlType
eINT_EDIT (NemAll_Python_IFW_Input.eValueInputControlType attribute), 211
attribute), 197 Ellipsoid3D (class in NemAll_Python_Geometry), 132
eInvalid3DLine (NemAll_Python_Geometry.eGeometryErrorCode
eMacro (in module NemAll_Python_BasisElements), 73
attribute), 157 eMacro (NemAll_Python_BasisElements.HeightDefinitionType
eJoint (in module NemAll_Python_BasisElements), 73 attribute), 69
eJoint (NemAll_Python_BasisElements.PatternCurveIntersectionType
eMiddleBottom (NemAll_Python_BasisElements.TextAlignment
attribute), 70 attribute), 71
eLeft (in module NemAll_Python_BasisElements), 73 eMiddleBottom (NemAll_Python_Geometry.eBoxPoint
eLeft (NemAll_Python_BasisElements.PatternCurveAlignment attribute), 156
attribute), 69 eMiddleLeft (NemAll_Python_Geometry.eBoxPoint at-
eLeftBottom (NemAll_Python_BasisElements.TextAlignment tribute), 156
attribute), 71 eMiddleMiddle (NemAll_Python_BasisElements.TextAlignment
eLeftBottom (NemAll_Python_Geometry.eBoxPoint at- attribute), 71
tribute), 156 eMiddleRight (NemAll_Python_Geometry.eBoxPoint at-
eLeftMiddle (NemAll_Python_BasisElements.TextAlignment tribute), 156
attribute), 71 eMiddleTop (NemAll_Python_BasisElements.TextAlignment
eLeftTop (NemAll_Python_BasisElements.TextAlignment attribute), 71
attribute), 71 eMiddleTop (NemAll_Python_Geometry.eBoxPoint at-
eLeftTop (NemAll_Python_Geometry.eBoxPoint at- tribute), 156
tribute), 156 eMiter (in module NemAll_Python_BasisElements), 73
ElementGroupElement (class in Ne- eMiter (NemAll_Python_BasisElements.PatternCurveIntersectionType
mAll_Python_BasisElements), 53 attribute), 70
ElementGroupProperties (class in Ne- Empty() (NemAll_Python_Geometry.PolyPoints2D
mAll_Python_BasisElements), 54 method), 95
ElementSelect (class in NemAll_Python_IFW_Input), Empty() (NemAll_Python_Geometry.PolyPoints3D
190 method), 97
eLinear (in module NemAll_Python_BasisElements), 73 eMultiLine3D (in module Ne-
eLinear (NemAll_Python_BasisElements.ShadingType mAll_Python_BasisElements), 73
Index 261
allpy Documentation, Release 0.1.0
262 Index
allpy Documentation, Release 0.1.0
Index 263
allpy Documentation, Release 0.1.0
264 Index
allpy Documentation, Release 0.1.0
Index 265
allpy Documentation, Release 0.1.0
266 Index
allpy Documentation, Release 0.1.0
Index 267
allpy Documentation, Release 0.1.0
268 Index
allpy Documentation, Release 0.1.0
Index 269
allpy Documentation, Release 0.1.0
270 Index
allpy Documentation, Release 0.1.0
Index 271
allpy Documentation, Release 0.1.0
272 Index
allpy Documentation, Release 0.1.0
Index 273
allpy Documentation, Release 0.1.0
274 Index
allpy Documentation, Release 0.1.0
Index 275
allpy Documentation, Release 0.1.0
276 Index
allpy Documentation, Release 0.1.0
Index 277
allpy Documentation, Release 0.1.0
278 Index
allpy Documentation, Release 0.1.0
Index 279
allpy Documentation, Release 0.1.0
Language() (NemAll_Python_AllplanSettings.AllplanLocalisationService
LongitudinalBarSingleBentOff (in module Ne-
method), 40 mAll_Python_Reinforcement), 230
LaplaceTransform() (Ne- LongitudinalBarSingleBentOff (Ne-
mAll_Python_Geometry.Matrix3D method), mAll_Python_Reinforcement.BendingShapeType
88 attribute), 228
Layer (NemAll_Python_BaseElements.CommonProperties LShapedBar (in module Ne-
attribute), 50 mAll_Python_Reinforcement), 230
LEFT_2D (NemAll_Python_Geometry.eProjectionMatrixType LShapedBar (NemAll_Python_Reinforcement.BendingShapeType
attribute), 158 attribute), 228
Length (NemAll_Python_Geometry.Clothoid2D at-
tribute), 107 M
LENGTH (NemAll_Python_Palette.PaletteValueType at- MacroElement (class in Ne-
tribute), 211 mAll_Python_BasisElements), 57
Length (NemAll_Python_Reinforcement.MeshData at- MacroGroupElement (class in Ne-
tribute), 221 mAll_Python_BasisElements), 57
LengthVector (NemAll_Python_Geometry.Cuboid3D at- MacroGroupProperties (class in Ne-
tribute), 129 mAll_Python_BasisElements), 58
LINE (NemAll_Python_Palette.PaletteCtrlType at- MacroPlacementElement (class in Ne-
tribute), 211 mAll_Python_BasisElements), 58
Line2D (class in NemAll_Python_Geometry), 108 MacroPlacementProperties (class in Ne-
Line3D (class in NemAll_Python_Geometry), 134 mAll_Python_BasisElements), 59
LineCount() (NemAll_Python_Geometry.Polyline2D MacroProperties (class in Ne-
method), 115 mAll_Python_BasisElements), 60
LineCount() (NemAll_Python_Geometry.Polyline3D MacroSlideElement (class in Ne-
method), 146 mAll_Python_BasisElements), 60
LineFeed (NemAll_Python_BasisElements.TextProperties MacroSlideProperties (class in Ne-
attribute), 66 mAll_Python_BasisElements), 60
LinkType (class in NemAll_Python_BasisElements), 69 MacroSlideType (class in Ne-
LinkType (NemAll_Python_BasisElements.MacroPlacementPropertiesmAll_Python_BasisElements), 69
attribute), 59 MainReleaseName() (Ne-
LocalPlacement (NemAll_Python_Geometry.Cone3D at- mAll_Python_AllplanSettings.AllplanVersion
tribute), 127 method), 41
LocalPlacement (NemAll_Python_Geometry.Cylinder3D MajorRadius (NemAll_Python_Geometry.Arc2D at-
attribute), 131 tribute), 100
LocalPlacement (NemAll_Python_Geometry.Ellipsoid3D MajorRadius (NemAll_Python_Geometry.Arc3D at-
attribute), 132 tribute), 116
LongitudinalBar (in module Ne- MajorRadius (NemAll_Python_Geometry.Cone3D
mAll_Python_Reinforcement), 230 attribute), 127
LongitudinalBar (NemAll_Python_Reinforcement.BendingShapeType
MajorRadius (NemAll_Python_Geometry.Cylinder3D at-
attribute), 228 tribute), 131
LongitudinalBarDoubleBentOf (Ne- MakeIntersection() (in module Ne-
mAll_Python_Reinforcement.BendingShapeType mAll_Python_Geometry), 171, 172
attribute), 228 MakeSubtraction() (in module Ne-
LongitudinalBarDoubleBentOff (in module Ne- mAll_Python_Geometry), 172
mAll_Python_Reinforcement), 230 MakeUnion() (in module NemAll_Python_Geometry),
LongitudinalBarFourTimesBentOff (in module Ne- 172
mAll_Python_Reinforcement), 230 MappingAngle (NemAll_Python_BasisElements.TextureMapping
LongitudinalBarFourTimesBentOff (Ne- attribute), 67
mAll_Python_Reinforcement.BendingShapeType MappingType (NemAll_Python_BasisElements.TextureMapping
attribute), 228 attribute), 67
LongitudinalBars (in module Ne- Mass_V6 (NemAll_Python_BasisElements.MacroPlacementProperties
mAll_Python_Reinforcement), 230 attribute), 59
LongitudinalBars (NemAll_Python_Reinforcement.MeshBendingDirection
Mass_V7 (NemAll_Python_BasisElements.MacroPlacementProperties
attribute), 229 attribute), 59
280 Index
allpy Documentation, Release 0.1.0
Mass_V8 (NemAll_Python_BasisElements.MacroPlacementProperties
Multiply() (NemAll_Python_Geometry.Matrix2D
attribute), 59 method), 86
Mass_V9 (NemAll_Python_BasisElements.MacroPlacementProperties
Multiply() (NemAll_Python_Geometry.Matrix3D
attribute), 59 method), 88
Matrix (NemAll_Python_BasisElements.MacroPlacementProperties
attribute), 59 N
Matrix2D (class in NemAll_Python_Geometry), 86 Name (NemAll_Python_BasisElements.ElementGroupProperties
Matrix3D (class in NemAll_Python_Geometry), 87 attribute), 54
Max (NemAll_Python_Geometry.BoundingBox2D at- Name (NemAll_Python_BasisElements.MacroGroupProperties
tribute), 103 attribute), 58
Max (NemAll_Python_Geometry.MinMax2D attribute), Name (NemAll_Python_BasisElements.MacroPlacementProperties
110 attribute), 59
Max (NemAll_Python_Geometry.MinMax3D attribute), Name (NemAll_Python_BasisElements.MacroProperties
136 attribute), 60
MeshBendingDirection (class in Ne- NemAll_Python_AllplanSettings (module), 39
mAll_Python_Reinforcement), 229 NemAll_Python_ArchElements (module), 43
MeshData (class in NemAll_Python_Reinforcement), NemAll_Python_BaseElements (module), 45
221 NemAll_Python_BasisElements (module), 51
MeshPlacement (class in Ne- NemAll_Python_Geometry (module), 75
mAll_Python_Reinforcement), 223 NemAll_Python_IFW_Input (module), 185
Min (NemAll_Python_Geometry.BoundingBox2D NemAll_Python_Palette (module), 199
attribute), 103 NemAll_Python_Reinforcement (module), 213
Min (NemAll_Python_Geometry.MinMax2D attribute), NemAll_Python_Utility (module), 233
110 NO_ERR (NemAll_Python_Geometry.eServiceResult at-
Min (NemAll_Python_Geometry.MinMax3D attribute), tribute), 158
136 Normal (in module NemAll_Python_Reinforcement),
MinMax2D (class in NemAll_Python_Geometry), 110 230
MinMax3D (class in NemAll_Python_Geometry), 136 Normal (NemAll_Python_Reinforcement.StirrupType at-
MinorRadius (NemAll_Python_Geometry.Arc2D at- tribute), 229
tribute), 100 Normal() (NemAll_Python_Geometry.Vector3D
MinorRadius (NemAll_Python_Geometry.Arc3D at- method), 79
tribute), 116 Normalize() (NemAll_Python_Geometry.Polygon2D
MinorRadius (NemAll_Python_Geometry.Cone3D at- method), 113
tribute), 127 Normalize() (NemAll_Python_Geometry.Polygon3D
MinorRadius (NemAll_Python_Geometry.Cylinder3D method), 140
attribute), 131 Normalize() (NemAll_Python_Geometry.Polyhedron3D
MirrorState (NemAll_Python_BasisElements.MacroPlacementProperties
method), 144
attribute), 59 Normalize() (NemAll_Python_Geometry.Vector2D
ModelElement2D (class in Ne- method), 78
mAll_Python_BasisElements), 61 Normalize() (NemAll_Python_Geometry.Vector3D
ModelElement3D (class in Ne- method), 79
mAll_Python_BasisElements), 62 Normalize2Pi() (NemAll_Python_Geometry.Angle
ModifiableFlag (NemAll_Python_BasisElements.ElementGroupProperties
method), 76
attribute), 54 NormalizeNoThrow() (Ne-
Month (NemAll_Python_BaseElements.AttributeDate at- mAll_Python_Geometry.Polygon2D method),
tribute), 46 113
Move() (in module NemAll_Python_Geometry), 172, 173 NormalizeNoThrow() (Ne-
Move() (NemAll_Python_Reinforcement.BarPlacement mAll_Python_Geometry.Polygon3D method),
method), 215 140
Move() (NemAll_Python_Reinforcement.BendingShape NormalizePi() (NemAll_Python_Geometry.Angle
method), 218 method), 76
Move() (NemAll_Python_Reinforcement.MeshPlacement NormType (class in NemAll_Python_Reinforcement),
method), 223 229
move_handle() (built-in function), 32
Index 281
allpy Documentation, Release 0.1.0
282 Index
allpy Documentation, Release 0.1.0
Index 283
allpy Documentation, Release 0.1.0
284 Index
allpy Documentation, Release 0.1.0
Index 285
allpy Documentation, Release 0.1.0
286 Index
allpy Documentation, Release 0.1.0
Index 287
allpy Documentation, Release 0.1.0
288 Index
allpy Documentation, Release 0.1.0
Index 289
allpy Documentation, Release 0.1.0
290 Index
allpy Documentation, Release 0.1.0
Index 291
allpy Documentation, Release 0.1.0
SurfacePath (NemAll_Python_BasisElements.TextureDefinition
TOP_2D (NemAll_Python_Geometry.eProjectionMatrixType
attribute), 66 attribute), 158
SwapLinePoints() (NemAll_Python_Geometry.ChamferCalculus
TopPlane (NemAll_Python_Geometry.ClippedSweptSolid3D
method), 150 attribute), 125
SweptArea (NemAll_Python_Geometry.ClippedSweptSolid3D Torsion (in module NemAll_Python_Reinforcement),
attribute), 125 230
Symbol2DElement (class in Ne- Torsion (NemAll_Python_Reinforcement.StirrupType at-
mAll_Python_BasisElements), 64 tribute), 229
Symbol2DProperties (class in Ne- TorsionStirrup (in module Ne-
mAll_Python_BasisElements), 64 mAll_Python_Reinforcement), 230
Symbol3DElement (class in Ne- TorsionStirrup (NemAll_Python_Reinforcement.BendingShapeType
mAll_Python_BasisElements), 64 attribute), 228
Symbol3DProperties (class in Ne- Transform() (in module NemAll_Python_Geometry),
mAll_Python_BasisElements), 65 179, 180
SymbolID (NemAll_Python_BasisElements.Symbol2DProperties
Transform() (NemAll_Python_Reinforcement.BarPlacement
attribute), 64 method), 216
SymbolID (NemAll_Python_BasisElements.Symbol3DProperties
Transform() (NemAll_Python_Reinforcement.BendingShape
attribute), 65 method), 219
Transform() (NemAll_Python_Reinforcement.MeshPlacement
T method), 223
tEdges (NemAll_Python_Geometry.PolyhedronType at- TransformCoord (class in NemAll_Python_Geometry),
tribute), 155 154
TEXT (NemAll_Python_Palette.PaletteCtrlType at- TransitionType (class in Ne-
tribute), 211 mAll_Python_BasisElements), 72
TextAlignment (class in Ne- Translate() (NemAll_Python_Geometry.Matrix2D
mAll_Python_BasisElements), 71 method), 87
TextAngle (NemAll_Python_BasisElements.TextProperties Translate() (NemAll_Python_Geometry.Matrix3D
attribute), 66 method), 89
TextElement (class in NemAll_Python_BasisElements), TranslationType (NemAll_Python_BasisElements.FillingProperties
65 attribute), 56
TransparentColor (NemAll_Python_BasisElements.BitmapAreaProperties
TextFrameColor (NemAll_Python_BasisElements.TextProperties
attribute), 66 attribute), 53
TransparentColorTolerance
TextFramePen (NemAll_Python_BasisElements.TextProperties (Ne-
attribute), 66 mAll_Python_BasisElements.BitmapAreaProperties
TextFrameStroke (NemAll_Python_BasisElements.TextProperties attribute), 53
attribute), 66 Transpose() (NemAll_Python_Geometry.Matrix3D
TextProperties (class in NemAll_Python_BasisElements), method), 88
66 TrimByHelpConstruction() (Ne-
TextType (class in NemAll_Python_BasisElements), 71 mAll_Python_Geometry.FilletCalculus2D
TextureDefinition (class in Ne- method), 152
mAll_Python_BasisElements), 66 TrimEnd() (NemAll_Python_Geometry.Line2D method),
TextureMapping (class in Ne- 110
mAll_Python_BasisElements), 67 TrimEnd() (NemAll_Python_Geometry.Line3D method),
TextureMappingType (class in Ne- 135
mAll_Python_BasisElements), 71 TrimStart() (NemAll_Python_Geometry.Line2D
tFaces (NemAll_Python_Geometry.PolyhedronType at- method), 110
tribute), 155 TrimStart() (NemAll_Python_Geometry.Line3D
Timer (class in NemAll_Python_Utility), 234 method), 135
tInvalid (NemAll_Python_Geometry.PolyhedronType at- tVolume (NemAll_Python_Geometry.PolyhedronType at-
tribute), 155 tribute), 155
ToLineChain() (NemAll_Python_Geometry.PolyPoints2D Type (NemAll_Python_BasisElements.MacroPlacementProperties
method), 96 attribute), 59
ToLineChain() (NemAll_Python_Geometry.PolyPoints3D Type (NemAll_Python_BasisElements.MacroSlideProperties
method), 98 attribute), 61
292 Index
allpy Documentation, Release 0.1.0
Index 293
allpy Documentation, Release 0.1.0
294 Index
allpy Documentation, Release 0.1.0
XOffset (NemAll_Python_BasisElements.BitmapAreaProperties
attribute), 53
XOffset (NemAll_Python_BasisElements.TextureMapping
attribute), 67
XRadius (NemAll_Python_Geometry.Ellipsoid3D
attribute), 132
XScale (NemAll_Python_BasisElements.TextureMapping
attribute), 67
XScalingFactor (NemAll_Python_BasisElements.BitmapAreaProperties
attribute), 53
XScalingFactor (NemAll_Python_BasisElements.PatternProperties
attribute), 63
Y
Y (NemAll_Python_Geometry.Point2D attribute), 81
Y (NemAll_Python_Geometry.Point3D attribute), 82
Y (NemAll_Python_Geometry.Vector2D attribute), 77
Y (NemAll_Python_Geometry.Vector3D attribute), 79
Year (NemAll_Python_BaseElements.AttributeDate at-
tribute), 46
YOffset (NemAll_Python_BasisElements.BitmapAreaProperties
attribute), 53
YOffset (NemAll_Python_BasisElements.TextureMapping
attribute), 67
YRadius (NemAll_Python_Geometry.Ellipsoid3D
attribute), 132
YScale (NemAll_Python_BasisElements.TextureMapping
attribute), 67
YScalingFactor (NemAll_Python_BasisElements.BitmapAreaProperties
attribute), 53
YScalingFactor (NemAll_Python_BasisElements.PatternProperties
attribute), 63
Z
Z (NemAll_Python_Geometry.Point3D attribute), 82
Z (NemAll_Python_Geometry.Vector3D attribute), 79
ZDirection (NemAll_Python_Geometry.AxisPlacement3D
attribute), 93
ZRadius (NemAll_Python_Geometry.Ellipsoid3D at-
tribute), 132
Index 295