Python и Civil 3D

Dynamo — это чрезвычайно мощный инструмент визуального программирования, однако его можно использовать не только для работы с узлами и проводами, но и для написания кода в текстовом формате. Сделать это можно двумя способами.

1. Написать код DesignScript с помощью Code Block.

2. Написать код Python с помощью узла Python.

В этом разделе рассматривается использование Python в среде Civil 3D для работы с .NET API программ AutoCAD и Civil 3D.

Общие сведения об использовании Python в Dynamo см. в разделе Python.

Документация по API

В AutoCAD и Civil 3D есть несколько API-интерфейсов, которые позволяют разработчикам расширять базовые возможности этих программ за счет пользовательских функций. В отношении Dynamo для этого применяются управляемые .NET API. По ссылкам ниже можно ознакомиться со сведениями, необходимыми для понимания структуры API-интерфейсов и принципа их работы.

Руководство разработчика .NET API AutoCAD (англ.)

Справочное руководство по .NET API AutoCAD (англ.)

Руководство разработчика .NET API Civil 3D (англ.)

Справочное руководство по .NET API Civil 3D (англ.)

В этом разделе могут встречаться незнакомые вам понятия, такие как базы данных, транзакции, методы, свойства и т. д. Многие из этих понятий необходимо знать для работы с .NET API, и они не относятся исключительно к Dynamo или Python. Мы не будем подробно рассматривать эти понятия в данном руководстве и потому рекомендуем обратиться к приведенным выше ссылкам для получения дополнительной информации.

Шаблон кода

Когда вы впервые откроете новый узел Python для его редактирования, он будет по умолчанию заполнен шаблонным кодом. Ниже приводится описание данного шаблона с пояснениями по каждому блоку.

Шаблон Python по умолчанию в Civil 3D

1. Импорт модулей sys и clr, необходимых для правильной работы интерпретатора Python. В частности, модуль clr позволяет обрабатывать пространства имен .NET как пакеты Python.

2. Загрузка стандартных сборок (например, файлов DLL) для работы с управляемыми .NET API для AutoCAD и Civil 3D.

3. Добавление ссылок на стандартные пространства имен AutoCAD и Civil 3D. Эквивалентно директивам using и Imports в C# и VB.NET, соответственно.

4. Доступ к входным портам узла осуществляется с помощью предварительно определенного списка IN. Для доступа к данным в определенном порте можно использовать его порядковый номер, например: dataInFirstPort = IN[0].

5. Получение активных документа и редактора.

6. Блокировка документа и запуск транзакции базы данных.

7. Здесь размещается основная часть логики сценария.

8. Раскомментируйте эту строку, чтобы зафиксировать транзакцию после выполнения основного объема работы.

9. Если требуется вывести какие-либо данные из узла, назначьте их переменной OUT в конце сценария.

Хотите адаптировать шаблон? Шаблон Python по умолчанию можно изменить, отредактировав файл PythonTemplate.py, расположенный в папке C:\ProgramData\Autodesk\C3D <version>\Dynamo.

Пример

Чтобы ознакомиться с некоторыми из основных понятий, относящихся к написанию сценариев Python в Dynamo for Civil 3D, рассмотрим пример.

Цель

🎯 Получение геометрии границ всех водосборов на чертеже.

Набор данных

Ниже приведены файлы примеров, которые можно использовать в этом упражнении.

15KB

Python_Catchments.dyn

961KB

Python_Catchments.dwg

Обзор решения

Ниже представлен обзор логики, используемой в этом графике.

1. Изучить документацию по API Civil 3D.

2. Выбрать все водосборы в документе по имени слоя.

3. «Развернуть» объекты Dynamo для доступа ко внутренним элементам API Civil 3D.

4. Создать точки Dynamo на основе точек AutoCAD.

5. Создать сложные кривые по точкам.

Приступим!

Изучение документации по API

Прежде чем приступить к созданию графика и написанию кода, ознакомьтесь с документацией по API Civil 3D, чтобы получить представление о доступных возможностях. В данном случае нас интересует свойство в классе Catchment, которое возвращает точки контура водосбора. Обратите внимание, что это свойство возвращает объект Point3dCollection, но программа Dynamo не умеет обрабатывать такие объекты. Другими словами, мы не сможем создать сложную кривую на основе Point3dCollection, поэтому нам придется преобразовать все полученные данные в точки Dynamo. Позже мы рассмотрим этот процесс подробнее.

Получение всех водосборов

Теперь можно приступить к выстраиванию логики графика. Сначала необходимо получить список всех водосборов в документе. Для решения этой задачи можно использовать узлы, поэтому мы не будем включать ее в сценарий Python. Использование узлов упрощает визуальное восприятие графика (не нужно пробираться через большой объем кода Python), а также позволяет посвятить сценарий Python выполнению одной задачи: получение точек контура водосборов.

Получение всех водосборов в документе по слоям

Обратите внимание, что выходные данные узла All Objects on Layer представляют собой список элементов CivilObjects. Это связано с тем, что в Dynamo for Civil 3D в данный момент нет узлов для работы с водосборами, и именно поэтому нам требуется получить доступ к API через Python.

Развертка объектов

Прежде чем продолжить, кратко рассмотрим одну важную концепцию. В разделе Библиотека узлов была рассмотрена взаимосвязь элементов Object и CivilObject. Если рассмотреть эту взаимосвязь чуть глубже, можно увидеть, что каждый элемент Object Dynamo представляет собой оболочку для элемента Entity AutoCAD. Аналогичным образом, элемент CivilObject Dynamo представляет собой оболочку для элемента Entity Civil 3D. Эту оболочку можно снять, «развернув» элемент Object путем доступа к его свойствам InternalDBObject или InternalObjectId.

