Revitモデル上の部材を選択する【Selectionクラス使用】

モデル上に配置されている部材を選択する方法は？

RevitAPIを使ってあれこれやっていくためには、まずはその対象となる部材を選択する必要があります。

ここでは、

クリック選択（単独）でモデル上の部材を選択する手法
クリック選択（複数）でモデル上の部材を選択する手法
範囲選択でモデル上の部材を選択する手法

を紹介していきます。

Contents

部材選択で使用するクラス
部材の単独選択
部材の複数選択
部材の範囲選択
サンプルコードの解説
Revitモデル上の部材選択｜まとめ
- RevitAPI独学用教材
- Revitアドイン作ります

部材選択で使用するクラス

モデル上で部材を選択したい時にはReferenceクラスが有効です。

【参考】Selection Class | Revit API Docs

部材の単独選択

部材を単独選択したい時には下記のコードを使います。

public void Sample01()
{
  UIDocument uidoc = this.ActiveUIDocument;
  
  
  Reference reference = uidoc.Selection.PickObject(ObjectType.Element);
  TaskDialog.Show("Message", reference.ElementId.ToString());
}

※上記コードをThisApplication.csにコピペでそのまま使えます。

これを実行すると、部材上にカーソルが乗ったときに選択が可能です。

部材選択するとその部材のIDがダイアログ表示されます。

7行目は選択結果をダイアログ表示しているので、部材選択のため必要なのは6行目のコードだけです。

部材の複数選択

部材を複数選択したい時には下記のコードを使います。

public void Sample02()
{
  UIDocument uidoc = this.ActiveUIDocument;
  
  
  IList<Reference> referenceList = uidoc.Selection.PickObjects(ObjectType.Element);
  string referenceIds = "";
  foreach(Reference reference in referenceList)
  {
    referenceIds += reference.ElementId.ToString() + "\n";
  }
  TaskDialog.Show("Message", referenceIds);
}

※上記コードをThisApplication.csにコピペでそのまま使えます。

これを実行すると、部材上にカーソルが乗ったときに選択が可能です。

単独選択と異なるのは、1部材を選択したあとにIDダイアログが表示されず、続けて選択できることです。

何個か選択して、「終了」ボタンを押してみてください。

選択したすべての部材IDがダイアログ表示されます。

7行目以降はID取得と表示のためのコードで、部材選択のため必要なのは6行目だけです。

部材の範囲選択

部材を範囲選択したい時には下記のコードを使います。

public void Sample03()
{
  UIDocument uidoc = this.ActiveUIDocument;
  
  
  IList<Element> elementList = uidoc.Selection.PickElementsByRectangle();
  string elementIds = "";
  foreach(Element element in elementList)
  {
    elementIds += element.Id.ToString() + "\n";
  }
  TaskDialog.Show("Message", elementIds);
}

※上記コードをThisApplication.csにコピペでそのまま使えます。

これを実行すると、範囲選択による部材の選択が可能です。

範囲選択したすべての部材IDがダイアログ表示されます。

7行目以降はID取得と表示のためのコードで、部材選択のため必要なのは6行目だけです。

サンプルコードの解説

以上３つのサンプルコードを示しました。

上記コードをコピペするだけでプログラムは動きますが、詳しく知りたい方は以下もご覧ください。

Selectionクラスのメソッド

サンプルコードの中では、どれもUIDocumentクラスのインスタンス「uidoc」を生成しています。

そして、uidocのプロパティとしてSelectionクラスにアクセスしているまでが共通コードですね。

その後に、Selectionクラスのどのメソッドを使うかで選択方法が変わってきています。

ここで使っているメソッドは以下のとおりです。

メソッド	引数	選択方法	戻り値
PickObject	ObjectType	クリック選択（単独部材を選択）	Reference
PickObjects	ObjectType	クリック選択（複数部材を選択）	IList<Reference>
PickElementsByRectangle	なし	範囲選択	IList<Element>

それぞれ解説します。

PickObjectとPickObjects

名前のとおり部材をポチポチと選択していくメソッドです。

サンプルで使った引数はObjectTypeですが、そのほかに以下のオーバーロードがあります。

PickObject(ObjectType)
PickObject(ObjectType, ISelectionFilter)
PickObject(ObjectType, String)
PickObject(ObjectType, ISelectionFilter, String)

PickObject(ObjectType)

ObjectTypeは部材をどのように選択するのかを決定する列挙型です。

ObjectType Enumeration（メンバー｜効果）

Nothing	何も選択できません
Element	通常の要素選択
PointOnElement	要素上の点を選択する
Edge	要素をエッジで選択する
Face	要素を面で選択する
LinkedElement	リンクファイルの要素を選択する