Сообщество программистов Autodesk в СНГ :: API для работы с семействами. Создание типоразмеров. Выделение и изменение экземпляров семейства

Сообщество программистов Autodesk в СНГ
Revit API
API для работы с семействами. Создание типоразмеров. Выделение и изменение экземпляров семейства

27/12/2013

API для работы с семействами. Создание типоразмеров. Выделение и изменение экземпляров семейства

Добро пожаловать во втроую часть подробного обсуждения API для работы с семействами.

Основная функциональность работы с семействами была представлена Стивеном Кэмпбелом (Steven Campbell) в его докладе Ключевые концепции при работе с семействами на Revit DevCamp в Москве. Первую часть статей по работе с семействами можете прочитать здесь.

Будет еще и третяя заключительная часть, которую мы рассмотрим чуть позднее.

Итак, начнем.

Часть 2 - Выбор и редактирование экземпляров семейства

Рассмотрим редактирование заданного экземпляра семейства на примере создания нового типоразмера и применения созданного типоразмера на экземпляре.

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

Создание нового типоразмера

Создать новый типоразмер для уже загруженного семейства на самом деле очень легко, так как достаточно просто вызвать метод Duplicate для копирования уже существующего типоразмера.

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

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

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

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

  /// <summary>
 /// Устанавливает значение параметра по его наименованию
 /// заданного элемента в миллиметрах
 /// </summary>
 void SetElementParameterInMm(
   Element e,
   string parameter_name,
   double lengthInMm )
 {
   e.get_Parameter( parameter_name )
     .Set( Util.MmToFoot( lengthInMm ) );
 }  

Кроме этого, мы изменим материал нового типоразмера нашего стола на Стекло. Материал определяется двумя параметрами: материал столешницы и материал ножек. Значение параметров задающих материал являются идентификаторами материала в соответствующей внутренней базе данных Revit.

Реализация метода CreateNewType, принимающего в качества параметра исходный типоразмер, который нужно скопировать, представлена ниже:

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

  /// <summary>
 /// Создание нового типоразмера
 /// Параметры для изменения
 /// Ширина = 1200
 /// Глубина = 750
 /// Высота = 380
 /// Материал столешницы  = Стекло
 /// Материал ножек = Стекло
 /// </summary>
 FamilySymbol CreateNewType( FamilySymbol oldType )
 {
   FamilySymbol sym = oldType.Duplicate(
     _type_name ) as FamilySymbol;
 
   SetElementParameterInMm( sym, "Ширина", 1200 );
   SetElementParameterInMm( sym, "Глубина", 750 );
   SetElementParameterInMm( sym, "Высота", 380 );
 
   Element material_glass = Util.FindElementByName(
     sym.Document, typeof( Material ), "Стекло" );
 
   ElementId id = material_glass.Id;
 
   sym.get_Parameter( "Материал столешницы" ).Set( id );
   sym.get_Parameter( "Материал столешницы" ).Set( id );
   return sym;
 }

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

Получить нужный типоразмер можно с помощью вспомогательного метода FindElementByName, который мы обсуждали в прошлой статье. Мы его использовали для проверки существования семейства в проекте перед его загрузкой.

В данном случае нам нужно найти типоразмер (класс FamilySymbol) с соответствующим именем.

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

Поиск элемента по его наименованию можно также ускорить, если применить фильтр по значению параметра, вместо того, чтобы использовать фильтрацию средствами .NET, когда Revit уже выдал результат поиска.

Вызов вспомогательного метода и поиск существующего типоразмера можно выполнить одной строкой кода, использовав оператор ‘??’. Оператор проверяет значение правой части выражения. Если оно равно null, то выполняется левая часть, если же не равно, то берется значение правой части:

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

 
  // Найти существующий типоразмер или создать новый
  FamilySymbol symbol
    = Util.FindElementByName( doc,
      typeof( FamilySymbol ), _type_name )
        as FamilySymbol
    ?? CreateNewType( tables[0].Symbol );
 

Работа с выбранными экземплярами семейств.

Перед тем как создать типоразмер и применить его к конкретному экземпляру, нам нужно по работать над тем, как мы определим тот экземпляр, который мы будем менять.

Обработать выделенные элементы можно двумя способами.

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

Второй, попросить пользователя выделить элементы непосредственно в теле команды с помощью метода PickObjects. С помощью этого метода можно значительно улучшить процесс выделения, запретив выбирать ненужные элементы. Для этого необходимо реализовать интерфейс ISelectionFilter и передать его в метод PickObjects.

Я реализовал два этих способа в отдельном классе TableSelector. Работать с этим классом достаточно легко:

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

  TableSelector selector
    = new TableSelector( uidoc );
 
  IList<FamilyInstance> tables
    = selector.SelectedTables;
 
  if( null == tables )
  {
    return selector.Return();
  }

Как можно заметить класс TableSelector содержит три публичных метода:

Конструктор, в котором и выполняются все необходимые действия
Свойство SelectedTables, которое возвращает результат выделения
Метод Return, который определяет результат: успешно, с ошибкой или отмена операции

В нем так же содержится метод IsTable, в котором определяется является ли объект столом или нет.

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

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

static public bool IsTable( Element e )
{
  bool rc = false;
 
  Category cat = e.Category;
 
  if( null != cat )
  {
    if( cat.Id.IntegerValue.Equals(
      (int) BuiltInCategory.OST_Furniture ) )
    {
      FamilyInstance fi = e as FamilyInstance;
 
      if( null != fi )
      {
        string fname = fi.Symbol.Family.Name;
 
        rc = fname.Equals(
          CmdTableLoadPlace.FamilyName );
      }
    }
  }
  return rc;
}

