revit api选择selection class
// 在Revit二次开发中，Selection 类是用于处理Revit用户界面中元素选择的核心类。它允许你获取当前用户选择的元素，或者提示用户选择新的元素（包括单个元素、多个元素、点、边、面、矩形区域等），甚至可以设置Revit界面中的选择集。
// Selection 类位于 Autodesk.Revit.UI.Selection 命名空间下。要使用它，你需要首先获取 UIDocument 实例，然后通过 uidoc.Selection 属性来访问 Selection 类的实例。
// 以下是 Selection 类的一些常用方法和用法，以及C#代码示例：
// 1. 获取当前用户选择的元素
// 这是最基本的功能之一。GetElementIds() 方法返回一个 ICollection<ElementId>，其中包含当前在Revit界面中被选中的所有元素的ID。
--------------------------------------------------------------------------------------------------------------------------------------------------------
C#
using Autodesk.Revit.DB;
using Autodesk.Revit.UI;
using Autodesk.Revit.UI.Selection;
using System.Collections.Generic;
using System.Linq;
[Autodesk.Revit.Attributes.Transaction(Autodesk.Revit.Attributes.TransactionMode.Manual)]
public class GetSelectionCommand : IExternalCommand
{
public Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements)
{
UIDocument uidoc = commandData.Application.ActiveUIDocument;
Document doc = uidoc.Document;
// 获取当前选中的元素ID集合
ICollection<ElementId> selectedIds = uidoc.Selection.GetElementIds();
if (selectedIds.Count == 0)
{
TaskDialog.Show("Revit Selection", "当前没有选中任何元素。");
}
else
{
string selectedElementsInfo = $"当前选中了 {selectedIds.Count} 个元素：\n";
foreach (ElementId id in selectedIds)
{
Element elem = doc.GetElement(id);
if (elem != null)
{
selectedElementsInfo += $"- ID: {id}, 类别: {elem.Category?.Name ?? "N/A"}, 名称: {elem.Name}\n";
}
}
TaskDialog.Show("Revit Selection", selectedElementsInfo);
}
return Result.Succeeded;
}
}
--------------------------------------------------------------------------------------------------------------------------------------------------------
// 2. 设置Revit界面中的选择集
// SetElementIds() 方法允许你通过提供一个 ICollection<ElementId> 来编程地设置Revit界面中的当前选择集。
C#
using Autodesk.Revit.DB;
using Autodesk.Revit.UI;
using Autodesk.Revit.UI.Selection;
using System.Collections.Generic;
using System.Linq;
[Autodesk.Revit.Attributes.Transaction(Autodesk.Revit.Attributes.TransactionMode.Manual)]
public class SetSelectionCommand : IExternalCommand
{
public Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements)
{
UIDocument uidoc = commandData.Application.ActiveUIDocument;
Document doc = uidoc.Document;
// 假设我们要选择所有墙
FilteredElementCollector collector = new FilteredElementCollector(doc);
ICollection<ElementId> wallIds = collector.OfClass(typeof(Wall)).ToElementIds();
if (wallIds.Count == 0)
{
TaskDialog.Show("Revit Selection", "文档中没有找到任何墙。");
}
else
{
// 设置新的选择集
uidoc.Selection.SetElementIds(wallIds);
TaskDialog.Show("Revit Selection", $"已选择 {wallIds.Count} 堵墙。");
}
return Result.Succeeded;
}
}
--------------------------------------------------------------------------------------------------------------------------------------------------------
// 3. 提示用户选择单个对象 (PickObject)
// PickObject() 方法会暂停你的程序，直到用户在Revit界面中选择一个对象。它返回一个 Reference 对象，你可以通过 doc.GetElement(reference.ElementId) 来获取对应的 Element。
// ObjectType 参数指定了允许用户选择的对象类型（例如：Element、PointOnElement、Edge、Face 等）。
C#
using Autodesk.Revit.DB;
using Autodesk.Revit.UI;
using Autodesk.Revit.UI.Selection;
[Autodesk.Revit.Attributes.Transaction(Autodesk.Revit.Attributes.TransactionMode.Manual)]
public class PickSingleObjectCommand : IExternalCommand
{
public Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements)
{
UIDocument uidoc = commandData.Application.ActiveUIDocument;
Document doc = uidoc.Document;
try
{
// 提示用户选择一个元素
Reference pickedRef = uidoc.Selection.PickObject(ObjectType.Element, "请选择一个元素");
if (pickedRef != null)
{
Element pickedElement = doc.GetElement(pickedRef.ElementId);
TaskDialog.Show("Revit Selection", $"您选择的元素是: ID: {pickedElement.Id}, 名称: {pickedElement.Name}");
}
}
catch (Autodesk.Revit.Exceptions.OperationCanceledException)
{
// 用户取消了选择
TaskDialog.Show("Revit Selection", "操作已取消。");
}
catch (System.Exception ex)
{
message = ex.Message;
return Result.Failed;
}
return Result.Succeeded;
}
}
------------------------------------------------------------------------------------------------------------------------------------------------------------
// 4. 提示用户选择多个对象 (PickObjects)
// PickObjects() 方法与 PickObject() 类似，但允许用户选择多个对象，并通过按下Enter键或右键确认选择。它返回一个 IList<Reference>。
C#
using Autodesk.Revit.DB;
using Autodesk.Revit.UI;
using Autodesk.Revit.UI.Selection;
using System.Collections.Generic;
using System.Linq;
[Autodesk.Revit.Attributes.Transaction(Autodesk.Revit.Attributes.TransactionMode.Manual)]
public class PickMultipleObjectsCommand : IExternalCommand
{
public Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements)
{
UIDocument uidoc = commandData.Application.ActiveUIDocument;
Document doc = uidoc.Document;
try
{
// 提示用户选择多个元素
IList<Reference> pickedRefs = uidoc.Selection.PickObjects(ObjectType.Element, "请选择多个元素 (按Enter或右键完成选择)");
if (pickedRefs != null && pickedRefs.Any())
{
string selectedElementsInfo = $"您选择了 {pickedRefs.Count} 个元素：\n";
foreach (Reference r in pickedRefs)
{
Element pickedElement = doc.GetElement(r.ElementId);
selectedElementsInfo += $"- ID: {pickedElement.Id}, 名称: {pickedElement.Name}\n";
}
TaskDialog.Show("Revit Selection", selectedElementsInfo);
}
else
{
TaskDialog.Show("Revit Selection", "没有选择任何元素。");
}
}
catch (Autodesk.Revit.Exceptions.OperationCanceledException)
{
TaskDialog.Show("Revit Selection", "操作已取消。");
}
catch (System.Exception ex)
{
message = ex.Message;
return Result.Failed;
}
return Result.Succeeded;
}
}
--------------------------------------------------------------------------------------------------------------------------------------------------------
// 5. 提示用户通过矩形框选择元素 (PickElementsByRectangle)
// 此方法允许用户在Revit界面中绘制一个矩形框来选择其中的元素。它直接返回一个 IList<Element>。
C#
using Autodesk.Revit.DB;
using Autodesk.Revit.UI;
using Autodesk.Revit.UI.Selection;
using System.Collections.Generic;
using System.Linq;
[Autodesk.Revit.Attributes.Transaction(Autodesk.Revit.Attributes.TransactionMode.Manual)]
public class PickByRectangleCommand : IExternalCommand
{
public Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements)
{
UIDocument uidoc = commandData.Application.ActiveUIDocument;
Document doc = uidoc.Document;
try
{
// 提示用户通过矩形框选择元素
IList<Element> pickedElements = uidoc.Selection.PickElementsByRectangle("请绘制一个矩形框来选择元素");
if (pickedElements != null && pickedElements.Any())
{
string selectedElementsInfo = $"通过矩形框选择了 {pickedElements.Count} 个元素：\n";
foreach (Element elem in pickedElements)
{
selectedElementsInfo += $"- ID: {elem.Id}, 名称: {elem.Name}\n";
}
TaskDialog.Show("Revit Selection", selectedElementsInfo);
}
else
{
TaskDialog.Show("Revit Selection", "没有选择任何元素。");
}
}
catch (Autodesk.Revit.Exceptions.OperationCanceledException)
{
TaskDialog.Show("Revit Selection", "操作已取消。");
}
catch (System.Exception ex)
{
message = ex.Message;
return Result.Failed;
}
return Result.Succeeded;
}
}
--------------------------------------------------------------------------------------------------------------------------------------------------------
// 6. 提示用户选择一个点 (PickPoint)
// PickPoint() 方法允许用户在Revit视图中拾取一个三维点，返回一个 XYZ 对象。
C#
using Autodesk.Revit.DB;
using Autodesk.Revit.UI;
using Autodesk.Revit.UI.Selection;
[Autodesk.Revit.Attributes.Transaction(Autodesk.Revit.Attributes.TransactionMode.Manual)]
public class PickPointCommand : IExternalCommand
{
public Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements)
{
UIDocument uidoc = commandData.Application.ActiveUIDocument;
try
{
// 提示用户选择一个点
XYZ pickedPoint = uidoc.Selection.PickPoint("请选择一个点");
if (pickedPoint != null)
{
TaskDialog.Show("Revit Selection", $"您选择的点坐标是: X={pickedPoint.X:F2}, Y={pickedPoint.Y:F2}, Z={pickedPoint.Z:F2}");
}
}
catch (Autodesk.Revit.Exceptions.OperationCanceledException)
{
TaskDialog.Show("Revit Selection", "操作已取消。");
}
catch (System.Exception ex)
{
message = ex.Message;
return Result.Failed;
}
return Result.Succeeded;
}
}
--------------------------------------------------------------------------------------------------------------------------------------------------------
// 7. 提示用户选择一个矩形区域 (PickBox)
// PickBox() 方法允许用户在Revit界面中绘制一个矩形框，返回一个 PickedBox 对象，其中包含 Min 和 Max 两个 XYZ 点，定义了矩形框的对角线。
C#
using Autodesk.Revit.DB;
using Autodesk.Revit.UI;
using Autodesk.Revit.UI.Selection;
[Autodesk.Revit.Attributes.Transaction(Autodesk.Revit.Attributes.TransactionMode.Manual)]
public class PickBoxCommand : IExternalCommand
{
public Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements)
{
UIDocument uidoc = commandData.Application.ActiveUIDocument;
try
{
// 提示用户选择一个矩形区域
PickedBox pickedBox = uidoc.Selection.PickBox(PickBoxStyle.Directional, "请选择一个矩形区域");
if (pickedBox != null)
{
XYZ minPoint = pickedBox.Min;
XYZ maxPoint = pickedBox.Max;
TaskDialog.Show("Revit Selection", $"您选择的矩形区域角点是:\nMin: ({minPoint.X:F2}, {minPoint.Y:F2}, {minPoint.Z:F2})\nMax: ({maxPoint.X:F2}, {maxPoint.Y:F2}, {maxPoint.Z:F2})");
}
}
catch (Autodesk.Revit.Exceptions.OperationCanceledException)
{
TaskDialog.Show("Revit Selection", "操作已取消。");
}
catch (System.Exception ex)
{
message = ex.Message;
return Result.Failed;
}
return Result.Succeeded;
}
}
--------------------------------------------------------------------------------------------------------------------------------------------------------
// 8. 使用 ISelectionFilter 进行选择过滤
// ISelectionFilter 接口允许你创建自定义的过滤规则，以限制用户可以选择的元素类型。你需要实现 AllowElement() 和 AllowReference() 方法。
C#
using Autodesk.Revit.DB;
using Autodesk.Revit.UI;
using Autodesk.Revit.UI.Selection;
// 自定义选择过滤器：只允许选择墙
public class WallSelectionFilter : ISelectionFilter
{
public bool AllowElement(Element elem)
{
// 只有当元素是墙时才允许选择
return elem is Wall;
}
public bool AllowReference(Reference refer, XYZ point)
{
// 对于引用（如面、边），允许选择
// 如果你需要更细致的过滤，可以检查refer.ElementId对应的元素类型
return true;
}
}
[Autodesk.Revit.Attributes.Transaction(Autodesk.Revit.Attributes.TransactionMode.Manual)]
public class PickWallCommand : IExternalCommand
{
public Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements)
{
UIDocument uidoc = commandData.Application.ActiveUIDocument;
Document doc = uidoc.Document;
try
{
// 使用自定义过滤器提示用户选择墙
Reference pickedRef = uidoc.Selection.PickObject(ObjectType.Element, new WallSelectionFilter(), "请选择一堵墙");
if (pickedRef != null)
{
Element pickedElement = doc.GetElement(pickedRef.ElementId);
TaskDialog.Show("Revit Selection", $"您选择的墙是: ID: {pickedElement.Id}, 名称: {pickedElement.Name}");
}
}
catch (Autodesk.Revit.Exceptions.OperationCanceledException)
{
TaskDialog.Show("Revit Selection", "操作已取消。");
}
catch (System.Exception ex)
{
message = ex.Message;
return Result.Failed;
}
return Result.Succeeded;
}
}
// 重要提示：
// 事务 (Transaction): 绝大多数Revit API操作都需要在一个事务中进行。然而，Selection 类中的 PickObject、PickObjects 等方法是用户交互性的，它们本身不需要在事务中调用，并且在用户交互期间会暂停事务。但如果你在获取到元素后需要修改它们，那么修改操作必须在事务中进行。上述示例中，IExternalCommand 的 Execute 方法通常已经在事务模式下（通过 [Transaction(TransactionMode.Manual)] 或 [Transaction(TransactionMode.Automatic)]），因此后续的元素操作可以直接进行。
// 异常处理: 当用户取消选择（例如按 Esc 键）时，PickObject 或 PickObjects 等方法会抛出 OperationCanceledException。因此，在使用这些方法时，务必使用 try-catch 块来处理可能的取消操作。
// Reference 与 ElementId： PickObject 和 PickObjects 返回的是 Reference 对象，它包含了选中元素的ID以及其他引用信息（例如面或边的ID）。要获取完整的 Element 对象，你需要使用 Document.GetElement(reference.ElementId)。而 GetElementIds() 返回的是 ElementId 集合，可以直接通过 Document.GetElement(id) 获取 Element。
// UIDocument 与 Document： UIDocument 是Revit用户界面的表示，用于与用户进行交互（例如选择、拾取点）。Document 是Revit模型数据的核心，用于访问和修改元素。Selection 类依赖于 UIDocument。
// 通过这些方法和示例，你应该能够理解 Revit API 中 Selection 类的基本用法，并在你的二次开发项目中灵活应用。
浙公网安备 33010602011771号