RhinoCompute.Intersection

RhinoCompute.Intersection.curvePlane(curve, plane, tolerance, multiple=false)

Intersects a curve with an (infinite) plane.

Arguments:
  • curve (rhino3dm.Curve) – Curve to intersect.
  • plane (rhino3dm.Plane) – Plane to intersect with.
  • tolerance (float) – Tolerance to use during intersection.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

A list of intersection events or None if no intersections were recorded.

Return type:

CurveIntersections

RhinoCompute.Intersection.meshPlane(mesh, plane, multiple=false)

Intersects a mesh with an (infinite) plane.

Arguments:
  • mesh (rhino3dm.Mesh) – Mesh to intersect.
  • plane (rhino3dm.Plane) – Plane to intersect with.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

An array of polylines describing the intersection loops or None (Nothing in Visual Basic) if no intersections could be found.

Return type:

rhino3dm.Polyline[]

RhinoCompute.Intersection.meshPlane1(mesh, planes, multiple=false)

Intersects a mesh with a collection of (infinite) planes.

Arguments:
  • mesh (rhino3dm.Mesh) – Mesh to intersect.
  • planes (list[rhino3dm.Plane]) – Planes to intersect with.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

An array of polylines describing the intersection loops or None (Nothing in Visual Basic) if no intersections could be found.

Return type:

rhino3dm.Polyline[]

RhinoCompute.Intersection.brepPlane(brep, plane, tolerance, multiple=false)

Intersects a Brep with an (infinite) plane.

Arguments:
  • brep (rhino3dm.Brep) – Brep to intersect.
  • plane (rhino3dm.Plane) – Plane to intersect with.
  • tolerance (float) – Tolerance to use for intersections.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

True on success, False on failure.

Return type:

bool

RhinoCompute.Intersection.curveSelf(curve, tolerance, multiple=false)

Finds the places where a curve intersects itself.

Arguments:
  • curve (rhino3dm.Curve) – Curve for self-intersections.
  • tolerance (float) – Intersection tolerance. If the curve approaches itself to within tolerance, an intersection is assumed.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

A collection of intersection events.

Return type:

CurveIntersections

RhinoCompute.Intersection.curveCurve(curveA, curveB, tolerance, overlapTolerance, multiple=false)

Finds the intersections between two curves.

Arguments:
  • curveA (rhino3dm.Curve) – First curve for intersection.
  • curveB (rhino3dm.Curve) – Second curve for intersection.
  • tolerance (float) – Intersection tolerance. If the curves approach each other to within tolerance, an intersection is assumed.
  • overlapTolerance (float) – The tolerance with which the curves are tested.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

A collection of intersection events.

Return type:

CurveIntersections

RhinoCompute.Intersection.curveCurveValidate(curveA, curveB, tolerance, overlapTolerance, multiple=false)

Finds the intersections between two curves.

Arguments:
  • curveA (rhino3dm.Curve) – First curve for intersection.
  • curveB (rhino3dm.Curve) – Second curve for intersection.
  • tolerance (float) – Intersection tolerance. If the curves approach each other to within tolerance, an intersection is assumed.
  • overlapTolerance (float) – The tolerance with which the curves are tested.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

A collection of intersection events.

Return type:

CurveIntersections

RhinoCompute.Intersection.curveLine(curve, line, tolerance, overlapTolerance, multiple=false)

Intersects a curve and an infinite line.

Arguments:
  • curve (rhino3dm.Curve) – Curve for intersection.
  • line (Line) – Infinite line to intersect.
  • tolerance (float) – Intersection tolerance. If the curves approach each other to within tolerance, an intersection is assumed.
  • overlapTolerance (float) – The tolerance with which the curves are tested.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

A collection of intersection events.

Return type:

CurveIntersections

RhinoCompute.Intersection.curveSurface(curve, surface, tolerance, overlapTolerance, multiple=false)

Intersects a curve and a surface.

