Введение в Design Automation для Inventor
Что нам понадобится:
- Inventor SDK и Visual Studio 2017 для сборки нашего плагина для Inventor
- см. документацию в SDK, доступную при установке Inventor-а
- можно использовать Visual Studio Community Edition
- клиент HTTP для вызова Forge API
- мы будем использовать синтаксис postman и cURL
- если Вы предпочитаете работать с графическим UI, все примеры cURL в этой статье могут быть импортированы в postman
Этап 1. Плагин для Inventor
Если у Вас возникли проблемы с этой частью, Вы можете пропустить этот этап. Здесь ZIP-файл нашего плагина со всеми исходниками: InventorThumbnailAddin.zip.
Дополнение: Здесь доступен шаблон проекта Visual Studio, позволяющий ускорить разработку плагина для Inventor.
Установите Inventor SDK, откройте Visual Studio и создайте новый проект с AddIn-ом для Inventor-а на основе шаблона Autodesk Inventor AddIn. Мы назовем его InventorThumbnailAddin:
Создайте новый файл в проекте Automation.cs, определите в нём класс Automation:
- using System;
- using System.Runtime.InteropServices;
- using Inventor;
- namespace InventorThumbnailAddin
- {
- [ComVisible(true)]
- public class Automation
- {
- InventorServer m_server;
- public Automation(InventorServer server)
- {
- m_server = server;
- }
- public void Run(Document document)
- {
- string documentFolder = System.IO.Path.GetDirectoryName(document.FullFileName);
- string imageFilename = System.IO.Path.Combine(documentFolder, "thumbnail.bmp");
- if (document.DocumentType == DocumentTypeEnum.kPartDocumentObject)
- {
- Camera camera = m_server.TransientObjects.CreateCamera();
- camera.SceneObject = (document as PartDocument).ComponentDefinition;
- camera.ViewOrientationType = ViewOrientationTypeEnum.kIsoTopRightViewOrientation;
- camera.ApplyWithoutTransition();
- camera.SaveAsBitmap(imageFilename, 256, 256, Type.Missing, Type.Missing);
- }
- }
- public void RunWithArguments(Document document, NameValueMap args)
- {
- Run(document);
- }
- }
- }
В файле StandardAddInServer.cs (который должен быть автоматически создан по шаблону проекта Autodesk Inventor AddIn) и измените его следующим образом (но сохраните GUID, который был сгенерирован):
- using System;
- using System.Runtime.InteropServices;
- using Inventor;
- namespace InventorThumbnailAddin
- {
- [GuidAttribute("YOUR GUID")]
- public class StandardAddInServer : Inventor.ApplicationAddInServer
- {
- private InventorServer m_server;
- private Automation m_automation;
- public StandardAddInServer()
- {
- }
- #region ApplicationAddInServer Members
- public void Activate(Inventor.ApplicationAddInSite addInSiteObject, bool firstTime)
- {
- m_server = addInSiteObject.InventorServer;
- m_automation = new Automation(m_server);
- }
- public void Deactivate()
- {
- Marshal.ReleaseComObject(m_server);
- m_server = null;
- GC.Collect();
- GC.WaitForPendingFinalizers();
- }
- public void ExecuteCommand(int commandID)
- {
- }
- public dynamic Automation
- {
- get
- {
- return m_automation;
- }
- }
- #endregion
- }
- }
Затем найдите addin-файл Inventor-а (Autodesk.InventorThumbnailAddin.Inventor.addin) и замените его содержимое (опять же, используя Ваши GUID):
- <Addin Type="Plugin">
- <ClassId>{YOUR GUID}</ClassId>
- <ClientId>{YOUR GUID}</ClientId>
- <DisplayName>Inventor Thumbnail Addin</DisplayName>
- <Description>Addin for generating thumbnail images from Inventor part files.</Description>
- <Assembly>InventorThumbnailAddin.dll</Assembly>
- </Addin>
Откройте свойства проекта, на вкладке Build Events замените команды Post-build на следующие:
- call "%VS140COMNTOOLS%vsvars32" x86
- mt.exe -manifest "$(ProjectDir)InventorThumbnailAddin.X.manifest" -outputresource:"$(TargetPath)"
- XCopy "$(ProjectDir)Autodesk.InventorThumbnailAddin.Inventor.addin" "$(TargetDir)" /y
для подписи нашей DLL и копирования её и соответствующего addin-файла.
Теперь мы можем собрать проект, сгенерировав необходимые файлы в папке bin/Debug. Мы будем использовать их в Forge Design Automation.
Этап 2. Forge Design Automation
Для начала обсудим базовые концепции, которые используются этим сервисом. Согласно документации есть 4 основных типов объектов: engines, app bundles, activities и work items:
- Engine - это те приложения, которые обрабатывают Ваши задачи в облаке, например, Revit или Inventor
- App bundle - набор файлов (обычно бинарных), используемых для выполнения определенных задач при помощи доступных engines
- Activity - что-то вроде шаблона задачи, определяющих входные и выходные данные, app bundle, с помощью которого будет выполняться задача
- work item - экземпляр задачи с конкретными входными и выходными данными (обычно URL, откуда и куда должны быть загружены исходные/результирующие файлы)
Еще одна очень важная вещь, которую необходимо понять: каждый объект app bundle/activity/work item может иметь несколько версий и для того, чтобы правильно ссылаться на конкретными объект, Вам необходимо создать что-то вроде псевдонима (alias) - строку, определяющую конкретную версию объекта. Что-то вроде git tags. Например, когда Вы создаете вторую версию activity GenerateThumbnail, создается endpoint (мы будем использовать их позже), которому мы назначим alias "prod", указывающий на эту конкретную версию. Затем для того, чтобы сослаться на данную версию activity, мы будем использовать её имя + alias, например GenerateThumbnail+prod. Более того, в некоторых случаях, будет использоваться префикс с точкой, например YhryNMLor4R1maFhY4zER8unpISoP5E4.GenerateThumbnail+prod. Эта строка полностью идентифицирует объект и Вас в качестве его владельца.
Итак, мы разобрались с основными концепциями, поехали!
Получение токена доступа
Мы будем использовать токен двухфакторной авторизации для выполнения всех запросов к сервисам Forge. Обратитесь к этому пошаговому руководству, где детально расписано получение токена двухфакторной авторизацию. Большая часть Design Automation API требует только scope code:all, но в рассматриваемом нами примере нам так же необходимо создавать bucket-ы и другие обхекты с использование Data Management API, поэтому также добавьте следующие scope: bucket:create, bucket:read, data:create, data:read и data:write.
- curl -X POST \
- https://developer.api.autodesk.com/authentication/v1/authenticate \
- -H 'Content-Type: application/x-www-form-urlencoded' \
- -d 'client_id=<Ваш CLIENT ID>&client_secret=<Ваш CLIENT SECRET>&grant_type=client_credentials&scope=bucket%3Acreate%20bucket%3Aread%20data%3Acreate%20data%3Aread%20data%3Awrite%20code%3Aall'
Скопируйте из результатов выполнения данного запроса тоекн доступа, и во всех последующих запросах, представленных в этой статье, замените <YOUR ACCESS TOKEN>
Создаем app bundle
Для начала, необходимо создать bundle нашего плагина для Inventor-а. Bundle - это zip-архив, содержащий папку с dll-файлами и файл PackageContents.xml, который описывает содержимое этой папки. В нашем примере нам нужно взять скомпилированные файлы плагина Inventor-а, положить их в папку InventorThumbnailAddin.bundle так, как показано на рисунке:
и заархивировать её (в формате ZIP)
Обратите внимание, что файл PackageContents.xml находится в папке InventorThumbnailAddin.bundle, а не в папке Contents.
В файле PackageContents.xml мы описываем наш плагин, включая GUID и относительный путь к файлу манифеста (.addin). Вы можете также добавить дополнительную информацию об авторе/компании, создавшей плагин.
- <?xml version="1.0" encoding="utf-8" ?>
- <ApplicationPackage SchemaVersion="1.0" Version="1.0" ProductCode="{YOUR GUID}" Name="..." Description="..." Author="...">
- <CompanyDetails Name="..." Phone="..." Url="..." Email="..." />
- <Components>
- <!-- For Inventor Engine, "Platform" attribute must be "Inventor" -->
- <RuntimeRequirements OS="Win64" Platform="Inventor" />
- <!-- For Inventor Plug-in, the "Module" attribute must point to the .addin manifest file. -->
- <ComponentEntry LoadOnAutoCADStartup="False" LoadOnCommandInvocation="False"
- AppDescription="Thumbnail App Package."
- ModuleName="./Contents/Autodesk.InventorThumbnailAddin.Inventor.addin" AppName="InventorThumbnailAddin"/>
- </Components>
- <EnvironmentVariables>
- </EnvironmentVariables>
- </ApplicationPackage>
Теперь, когда у нас есть файл InventorThumbnailAddin.bundle.zip, мы можем создать app bundle ThumbnailBundle - новый alias к его первой версии.
- curl -X POST \
- https://developer.api.autodesk.com/da/us-east/v3/appbundles \
- -H 'Authorization: Bearer <YOUR ACCESS TOKEN>' \
- -H 'Content-Type: application/json' \
- -d '{
- "id": "ThumbnailBundle",
- "description": "Inventor plugin for generating thumbnails from IPT files.",
- "engine": "Autodesk.Inventor+23"
- }'
Ответом сервера будет JSON со структурой, подобной этой:
- {
- "uploadParameters": {
- "endpointURL": "https://dasprod-store.s3.amazonaws.com",
- "formData": {
- "key": "...",
- "content-type": "...",
- "policy": "...",
- "success_action_status": "200",
- "success_action_redirect": "",
- "x-amz-signature": "...",
- "x-amz-credential": "...",
- "x-amz-algorithm": "...",
- "x-amz-date": "...",
- "x-amz-server-side-encryption": "...",
- "x-amz-security-token": "..."
- }
- },
- "engine": "Autodesk.Inventor+23",
- "description": "Inventor plugin for generating thumbnails from IPT files.",
- "version": 1,
- "id": "<OWNER ID>.ThumbnailBundle"
- }
В uploadParameters содержатся аргументы запроса, которые нам будут нужны для загрузки app bundle в облако, где сервисы Design Automation смогут их использовать. Выполните POST-запрос с полученным URL, включая все аргументы и zip-файл с созданным ранее bundle-ом.
- curl -X POST \
- https://dasprod-store.s3.amazonaws.com \
- -H 'content-type: multipart/form-data' \
- -F key=... \
- -F policy=... \
- -F content-type=... \
- -F success_action_status=200 \
- -F success_action_redirect= \
- -F x-amz-signature=... \
- -F x-amz-credential=... \
- -F x-amz-algorithm=... \
- -F x-amz-date=... \
- -F x-amz-server-side-encryption=... \
- -F x-amz-security-token=... \
- -F file=@/path/to/your/zipfile
Если Вы не хотите загружать bundle из командной строки, Вы можете импортировать команду curl в postman, заполнить все поля на основе полученных uploadParameters, переключить тип последнего параметра (file) и выбрать файл для загрузки.
img https://flint-prodcms-forge.s3.amazonaws.com/prod/s3fs-public/inline-images/binaries-upload-postman.png
Наконец, для того, чтобы к нашему app bunlde можно было бы обратиться в последующих шагах, представленных в этой статье, нам нужно создать alias, назовем его prod для его первой версии:
- curl -X POST \
- https://developer.api.autodesk.com/da/us-east/v3/appbundles/ThumbnailBundle/aliases \
- -H 'Authorization: Bearer <YOUR ACCESS TOKEN>' \
- -H 'Content-Type: application/json' \
- -d '{
- "id": "prod",
- "version": 1
- }'
Определим activity
Затем нам нужно определить activity GenerateThumbnail, которая будет использовать ThumbnailBundle, принимая на входе один файл IPT и генерируя один BMP файл на выходе:
- curl -X POST \
- https://developer.api.autodesk.com/da/us-east/v3/activities \
- -H 'Content-Type: application/json' \
- -d '{
- "commandLine": [
- "$(engine.path)\\InventorCoreConsole.exe /i $(args[PartFile].path) /al $(appbundles[ThumbnailBundle].path)"
- ],
- "parameters": {
- "PartFile": {
- "verb": "get",
- "description": "IPT file or ZIP with assembly to process"
- },
- "OutputBmp": {
- "zip": false,
- "ondemand": false,
- "optional": true,
- "verb": "put",
- "description": "Generated thumbnail",
- "localName": "thumbnail.bmp"
- }
- },
- "engine": "Autodesk.Inventor+23",
- "appbundles": ["<OWNER ID>.ThumbnailBundle+prod"],
- "description": "Generate thumbnails for IPT files (Inventor 2019).",
- "id": "GenerateThumbnail"
- }'
Рассмотрим структуру отправляемого в запросе JSON-файла
- мы определяем id и описание activity
- мы определяем список app bundle-ов, которые будут использоваться (на забудьте заменить <OWNER ID> хэшем, полученным при создании app bundle), engine, который будет запускать создаваемую activity
- мы определяем входной параметр PartFile
- activity известно, что этот параметр входной, т.к. мы указали GET значением свойства verb, мы будем указывать URL, откуда сервис должен будет взять файл
- мы определяем выходной параметр OutputBmp как файл thumbnail.bpm, который может быть (опционально) сгенерирован нашей activity
- мы указываем командную строку, которую будет запускать engine с нашими параметрами
- синтаксис $(<something>.path) будет преобразован в актуальные пути engine, input/output файлов или app bundle-ов при запуске activity
Так же как для app bundle, мы должны создать alias, указывающий на первую версию нашей activity:
- curl -X POST \
- https://developer.api.autodesk.com/da/us-east/v3/activities/GenerateThumbnail/aliases \
- -H 'Authorization: Bearer <YOUR ACCESS TOKEN>' \
- -H 'Content-Type: application/json' \
- -d '{
- "id": "prod",
- "version": 1
- }'
Запуск work item
Перед запуском GenerateThumbnail activity, нам нужно подготовить url-ы исходного файла Inventor-а и bmp-файла, который должна сгенерировать наша activity. Можно использовать любые решения, позволяющие хранить файлы и обращаться к ним по URL, а так же иметь возможность загрузки файла по заданному URL. В нашем примере мы воспользуемся Data Management API, с помощью POST-запроса /oss/v2/buckets/:bucketKey/objects/:objectKey/signed создадим URL с доступом на чтение для файла Inventor-а (IPT) и второй URL с доступом на запись, куда будет загружаться сгенерированный файл thumbnail.bmp:
- curl -X POST \
- 'https://developer.api.autodesk.com/oss/v2/buckets/<YOUR BUCKET KEY>/objects/<YOUR INPUT IPT FILENAME>/signed?access=read' \
- -H 'Authorization: Bearer <YOUR ACCESS TOKEN>' \
- -H 'Content-Type: application/json' \
- -d '{}'
- curl -X POST \
- 'https://developer.api.autodesk.com/oss/v2/buckets/<YOUR BUCKET KEY>/objects/<YOUR OUTPUT BMP FILENAME>/signed?access=readwrite' \
- -H 'Authorization: Bearer <YOUR ACCESS TOKEN>' \
- -H 'Content-Type: application/json' \
- -d '{}'
Теперь создадим work item:
- curl -X POST \
- https://developer.api.autodesk.com/da/us-east/v3/workitems \
- -H 'Authorization: Bearer <YOUR ACCESS TOKEN>' \
- -H 'Content-Type: application/json' \
- -d '{
- "activityId": "<OWNER ID>.GenerateThumbnail+prod",
- "arguments": {
- "PartFile": {
- "url": "<YOUR INPUT FILE URL>",
- "zip": false
- },
- "OutputBmp": {
- "url": "<YOUR OUTPUT FILE URL>",
- "verb": "put"
- }
- }
- }'
Ответом этого запроса будет что-то вроде:
- {
- "status": "pending",
- "stats": {
- "timeQueued": "..."
- },
- "id": "<WORK ITEM ID>"
- }
Зная work item id, мы можем запросить её статус:
- curl -X GET \
- https://developer.api.autodesk.com/da/us-east/v3/workitems/<WORK ITEM ID> \
- -H 'Authorization: Bearer <YOUR ACCESS TOKEN>'
Если задача выполнена успешно, ответ будет иметь следующую структуру:
- {
- "status": "success",
- "reportUrl": "...",
- "stats": {
- "timeQueued": "...",
- "timeDownloadStarted": "...",
- "timeInstructionsStarted": "...",
- "timeInstructionsEnded": "...",
- "timeUploadEnded": "..."
- },
- "id": "<WORK ITEM ID>"
- }
В случае возникновения проблем, в поле reportUrl будет URL текстового файла с подробной информацией.
Вот, собственно, и всё. По второму URL ("<YOUR UPLOAD FILE URL>") будет доступен файл со сгенерированным изображением Вашего файла Inventor-а.
Источник: https://forge.autodesk.com/blog/simple-introduction-design-automation-inventor
Обсуждение: http://adn-cis.org/forum/index.php?topic=
Опубликовано 11.01.2019Отредактировано 11.01.2019 в 16:51:50
