Calculates where the line intersects other geometry and returns the parameters for these points of intersection.
This function can be accessed directly through Line.intersection.
The line to intersect.
The geometry that intersects the line.
The parameters along theLine where the intersections occur. Use Line.pointAt to get actual points.
Calculates which portion of a line is inside a bounding box. Returns the parameter of the interval inside.
The line to intersect.
The bounding box that intersects the line.
The portion of the line within the box. Use Line.pointAt to get actual points. Note that the two ends of the interval aren't always points of intersection – for example, a line could be completely inside a box without touching the sides, in which case the interval would be the full length of the line (0 to 1) but neither 0 nor 1 would be a point of intersection.
True if the line intersects the box.
Calculates the points of intersection between a line and a circle.
The number of times the line intersects the circle.
The parameters along the line where the intersections occur. Use Line.pointAt to get the actual points.
Calculates the point of intersection between two lines.
The first line.
The second line.
If true, an intersection only counts if it falls within the bounds of the lines. If false, the lines are treated as infinite.
True if the two lines intersect.
The parameter along lineA where the intersection occurs. Use Line.pointAt to get the actual point.
The parameter along lineB where the intersection occurs. Use Line.pointAt to get the actual point.
Calculates where the polyline intersects other geometry and returns the parameters for these points of intersection.
This function can be accessed directly through Polyline.intersection.
The polyline to intersect.
The geometry that intersects the polyline.
The parameters along thePolyline where the intersections occur. Use Polyline.pointAt to get actual points.
Calculates where the ray intersects other geometry and returns the parameters for these points of intersection.
This function can be accessed directly through Ray.intersection.
The ray to intersect.
The geometry that intersects the ray.
The extent of the ray. Specifies whether the ray is shooting both forward and backward, or only forward.
The parameters along theRay where the intersections occur. Use Ray.pointAt to get actual points.
Calculates which portion of a ray is inside a bounding box. Returns the parameters of the interval inside.
The ray to intersects.
The bounding box that intersects the ray.
The extent of the ray. Specifies whether the ray is shooting both forward and backward, or only forward.
The portion of the ray within the box. Use Ray.pointAt to get actual points. Note that if you've limited the ray's range to only shoot forward, one value in the interval could be the ray's start rather than the point of intersection.
True if the ray intersects the box.
Calculates the points of intersection between a ray and a circle.
The ray to intersect.
The circle that intersects the ray.
The extent of the ray. Specifies whether the ray is shooting both forward and backward, or only forward.
The number of times the ray intersects the circle.
The parameters along the ray where the intersections occur. Use Ray.pointAt to get the actual points.
Calculates the point of intersection between a ray and a line.
The ray that intersects the line.
The line that intersects the ray.
The extent of the ray. Specifies whether the ray is shooting both forward and backward, or only forward.
True if the ray and line intersect.
The parameter along line where the intersection occurs. Use Line.pointAt to get the actual point.
The parameter along ray where the intersection occurs. Use Ray.pointAt to get the actual point.
Calculates the point of intersection between two rays.
The first ray.
The second ray.
The extent of the ray. Specifies whether the ray is shooting both forward and backward, or only forward.
True if the two rays intersect.
The parameter along rayA where the intersection occurs. Use Ray.pointAt to get the actual point.
The parameter along rayB where the intersection occurs. Use Ray.pointAt to get the actual point.
Generated using TypeDoc
The intersection module contains a set of helper functions to calculate where various geometry intersect.
For the most part, if you want to get the point of intersection between a line and any other type of geometry, you can call this directly (Line.intersection) without using any of this module's functions. The same is true for rays (Ray.intersection) and polylines (Polyline.intersection).
This module is helpful if you need more detailed information about particular intersections. For example, the Intersection.lineLine function calculates where two lines intersect and returns where the intersection occurs relative to each line.