Тип Dynamo	Оболочка для
Object Autodesk.AutoCAD.DynamoNodes.Object	Entity Autodesk.AutoCAD.DatabaseServices.Entity
CivilObject Autodesk.Civil.DynamoNodes.CivilObject	Entity Autodesk.Civil.DatabaseServices.Entity

На практике в большинстве случаев надежнее сначала получить идентификатор объекта с помощью свойства InternalObjectId, а затем получить доступ к объекту-оболочке в транзакции. Причина в том, что свойство InternalDBObject возвращает элемент DBObject AutoCAD, недоступный для записи.

Сценарий Python

Вот полный сценарий Python, который обращается к внутренним объектам водосбора и получает их точки контура. В сценарии выделены строки, содержащие измененный шаблонный код или новый пользовательский код.

Для просмотра пояснений щелкните подчеркнутые строки сценария.

# Загрузка стандартной библиотеки Python и библиотеки DesignScript
import sys
import clr

# Добавление сборок для AutoCAD и Civil 3D
clr.AddReference('AcMgd')
clr.AddReference('AcCoreMgd')
clr.AddReference('AcDbMgd')
clr.AddReference('AecBaseMgd')
clr.AddReference('AecPropDataMgd')
clr.AddReference('AeccDbMgd')



# Импорт ссылок из AutoCAD
from Autodesk.AutoCAD.Runtime import *
from Autodesk.AutoCAD.ApplicationServices import *
from Autodesk.AutoCAD.EditorInput import *
from Autodesk.AutoCAD.DatabaseServices import *
from Autodesk.AutoCAD.Geometry import *

# Импорт ссылок из Civil 3D
from Autodesk.Civil.ApplicationServices import *
from Autodesk.Civil.DatabaseServices import *

from Autodesk.DesignScript.Geometry import Point as DynPoint

# Входные данные для этого узла будут храниться в виде списка в переменных IN.
 = IN[0]

 

if objs is None:
    

if not isinstance(objs, list):
    
    
adoc = Application.DocumentManager.MdiActiveDocument
editor = adoc.Editor

with adoc.LockDocument():
    with adoc.Database as db:
        
        with db.TransactionManager.StartTransaction() as t:
            for obj in objs:              
                
                aeccObj = t.GetObject(id, OpenMode.ForRead)                
                if isinstance(aeccObj, Catchment):
                    
                    acPnts = catchment.BoundaryPolyline3d                    
                    
                    for acPnt in acPnts:
                        
                        dynPnts.append(pnt)
                    
            
            # Фиксация перед завершением транзакции
            t.Commit()
            pass
            
# Назначение выходных данных переменной OUT

На практике основной объем логики сценария рекомендуется размещать внутри транзакции. Это обеспечивает безопасный доступ к объектам, которые сценарий считывает или записывает. Если пропустить транзакцию, во многих случаях это может привести к неустранимой ошибке.

Создание сложных кривых

На этом этапе сценарий Python должен вывести список точек Dynamo, который можно увидеть в фоновом просмотре. Нам осталось просто создать сложных кривые на основе этих точек. Обратите внимание, что сделать это можно напрямую в сценарии Python, однако мы намеренно размещаем эту операцию за пределами сценария, в узле, чтобы сделать ее более заметной. Вот как выглядит итоговый график.

Итоговый график

Результат

А вот итоговая геометрия Dynamo.

Полученные сложные кривые Dynamo для границ водосборов

🎉 Миссия выполнена!

IronPython и CPython

Небольшой комментарий перед завершением данного раздела. Настройка узла Python может выполняться по-разному в зависимости от используемой версии Civil 3D. В Civil 3D 2020 и 2021 в Dynamo использовался инструмент IronPython, который позволял переносить данные между объектами .NET и сценариями Python. Однако в Civil 3D 2022 в Dynamo применяется стандартный встроенный интерпретатор Python (CPython), в котором используется Python 3. Переход на этот вариант обеспечивает ряд преимуществ, в том числе доступ к популярным современным библиотекам и новым возможностям платформы, а также установку обновлений и исправлений для системы безопасности.

Подробные сведения об этом переходе и обновлении сценариев предыдущих версий можно найти в блоге Dynamo. Если вы хотите и дальше работать с IronPython, установите пакет DynamoIronPython2.7 с помощью Dynamo Package Manager.

1. Эта строка позволяет нам получить определенный класс из библиотеки геометрии Dynamo. Обратите внимание, что здесь мы указываем import Point as DynPoint, а не import *. Это нужно, чтобы избежать конфликтов имен.

2. Здесь мы указали, какой именно порт ввода содержит нужные данные, вместо того чтобы использовать значение по умолчанию IN, которое ссылается на список всех портов ввода.

[^13: Входной список объектов может содержать не только водосборы, но и другие элементы. Необходимо проверить, так ли это, и принять соответствующие меры (итерация цикла продолжается только в том случае, если элемент действительно является водосбором).

1. Здесь мы получаем точки контура водосбора с помощью соответствующего свойства, которое мы нашли ранее в документации по API. Как уже упоминалось, в результате мы получим объект Point3dCollection, который по сути является списком точек AutoCAD. Чтобы использовать эти точки, нам потребуется преобразовать их в точки Dynamo.

2. Запускаем цикл для каждого объекта Point3d в Point3dCollection.