Сообщество программистов Autodesk в СНГ

Сообщество программистов Autodesk в СНГ
Revit API
DocumentChanged VS Dynamic Model Updater

31/07/2013

DocumentChanged VS Dynamic Model Updater

DocumentChanged VS Dynamic Model Updater

Небольшой обзор и сравнение двух способов отслеживания изменений в модели Revit. Revit API предоставляет два различных способа: подписаться на событие DocumentChangedEvent или зарегистрировать DMU dynamic model updater (динамическое обновление модели). После того как вы подписались на событие или зарегистрировали DMU, важно не забыть отписаться от этого события или отменить регистрацию DMU, когда больше нет необходимости отслеживать изменения.

Рассмотрим два способа на примере отображения сообщения, когда добавляется новый вид Фасад здания.

Подписка на событие DocumentChanged для реагирования на добавление нового Фасада

Очень легко определить когда какой-то определенный элемент был добавлен, например новый вид, подписавшись на событие DocumentChanged. Это можно сделать в методе OnStartup при старте Revit, или при запуске вашей команды. В любом случае, следует иметь ввиду, что отписаться от события нужно в любом случае, после того как оно вам больше не нужно. Это можно сделать в методе OnShutdown, в конце выполнения команды или каким-либо иным способом.

Ниже представлен полный код реализации внешней команды:

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

 
    /// <summary>
    /// Реакция на добавление нового вида Фасад
    /// </summary>
    [Transaction(TransactionMode.ReadOnly)]
    public class CmdElevationWatcher : IExternalCommand
    {
        /// <summary>
        /// Возвращает первый вид типа Фасад в переданной коллекции 
        /// Element Id или null если вид не найден
        /// </summary>
        static View FindElevationView(
          Document doc,
          ICollection<ElementId> ids)
        {
            View view = null;
 
            foreach (ElementId id in ids)
            {
                view = doc.GetElement(id) as View;
 
                if (null != view
                  && ViewType.Elevation == view.ViewType)
                {
                    break;
                }
 
                view = null;
            }
            return view;
        }
 
        
        public Result Execute(
          ExternalCommandData commandData,
          ref string message,
          ElementSet elements)
        {
            UIApplication uiapp = commandData.Application;
            Application app = uiapp.Application;
 
            // Подписка на событие DocumentChanged
 
            app.DocumentChanged
              += OnDocumentChanged;
 
            return Result.Succeeded;
        }
 
        /// <summary>
        /// Обработка события DocumentChanged
        /// </summary>
        private void OnDocumentChanged(object sender, DocumentChangedEventArgs e)
        {
            Document doc = e.GetDocument();
 
            View view = FindElevationView(
              doc, e.GetAddedElementIds());
 
            if (null != view)
            {
                string msg = string.Format(
                  "Вы только что создали новый вид Фасад "
                  + " '{0}'.",
                  view.Name);
 
                TaskDialog.Show("ElevationChecker", msg);
            }
        }
    }
 

Выполнив команду, произойдет подписка на событие. После этого, все попытки добавить новый Фасад будут сопровождаться сообщением. Например, если я скопирую вид Восточный, то получу такое сообщение:

Но такой подход имеет два значительных недостатка:

1) Он реагирует также на добавление семейства

2) Производительность метода не очень оптимальна

1. Когда семейство загружается в проект, также загружаются и все виды, присутствующие в этом семействе. Соответственно происходит обработка события DCE. Например, если я вставлю стандартное семейство Колонна прямоугольного сечения.rfa, то также увижу сообщение о вставке Фасада:

Такое поведение может сбить с толку

2. Производительность. Событие DocumentChanged реагирует абсолютно на любое изменение модели. Более того, когда мы добавляем любой элемент или элементы, нужно проверить не является ли этот элемент Фасадом.

Оба этих недостатка можно избежать, используя механизм Dynamic Model Updater

Регистрация Dynamic Model Updater для реагирования на добавление нового Фасада

Как я уже сказал, с помощью механизма DMU можно легко определить какие конкретно элементы были добавлены в модель, и избежать недостатков DCE о которых я упомянул чуть ранее, так как DMU реагирует строго на определенные изменения модели (добавление, изменение, удаление) и на строго определенных набор элементов, который задается при регистрации DMU.

