Следующий пример взят прямо из документации по API, как и последующие несколько примеров.
Модальный оператор определяет функцию
Operator.modal
которая при запуске обрабатывает события, пока не вернёт
'FINISHED'
или
'CANCELLED'
. Grab (сдвиг), Rotate (вращение), Scale (масштабирование) и Fly-Mode (режим полёта) - примеры модальных операторов. Они особенно полезны для интерактивных инструментов, ваш оператор может иметь собственное состояние, в котором клавиши переключают опции работы оператора.
Когда вызывается оператор в этом примере, он добавляет модального обработчика к себе с помощью вызова
context.window_manager.modal_handler_add(self)
. После этого активный объект продолжает перемещаться по плоскости XY, повторяя перемещения мыши. Для того, чтобы выйти, нажмите кнопку мыши или клавишу Esc.
Модальный метод обрабатывает три типа событий:
1. Перемещение мыши перемещает активный объект.
2. Нажатие ЛКМ для подтверждения и выхода в нормальный режим. Объект оставляется в своей новой позиции.
3. Нажатие ПКМ или клавиши Esc, чтобы отменить и выйти в нормальный режим. Объект возвращается в свою первоначальную позицию.
Важно, чтобы был некоторый способ выходить в нормальный режим. Если функция modal всегда возвращает 'RUNNING_MODAL', скрипт войдёт в бесконечный цикл, и Вам придётся перезапускать Блендер.
Модальный оператор определяет два специальных метода с именами
__init__
и
__del__
, которые вызываются, когда модальная операция начинается и прекращается, соответственно.
Запустите скрипт. Активный объект перемещается по плоскости XY при перемещении мыши. Скрипт также создает панель с кнопкой, нажатием на которую Вы также можете выполнить модальный оператор.