Используя этот вспомогательный метод, реализация фильтра для выбора стола становится довольно простой:

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

class TableSelectionFilter : ISelectionFilter
{
  public bool AllowElement( Element e )
  {
    return IsTable( e );
  }
 
  public bool AllowReference( Reference r, XYZ p )
  {
    return true;
  }
}

Целиком класс TableSelector выглядит следующим образом:

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

class TableSelector
{
  const string _usage_error = "Пожалуйста, выберите предварительно "
    + "экземпляр семейства Стол "
    + "перед тем как запускать команду.";
 
  List<FamilyInstance> _tables;
  string _msg;
  Result _result;
 
  /// <summary>
  /// Возвращает выделенные столы или null
  /// </summary>
  public IList<FamilyInstance> SelectedTables
  {
    get
    {
      return _tables;
    }
  }
 
  /// <summary>
  /// Инициализация TableSelector
  /// </summary>
  public TableSelector( UIDocument uidoc )
  {
    _tables = null;
    _msg = null;
 
    Document doc = uidoc.Document;
 
    if( null == doc )
    {
      _msg = "Пожалуйста запустите команду из файла проекта";
      _result = Result.Failed;
    }
 
    // Проверка на выбор стола перед запуском команды.
 
    Selection sel = uidoc.Selection;
 
    int n = sel.Elements.Size;
 
    if( 0 < n )
    {
      if( 1 != n )
      {
        _msg = _usage_error;
        _result = Result.Failed;
      }
 
      foreach( Element e in sel.Elements )
      {
        if( !IsTable( e ) )
        {
          _msg = _usage_error;
          _result = Result.Failed;
        }
 
        if( null == _tables )
        {
          _tables = new List<FamilyInstance>( n );
        }
 
        _tables.Add( e as FamilyInstance );
      }
    }
 
    // Если Столы не выбраны перед выполнением команды,
    // просим пользователя их выбрать.
 
    if( null == _tables
      || 0 == _tables.Count )
    {
      IList<Reference> refs = null;
 
      try
      {
        refs = sel.PickObjects( ObjectType.Element,
          new TableSelectionFilter(),
          "Пожалуйста выберите столы для изменения" );
      }
      catch( Autodesk.Revit.Exceptions
        .OperationCanceledException )
      {
        _result = Result.Cancelled;
      }
 
      if( null != refs && 0 < refs.Count )
      {
        _tables = new List<FamilyInstance>(
          refs.Select<Reference, FamilyInstance>(
            r => doc.GetElement( r.ElementId )
              as FamilyInstance ) );
      }
    }
 
    Debug.Assert(
      null == _tables || 0 < _tables.Count,
      "Удостоверьтесь, что столы выбраны" );
 
    _result = (null == _tables) // || 0 == _tables.Count
      ? Result.Cancelled
      : Result.Succeeded;
  }
  /// <summary>
  /// Возвращает отмену или код возврата
  /// или сообщение об ошибке
  /// </summary>
  public Result Return()
  {
    if( Result.Failed == _result )
    {
      Debug.Assert( 0 < _msg.Length,
        "Ожидаем сообщение об ошибки" );
 
      Util.ErrorMsg( _msg );
    }
    return _result;
  }
}

Заметьте, что выделив проверку выбора стола в отдельный метод IsTable значительно облегчило мне жизнь в будущем.

Изменение типоразмера для выбранного экземпляра семейства

Мы уже получили типоразмер, выбрав его из существующих или создав новый, выбрали экземпляры семейства, типоразмер которого мы хотим поменять. Осталось самое простое – изменить типоразмер. Сделать это довольно легко. Нужно перебрать все выбранные экземпляры и изменить свойство Symbol.

Полный код команды реализующий изменение типоразмера:

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

/// <summary>
/// Создание нового типоразмера для семейства Стол
/// и применение типоразмера для выбранных элементов
/// </summary>
[Transaction( TransactionMode.Manual )]
public class CmdTableNewTypeModify : IExternalCommand
{
  const string _usage_error = "Пожалуйста, выберите предварительно "
    + "экземпляр семейства Стол "
    + "перед тем как запускать команду.";
 
  /// <summary>
  /// Наименование нового типоразмера стола
  /// </summary>
  const string _type_name = "1200x750x380мм";
 
  public Result Execute(
    ExternalCommandData commandData,
    ref string message,
    ElementSet elements )
  {
    UIApplication uiapp = commandData.Application;
    UIDocument uidoc = uiapp.ActiveUIDocument;
    Application app = uiapp.Application;
    Document doc = uidoc.Document;
 
    TableSelector selector
      = new TableSelector( uidoc );
 
    IList<FamilyInstance> tables
      = selector.SelectedTables;
 
    if( null == tables )
    {
      return selector.Return();
    }
 
    using( Transaction tx = new Transaction( doc ) )
    {
      tx.Start( "Создание типоразмера и применение его к экземпляру" );
 
      // Поиск существующего типоразмера или создание нового
 
      FamilySymbol symbol
        = Util.FindElementByName( doc,
          typeof( FamilySymbol ), _type_name )
            as FamilySymbol
        ?? CreateNewType( tables[0].Symbol );
 
      foreach( FamilyInstance table in tables )
      {
        Debug.Print( Util.ElementDescription(
          table ) );
 
        table.Symbol = symbol;
      }
 
      tx.Commit();
    }
    return Result.Succeeded;
  }
}