Arguments:
  • curve (rhino3dm.Curve) – Curve for intersection.
  • surface (rhino3dm.Surface) – Surface for intersection.
  • tolerance (float) – Intersection tolerance. If the curve approaches the surface to within tolerance, an intersection is assumed.
  • overlapTolerance (float) – The tolerance with which the curves are tested.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

A collection of intersection events.

Return type:

CurveIntersections

RhinoCompute.Intersection.curveSurfaceValidate(curve, surface, tolerance, overlapTolerance, multiple=false)

Intersects a curve and a surface.

Arguments:
  • curve (rhino3dm.Curve) – Curve for intersection.
  • surface (rhino3dm.Surface) – Surface for intersection.
  • tolerance (float) – Intersection tolerance. If the curve approaches the surface to within tolerance, an intersection is assumed.
  • overlapTolerance (float) – The tolerance with which the curves are tested.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

A collection of intersection events.

Return type:

CurveIntersections

RhinoCompute.Intersection.curveSurface1(curve, curveDomain, surface, tolerance, overlapTolerance, multiple=false)

Intersects a sub-curve and a surface.

Arguments:
  • curve (rhino3dm.Curve) – Curve for intersection.
  • curveDomain (rhino3dm.Interval) – Domain of sub-curve to take into consideration for Intersections.
  • surface (rhino3dm.Surface) – Surface for intersection.
  • tolerance (float) – Intersection tolerance. If the curve approaches the surface to within tolerance, an intersection is assumed.
  • overlapTolerance (float) – The tolerance with which the curves are tested.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

A collection of intersection events.

Return type:

CurveIntersections

RhinoCompute.Intersection.curveSurfaceValidate1(curve, curveDomain, surface, tolerance, overlapTolerance, multiple=false)

Intersects a sub-curve and a surface.

Arguments:
  • curve (rhino3dm.Curve) – Curve for intersection.
  • curveDomain (rhino3dm.Interval) – Domain of sub-curve to take into consideration for Intersections.
  • surface (rhino3dm.Surface) – Surface for intersection.
  • tolerance (float) – Intersection tolerance. If the curve approaches the surface to within tolerance, an intersection is assumed.
  • overlapTolerance (float) – The tolerance with which the curves are tested.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

A collection of intersection events.

Return type:

CurveIntersections

RhinoCompute.Intersection.curveBrep(curve, brep, tolerance, multiple=false)

Intersects a curve with a Brep. This function returns the 3D points of intersection and 3D overlap curves. If an error occurs while processing overlap curves, this function will return false, but it will still provide partial results.

Arguments:
  • curve (rhino3dm.Curve) – Curve for intersection.
  • brep (rhino3dm.Brep) – Brep for intersection.
  • tolerance (float) – Fitting and near miss tolerance.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

True on success, False on failure.

Return type:

bool

RhinoCompute.Intersection.curveBrep1(curve, brep, tolerance, angleTolerance, multiple=false)

Intersect a curve with a Brep. This function returns the intersection parameters on the curve.

Arguments:
  • curve (rhino3dm.Curve) – Curve.
  • brep (rhino3dm.Brep) – Brep.
  • tolerance (float) – Absolute tolerance for intersections.
  • angleTolerance (float) – Angle tolerance in radians.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

True on success, False on failure.

Return type:

bool

RhinoCompute.Intersection.curveBrepFace(curve, face, tolerance, multiple=false)

Intersects a curve with a Brep face.

Arguments:
  • curve (rhino3dm.Curve) – A curve.
  • face (rhino3dm.BrepFace) – A brep face.
  • tolerance (float) – Fitting and near miss tolerance.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

True on success, False on failure.

Return type:

bool

RhinoCompute.Intersection.surfaceSurface(surfaceA, surfaceB, tolerance, multiple=false)

Intersects two Surfaces.

Arguments:
  • surfaceA (rhino3dm.Surface) – First Surface for intersection.
  • surfaceB (rhino3dm.Surface) – Second Surface for intersection.
  • tolerance (float) – Intersection tolerance.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

