Namespace: Autodesk.Revit.DB

BoundingBoxIsInsideFilter

Class

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

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.

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.ElementFilter
    Autodesk.Revit.DB.ElementQuickFilter
      Autodesk.Revit.DB.BoundingBoxIsInsideFilter

Syntax

public class BoundingBoxIsInsideFilter : ElementQuickFilter

Public Class BoundingBoxIsInsideFilter
	Inherits ElementQuickFilter

public ref class BoundingBoxIsInsideFilter : public ElementQuickFilter

type BoundingBoxIsInsideFilter = 
    class
        inherit ElementQuickFilter
    end

Examples

// 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();

' 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. 
Dim myOutLn As New Outline(New XYZ(0, 0, 0), New XYZ(100, 100, 100))

' Create a BoundingBoxIsInside filter for Outline
Dim filter As 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
Dim collector As New FilteredElementCollector(document)
Dim elements As IList(Of Element) = collector.WherePasses(filter).ToElements()


' Find walls outside BoundingBox: use an inverted filter to match elements
' Use shortcut command OfClass() to find walls only
Dim outsideFilter As New BoundingBoxIsInsideFilter(myOutLn, True)
' inverted filter
collector = New FilteredElementCollector(document)
Dim outsideFounds As IList(Of Element) = collector.OfClass(GetType(Wall)).WherePasses(outsideFilter).ToElements()

BoundingBoxIsInsideFilter Class Members:

Name	Description	Inherited From
BoundingBoxIsInsideFilter(Outline)	Constructs a new instance of a filter to match elements with a bounding box that is contained by the given Outline.
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.
BoundingBoxIsInsideFilter(Outline, Double)	Constructs a new instance of a filter to match elements with a bounding box that is contained by the given Outline.
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.

Name	Description	Inherited From
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 )	ElementFilter
IsValidObject	Specifies whether the .NET object represents a valid Revit entity. (Inherited from ElementFilter )	ElementFilter
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.

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