Первым делом нам нужно создать класс, реализующий интерфейс IUpdater, в котором мы будет отображать сообщение при добавлении Фасада.

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

 
    /// <summary>
    /// Updater оповещающий пользователя при добавлении фасада.
    /// </summary>
    public class ElevationWatcherUpdater : IUpdater
    {
        static AddInId _appId;
        static UpdaterId _updaterId;
 
        public ElevationWatcherUpdater(AddInId id)
        {
            _appId = id;
 
            _updaterId = new UpdaterId(_appId, new Guid(
                                                   "fafbf6b2-4c06-42d4-97c1-d1b4eb593eff"));
        }
 
        public void Execute(UpdaterData data)
        {
            Document doc = data.GetDocument();
            Application app = doc.Application;
            foreach (ElementId id in
                data.GetAddedElementIds())
            {
                View view = doc.GetElement(id) as View;
 
                if (null != view
                    && ViewType.Elevation == view.ViewType)
                {
                    TaskDialog.Show("ElevationWatcher Updater",
                                    string.Format("Новый фасад'{0}'",
                                                  view.Name));
                }
            }
        }
 
        public string GetAdditionalInformation()
        {
            return "The Building Coder, "
                   + "http://thebuildingcoder.typepad.com";
        }
 
        public ChangePriority GetChangePriority()
        {
            return ChangePriority.FloorsRoofsStructuralWalls;
        }
 
        public UpdaterId GetUpdaterId()
        {
            return _updaterId;
        }
 
        public string GetUpdaterName()
        {
            return "ElevationWatcherUpdater";
        }
    }
 

Создадим еще одну внешнюю команду для регистрации нашего Updater’а и зададим триггер для него. Назовем ее CmdElevationWatcherUpdater. Триггер будет реагировать только на добавление нового фасада и больше ни на что.

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

 
    [Transaction(TransactionMode.ReadOnly)]
    public class CmdElevationWatcherUpdater : IExternalCommand
    {
        public Result Execute(
            ExternalCommandData commandData,
            ref string message,
            ElementSet elements)
        {
            UIApplication uiapp = commandData.Application;
            Application app = uiapp.Application;
 
            // Register updater to react to view creation
 
            ElevationWatcherUpdater updater
                = new ElevationWatcherUpdater(
                    app.ActiveAddInId);
 
            UpdaterRegistry.RegisterUpdater(updater);
 
            ElementCategoryFilter f
                = new ElementCategoryFilter(
                    BuiltInCategory.OST_Views);
 
            UpdaterRegistry.AddTrigger(
                updater.GetUpdaterId(), f,
                Element.GetChangeTypeElementAddition());
 
            return Result.Succeeded;
        }
    }

После запуска команды наш Updater зарегистрирован и задан триггер. Как и ранее, после выполнения этой команды, при добавлении Фасада появится сообщение.

Отписка от события DocumentChanged и отмена регистрации Dynamic Model Updater

Для отписки и отмены регистрации я немного подправлю код команд так, что каждый последующий вызов команды подписывает или отменяет подписку на событие или регистрирует или отменяет регистрацию Updater’а

В обоих случаях это очень легко сделать. Я просто добавлю статическое свойство содержащее делегат обработки события или Updater'а и установлю и значение равным null.

Вот так это выглядит для события:

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

 
 EventHandler<DocumentChangedEventArgs>
             _handler = null;

И еще проще для Updater’а

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

 
private ElevationWatcherUpdater _updater = null;
 

Каждый раз когда команда выполняется происходит подписка или регистрация и переменным присваивается значение если до этого они были равны null, или происходит отписка от события или отмена регистрации и присваивание переменным null в противном случае.

Ниже обновленный фрагмент кода для события DocumentChanged:

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

 
            // Подписка на событие DocumentChanged
            if (_handler == null)
            {
                _handler =
                    OnDocumentChanged;
 
                app.DocumentChanged
                    += _handler;
            }
            else
            {
                //Отписка
                app.DocumentChanged -=
                    _handler;
                _handler = null;
 
            }

И соответствующий код для DMU:

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

 
            if (_updater == null)
            {
                _updater
                    = new ElevationWatcherUpdater(
                        app.ActiveAddInId);
 
                UpdaterRegistry.RegisterUpdater(_updater);
 
                ElementCategoryFilter f
                    = new ElementCategoryFilter(
                        BuiltInCategory.OST_Views);
 
                UpdaterRegistry.AddTrigger(
                    _updater.GetUpdaterId(), f,
                    Element.GetChangeTypeElementAddition());
            }
            else
            {
                UpdaterRegistry.UnregisterUpdater(_updater.GetUpdaterId());
 
                _updater = null;
            }
 

Надеюсь вы найдете это сравнение полезным для себя, оцените насколько просто пользоваться этим двумя способами и поймете преимущества, которые предлагает DMU.

Дополнение: Как справедливо заметил Виктор, я упустил еще одно важное отличие между DCE и DMU, которое мы уже несколько раз обсуждали ранее.

Обработка события DocumentChanged не возникнет до тех пор, пока транзакция не завершена. Таким образом, нельзя отменить изменения в обработке события. Если элементы были удалены, то в обработке события вы сможете получить только их Id и даже не узнаете что это были за элементы. Updater же вызывается в момент совершения транзакции и поэтому более контролируем.

Демонстрационный проект можно скачать архивом здесь или на GitHub.

Источник: http://thebuildingcoder.typepad.com/blog/2012/06/documentchanged-versus-dynamic-model-updater.html

Обсуждение: http://adn-cis.org/forum/index.php?topic=122.0

Опубликовано 31.07.2013
Отредактировано 01.08.2013 в 09:04:48