Revit 2020 API |
Face..::..Intersect Method (Face, Curve%) |
Face Class See Also |
Calculates the intersection of the specified face with this face and returns the intersection results.
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 20.0.0.0 (20.0.0.377)
Syntax
C# |
---|
public FaceIntersectionFaceResult Intersect( Face face, out Curve result ) |
Visual Basic |
---|
Public Function Intersect ( _ face As Face, _ <OutAttribute> ByRef result As Curve _ ) As FaceIntersectionFaceResult |
Visual C++ |
---|
public: FaceIntersectionFaceResult Intersect( Face^ face, [OutAttribute] Curve^% result ) |
Parameters
- face
- Type: Autodesk.Revit.DB..::..Face
The specified face to intersect with this face.
- result
- Type: Autodesk.Revit.DB..::..Curve%
A single Curve representing the intersection.
Return Value
- FaceIntersectionFaceResult.Intersecting - One or more intersections were encountered.
- SetComparisonResult.NonIntersecting - There is no intersection found.
Remarks
This is not a general-purpose function: it only works properly for simple configurations.
For other configurations, it may return an incorrect result.
Some configurations for which the function might return a correct result are:
- A planar face that fully intersects another face in a single curve, when the other face is planar or cylindrical.
- A cylindrical face that fully intersects another face in a single curve, when the other face is planar.
Exceptions
Exception | Condition |
---|---|
Autodesk.Revit.Exceptions..::..ArgumentNullException | The face is nullNothingnullptra null reference (Nothing in Visual Basic). |
Autodesk.Revit.Exceptions..::..InvalidOperationException | The intersection calculation fails. |