Сообщество программистов Autodesk в СНГ :: Создание пользовательских команд Fusion

Сообщество программистов Autodesk в СНГ
Fusion 360 API
Создание пользовательских команд Fusion - Часть 1

24/06/2015

Создание пользовательских команд Fusion - Часть 1

Обзор команд

Fusion имеет четкую концепцию того, что такое команда. На высоком уровне, команда представляет из себя именно то, что вы от неё ожидаете; пользователь вызывает команду, она проводит его через процесс сбора требуемых данных, часто обеспечивая предварительный просмотр ожидаемого результата, а затем создает конечный результат, который может быть отменен.

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

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

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

При запуске команды, Fusion создает новый объект команда и запускает событие commandCreated, который передает объект Command для надстройки.Ваша надстройка реагирует на это событие, и либо сразу делает то, что действие команды должны делать, или это начинает сбор данных от пользователя. Ниже представлен полный код на Python для основной надстройки, которая создает командную кнопку, а затем ждет события, которое уведомляет её, когда кнопка была нажата пользователем, а затем сразу реагирует на это.В этом случае все что она делает - это отображает окно сообщения в ответ на созданное командой событие, но может делать что-нибудь другое.

Код - Python: [Выделить]

import adsk.core, adsk.fusion, traceback
 
handlers = []
 
def run(context):
 ui = None
 try:
   app = adsk.core.Application.get()
   ui = app.userInterface
 
   # Получить коллекцию CommandDefinitions.
   cmdDefs = ui.commandDefinitions
 
# Создание определение кнопки команды.
   buttonSample = cmdDefs.addButtonDefinition('MyButtonDefIdPython', 'Sample Button',
                         'Пример подсказки кнопки',
                         './/Resources//Sample')
 
# Подключение к созданному командой событию.
   sampleCommandCreated = SampleCommandCreatedEventHandler()
   buttonSample.commandCreated.add(sampleCommandCreated)
   handlers.append(sampleCommandCreated)
 
# Получить группу панелей Inspect.
   inspectPanel = ui.allToolbarPanels.itemById('InspectPanel')
 
   # Добавить кнопку в нижней части.
   buttonControl = inspectPanel.controls.addCommand(buttonSample, 'MyButtonControlIDPython')
 
 except:
   if ui:
     ui.messageBox('Failed:\n{}'.format(traceback.format_exc()))
 
 
# Поддержка выгрузки надстройки.
def stop(context):
 try:
   app = adsk.core.Application.get()
   ui = app.userInterface
 
   # Очистить пользовательский интерфейс.
   cmdDef = ui.commandDefinitions.itemById('MyButtonDefIdPython')
   if cmdDef:
     cmdDef.deleteMe()
 
   inspectPanel = ui.toolbarPanels.itemById('InspectPanel')
   cntrl = inspectPanel.controls.itemById('MyButtonControlIDPython')
   if cntrl:
     cntrl.deleteMe()
 
 except:
   if ui:
     ui.messageBox('Сбой:\n{}'.format(traceback.format_exc()))
 
 
# Обработка созданного командой события.
class SampleCommandCreatedEventHandler(adsk.core.CommandCreatedEventHandler):
 def __init__(self):
   super().__init__()
 def notify(self, args):
   try:
     app = adsk.core.Application.get()
     ui = app.userInterface
 
     cmd = args.command
 
     ui.messageBox('Команда выполнена.')
 except:
   if ui:
     ui.messageBox('Не удалось:\n{}'.format(traceback.format_exc()))

Ниже приведен эквивалентный код на JavaScript.

Код - JavaScript: [Выделить]

function run(context) {
 
 "use strict";
 if (adsk.debug === true) {
   /*jslint debug: true*/
   debugger;
   /*jslint debug: false*/
 }
 
 var ui;
 try {
   var app = adsk.core.Application.get();
   ui = app.userInterface;
 
   // Получение коллекции CommandDefinitions.
   var cmdDefs = ui.commandDefinitions;
 
// Создать определение кнопки команды.
   var buttonSample = cmdDefs.addButtonDefinition('MyButtonDefIdJS', 'Sample Button',
                           'Пример всплывающей подсказки кнопки',
                           './/Resources//Sample');
 
// Подключите созданное кнопкой событие.
   buttonSample.commandCreated.add(SampleCommandCreatedEventHandler);
 
// Получить группу панелей Inspect.
   var inspectPanel = ui.allToolbarPanels.itemById('InspectPanel');
 
   // Добавление кнопки в нижней части.
   var buttonControl = inspectPanel.controls.addCommand(buttonSample, 'MyButtonControlIDJS');
 }
 catch (e) {
   if (ui) {
     ui.messageBox('Failed : ' + (e.description ? e.description : e));
   }
 }
}
 
 
// Поддержка выгрузки надстройки.
function stop(context) {
 var ui;
 try {
   var app = adsk.core.Application.get();
   ui = app.userInterface;
 
   // Очистка интерфейса.
   var cmdDef = ui.commandDefinitions.itemById('MyButtonDefIdJS');
   if (cmdDef) {
     cmdDef.deleteMe();
   }
 
   var inspectPanel = ui.toolbarPanels.itemById('InspectPanel');
   var cntrl = inspectPanel.controls.itemById('MyButtonControlIDJS');
   if (cntrl) {
     cntrl.deleteMe();
   }
 }
 catch (e) {
   if (ui) {
     ui.messageBox('Failed : ' + (e.description ? e.description : e));
   }
 }
}
 
 
// Обработка команды созданного события.
var SampleCommandCreatedEventHandler = function(args) {
try {
  var cmd = args.command;
 
  var app = adsk.core.Application.get();
  var ui = app.userInterface;
  ui.messageBox('Команда выполнена.');
}
catch (e) {
  if (ui) {
    ui.messageBox('Failed : ' + (e.description ? e.description : e));
  }
}
};