BoundingBoxContainsPointFilter Class

A filter used to match elements with a bounding box that contains the given point.

Inheritance Hierarchy

SystemObject
  Autodesk.Revit.DBElementFilter
    Autodesk.Revit.DBElementQuickFilter
      Autodesk.Revit.DBBoundingBoxContainsPointFilter

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

C++

Copy

public class BoundingBoxContainsPointFilter : ElementQuickFilter

Public Class BoundingBoxContainsPointFilter
	Inherits ElementQuickFilter

public ref class BoundingBoxContainsPointFilter : public ElementQuickFilter

type BoundingBoxContainsPointFilter = 
    class
        inherit ElementQuickFilter
    end

The BoundingBoxContainsPointFilter type exposes the following members.

Constructors

	Name	Description
	BoundingBoxContainsPointFilter(XYZ)	Constructs a new instance of a filter to match elements with a bounding box that contains the given point.
	BoundingBoxContainsPointFilter(XYZ, Boolean)	Constructs a new instance of a filter to match elements with a bounding box that contains the given point, with the option to invert the filter and match all elements with a bounding box that do not contain the given point.
	BoundingBoxContainsPointFilter(XYZ, Double)	Constructs a new instance of a filter to match elements with a bounding box that contains the given point, while specifying the tolerance to be used in deciding if the point matches the criteria.
	BoundingBoxContainsPointFilter(XYZ, Double, Boolean)	Constructs a new instance of a filter to match elements with a bounding box that contains the given point, while specifying the tolerance to be used in deciding if the point matches the criteria. This constructor includes the option to invert the filter and match all elements with a bounding box that do not contain the given point.

Top

Properties

	Name	Description
	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)
	IsValidObject	Specifies whether the .NET object represents a valid Revit entity. (Inherited from ElementFilter)
	Point	The XYZ point to use when matching element bounding boxes.
	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.

Top

Methods

	Name	Description
	Dispose	(Inherited from ElementFilter)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	PassesFilter(Element)	Applies the filter to a given element. (Inherited from ElementFilter)
	PassesFilter(Document, ElementId)	Applies the filter to a given element. (Inherited from ElementFilter)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

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

C++

Copy

// Use BoundingBoxContainsPoint filter to find elements with a bounding box that contains the 
// given point in the document.

// Create a BoundingBoxContainsPoint filter for base point of (0, 0, 0)
XYZ basePnt = new XYZ(0, 0, 0);
BoundingBoxContainsPointFilter filter = new BoundingBoxContainsPointFilter(basePnt);

// Apply the filter to the elements in the active document
// This filter will 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 that do not contain the given point: use an inverted filter to match elements
// Use shortcut command OfClass() to find walls only
BoundingBoxContainsPointFilter notContainFilter =
    new BoundingBoxContainsPointFilter(basePnt, true); // inverted filter
collector = new FilteredElementCollector(document);
IList<Element> notContainFounds =
    collector.OfClass(typeof(Wall)).WherePasses(notContainFilter).ToElements();

' Use BoundingBoxContainsPoint filter to find elements with a bounding box that contains the 
' given point in the document.

' Create a BoundingBoxContainsPoint filter for base point of (0, 0, 0)
Dim basePnt As New XYZ(0, 0, 0)
Dim filter As New BoundingBoxContainsPointFilter(basePnt)

' Apply the filter to the elements in the active document
' This filter will excludes all objects derived from View and objects derived from ElementType
Dim collector As New FilteredElementCollector(document)
Dim elements As IList(Of Element) = collector.WherePasses(filter).ToElements()


' Find walls that do not contain the given point: use an inverted filter to match elements
' Use shortcut command OfClass() to find walls only
Dim notContainFilter As New BoundingBoxContainsPointFilter(basePnt, True)
' inverted filter
collector = New FilteredElementCollector(document)
Dim notContainFounds As IList(Of Element) = collector.OfClass(GetType(Wall)).WherePasses(notContainFilter).ToElements()

Reference

Autodesk.Revit.DB Namespace