True on success, False on failure.

Return type:

bool

RhinoCompute.Intersection.brepBrep(brepA, brepB, tolerance, multiple=false)

Intersects two Breps.

Arguments:
  • brepA (rhino3dm.Brep) – First Brep for intersection.
  • brepB (rhino3dm.Brep) – Second Brep for intersection.
  • tolerance (float) – Intersection tolerance.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

True on success; False on failure.

Return type:

bool

RhinoCompute.Intersection.brepSurface(brep, surface, tolerance, multiple=false)

Intersects a Brep and a Surface.

Arguments:
  • brep (rhino3dm.Brep) – A brep to be intersected.
  • surface (rhino3dm.Surface) – A surface to be intersected.
  • tolerance (float) – A tolerance value.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

True on success; False on failure.

Return type:

bool

RhinoCompute.Intersection.meshMeshFast(meshA, meshB, multiple=false)

This is an old overload kept for compatibility. Overlaps and near misses are ignored.

Arguments:
  • meshA (rhino3dm.Mesh) – First mesh for intersection.
  • meshB (rhino3dm.Mesh) – Second mesh for intersection.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

An array of intersection line segments, or None if no intersections were found.

Return type:

Line[]

RhinoCompute.Intersection.meshMeshAccurate(meshA, meshB, tolerance, multiple=false)

Intersects two meshes. Overlaps and near misses are handled. This is an old method kept for compatibility.

Arguments:
  • meshA (rhino3dm.Mesh) – First mesh for intersection.
  • meshB (rhino3dm.Mesh) – Second mesh for intersection.
  • tolerance (float) – A tolerance value. If negative, the positive value will be used. WARNING! Good tolerance values are in the magnitude of 10^-7, or RhinoMath.SqrtEpsilon*10.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

An array of intersection and overlaps polylines.

Return type:

rhino3dm.Polyline[]

RhinoCompute.Intersection.meshRay(mesh, ray, multiple=false)

Finds the first intersection of a ray with a mesh.

Arguments:
  • mesh (rhino3dm.Mesh) – A mesh to intersect.
  • ray (Ray3d) – A ray to be casted.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

>= 0.0 parameter along ray if successful. < 0.0 if no intersection found.

Return type:

float

RhinoCompute.Intersection.meshRay1(mesh, ray, multiple=false)

Finds the first intersection of a ray with a mesh.

Arguments:
  • mesh (rhino3dm.Mesh) – A mesh to intersect.
  • ray (Ray3d) – A ray to be casted.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

>= 0.0 parameter along ray if successful. < 0.0 if no intersection found.

Return type:

float

RhinoCompute.Intersection.meshPolyline(mesh, curve, multiple=false)

Finds the intersection of a mesh and a polyline. Points are not guaranteed to be sorted along the polyline.

Arguments:
  • mesh (rhino3dm.Mesh) – A mesh to intersect.
  • curve (PolylineCurve) – A polyline curves to intersect.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

An array of points: one for each face that was passed by the faceIds out reference.

Return type:

rhino3dm.Point3d[]

RhinoCompute.Intersection.meshPolylineSorted(mesh, curve, multiple=false)

Finds the intersection of a mesh and a polyline. Points are guaranteed to be sorted along the polyline.

Arguments:
  • mesh (rhino3dm.Mesh) – A mesh to intersect.
  • curve (PolylineCurve) – A polyline curves to intersect.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

An array of points: one for each face that was passed by the faceIds out reference.

Return type:

rhino3dm.Point3d[]

RhinoCompute.Intersection.meshLine(mesh, line, multiple=false)

Finds the intersections of a mesh and a line. The points are not necessarily sorted.

Arguments:
  • mesh (rhino3dm.Mesh) – A mesh to intersect
  • line (Line) – The line to intersect with the mesh
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

An array of points: one for each face that was passed by the faceIds out reference.

