BoundingBoxIsInsideFilter

Public Class

A filter used to match elements with a bounding box that is contained by the given Outline.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.ElementFilter
Autodesk.Revit.DB.ElementQuickFilter
Autodesk.Revit.DB.BoundingBoxIsInsideFilter

Namespace: Autodesk.Revit.DB

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class BoundingBoxIsInsideFilter : ElementQuickFilter

The BoundingBoxIsInsideFilter type exposes the following members.

Constructors

Name

Description

---

Public Method
BoundingBoxIsInsideFilter(Outline)

Constructs a new instance of a filter to match elements with a bounding box that is contained by the given Outline.

---

Public Method
BoundingBoxIsInsideFilter(Outline, Boolean)

Constructs a new instance of a filter to match elements with a bounding box is contained by the given Outline, with the option to invert the filter and match all elements with a bounding box that are not contained by the given Outline.

---

Public Method
BoundingBoxIsInsideFilter(Outline, Double)

Constructs a new instance of a filter to match elements with a bounding box that is contained by the given Outline.

---

Public Method
BoundingBoxIsInsideFilter(Outline, Double, Boolean)

Constructs a new instance of a filter to match elements with a bounding box is contained by the given Outline, with the option to invert the filter and match all elements with a bounding box that are not contained by the given Outline.

---

Properties

Name

Description

---

Public Property

Inverted

True if the results of the filter are inverted; elements that would normally be accepted by this filter will be rejected, and elements that would normally be rejected will be accepted.
(Inherited from ElementFilter)

---

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.
(Inherited from ElementFilter)

---

Public Property
Tolerance

Allows control over the match criteria by using a tolerance in the geometry comparison. It is suggested to use this in cases where trivial differences should be considered when matching elements.

---

Methods

Name

Description

---

Public Method

Dispose

(Inherited from ElementFilter)

---

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

---

Public Method

GetBoundingBox

Gets the outline being used for this filter.

---

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

---

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

---

Public Method

PassesFilter(Element)

Applies the filter to a given element.
(Inherited from ElementFilter)

---

Public Method

PassesFilter(Document, ElementId)

Applies the filter to a given element.
(Inherited from ElementFilter)

---

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

---

Remarks

This filter excludes all objects derived from View and objects derived from ElementType. This filter is a quick filter. Quick filters operate only on the ElementRecord, a low-memory class which has a limited interface to read element properties. Elements which are rejected by a quick filter will not be expanded in memory.

Example

// Use BoundingBoxIsInside filter to find elements with a bounding box that is contained(inside completely)
// by the given Outline in the document.

// Create a Outline, use a minimum and maximum XYZ point to initialize the outline.
Outline myOutLn = new Outline(new XYZ(0, 0, 0), new XYZ(100, 100, 100));

// Create a BoundingBoxIsInside filter for Outline
BoundingBoxIsInsideFilter filter = new BoundingBoxIsInsideFilter(myOutLn);

// Apply the filter to the elements in the active document
// This filter excludes all objects derived from View and objects derived from ElementType
FilteredElementCollector collector = new FilteredElementCollector(document);
IList<Element> elements = collector.WherePasses(filter).ToElements();

// Find walls outside BoundingBox: use an inverted filter to match elements
// Use shortcut command OfClass() to find walls only
BoundingBoxIsInsideFilter outsideFilter = new BoundingBoxIsInsideFilter(myOutLn, true); // inverted filter
collector = new FilteredElementCollector(document);
IList<Element> outsideFounds = collector.OfClass(typeof(Wall)).WherePasses(outsideFilter).ToElements();