PrepareForCell Method


Informs the filter that a series of points within a given cell is about to be checked.

Namespace: Autodesk.Revit.DB.PointClouds
Assembly: RevitAPI (in RevitAPI.dll) Version: 22.0.0.0 (22.1.0.0)
Since: 2012

Syntax

C#
public void PrepareForCell(
	XYZ min,
	XYZ max,
	int numTests
)
Visual Basic
Public Sub PrepareForCell ( _
	min As XYZ, _
	max As XYZ, _
	numTests As Integer _
)
Visual C++
public:
void PrepareForCell(
	XYZ^ min, 
	XYZ^ max, 
	int numTests
)

Parameters

min
Type: Autodesk.Revit.DB XYZ
The lower corner of the cell.
max
Type: Autodesk.Revit.DB XYZ
The upper corner of the cell.
numTests
Type: System Int32
The engine's estimate of the number of TestPoint() calls it is going to make for this cell.

Remarks

This is a performance hook that the filter can use to minimize computational work per TestPoint() call within a given cell. The engine should guarantee that all points passed to TestPoint() calls will fall inside the (min, max) box specified here. This promise must be in effect until the next PrepareForCell() call.

Exceptions

Exception Condition
Autodesk.Revit.Exceptions ArgumentNullException A non-optional argument was null

See Also