Return type:

rhino3dm.Point3d[]

RhinoCompute.Intersection.meshLineSorted(mesh, line, multiple=false)

Finds the intersections of a mesh and a line. Points are sorted along the line.

Arguments:
  • mesh (rhino3dm.Mesh) – A mesh to intersect
  • line (Line) – The line to intersect with the mesh
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

An array of points: one for each face that was passed by the faceIds out reference.

Return type:

rhino3dm.Point3d[]

RhinoCompute.Intersection.rayShoot(ray, geometry, maxReflections, multiple=false)

Computes point intersections that occur when shooting a ray to a collection of surfaces and Breps.

Arguments:
  • ray (Ray3d) – A ray used in intersection.
  • geometry (list[rhino3dm.GeometryBase]) – Only Surface and Brep objects are currently supported. Trims are ignored on Breps.
  • maxReflections (int) – The maximum number of reflections. This value should be any value between 1 and 1000, inclusive.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

An array of points: one for each surface or Brep face that was hit, or an empty array on failure.

Return type:

rhino3dm.Point3d[]

RhinoCompute.Intersection.rayShoot1(geometry, ray, maxReflections, multiple=false)

Computes point intersections that occur when shooting a ray to a collection of surfaces and Breps.

Arguments:
  • geometry (list[rhino3dm.GeometryBase]) – The collection of surfaces and Breps to intersect. Trims are ignored on Breps.
  • ray (Ray3d) – >A ray used in intersection.
  • maxReflections (int) – The maximum number of reflections. This value should be any value between 1 and 1000, inclusive.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

An array of RayShootEvent structs if successful, or an empty array on failure.

Return type:

RayShootEvent[]

RhinoCompute.Intersection.projectPointsToMeshes(meshes, points, direction, tolerance, multiple=false)

Projects points onto meshes.

Arguments:
  • meshes (list[rhino3dm.Mesh]) – the meshes to project on to.
  • points (list[rhino3dm.Point3d]) – the points to project.
  • direction (rhino3dm.Vector3d) – the direction to project.
  • tolerance (float) – Projection tolerances used for culling close points and for line-mesh intersection.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

Array of projected points, or None in case of any error or invalid input.

Return type:

rhino3dm.Point3d[]

RhinoCompute.Intersection.projectPointsToMeshesEx(meshes, points, direction, tolerance, multiple=false)

Projects points onto meshes.

Arguments:
  • meshes (list[rhino3dm.Mesh]) – the meshes to project on to.
  • points (list[rhino3dm.Point3d]) – the points to project.
  • direction (rhino3dm.Vector3d) – the direction to project.
  • tolerance (float) – Projection tolerances used for culling close points and for line-mesh intersection.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

Array of projected points, or None in case of any error or invalid input.

Return type:

rhino3dm.Point3d[]

RhinoCompute.Intersection.projectPointsToBreps(breps, points, direction, tolerance, multiple=false)

Projects points onto breps.

Arguments:
  • breps (list[rhino3dm.Brep]) – The breps projection targets.
  • points (list[rhino3dm.Point3d]) – The points to project.
  • direction (rhino3dm.Vector3d) – The direction to project.
  • tolerance (float) – The tolerance used for intersections.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

Array of projected points, or None in case of any error or invalid input.

Return type:

rhino3dm.Point3d[]

RhinoCompute.Intersection.projectPointsToBrepsEx(breps, points, direction, tolerance, multiple=false)

Projects points onto breps.

Arguments:
  • breps (list[rhino3dm.Brep]) – The breps projection targets.
  • points (list[rhino3dm.Point3d]) – The points to project.
  • direction (rhino3dm.Vector3d) – The direction to project.
  • tolerance (float) – The tolerance used for intersections.
  • multiple (bool) – (default False) If True, all parameters are expected as lists of equal length and input will be batch processed
Returns:

Array of projected points, or None in case of any error or invalid input.

Return type:

rhino3dm.Point3d[]