ConvexLineIntersection Enumeration Reference


                    
                    
                    contained

Represents the case where the line’s boundaries are completely contained within the bounds of the convex shape.

Declaration

Swift

case contained


                    
                    
                    singlePoint(_:)

Represents the case where the line crosses the bounds of the convex shape on a single vertex, or tangentially, in case of spheroids.

Declaration

Swift

case singlePoint(LineIntersectionPointNormal<Vector>)


                    
                    
                    enter(_:)

Represents cases where the line starts outside the shape and crosses in before ending within the shape’s bounds.

Declaration

Swift

case enter(LineIntersectionPointNormal<Vector>)


                    
                    
                    exit(_:)

Represents cases where the line starts within the convex shape and intersects the boundaries on the way out.

Declaration

Swift

case exit(LineIntersectionPointNormal<Vector>)


                    
                    
                    enterExit(_:_:)

Represents cases where the line crosses the convex shape twice: Once on the way in, and once again on the way out.

Declaration

Swift

case enterExit(LineIntersectionPointNormal<Vector>, LineIntersectionPointNormal<Vector>)


                    
                    
                    noIntersection

Represents the case where no intersection occurs at any point.

Declaration

Swift

case noIntersection


                    
                    
                    lineIntersectionPointNormals

Returns the list of line intersection point normals referenced by this intersection instance.

Declaration

Swift

public var lineIntersectionPointNormals: [LineIntersectionPointNormal<Vector>] { get }


                    
                    
                    pointNormals

Returns the list of point normals referenced by this intersection instance.

Declaration

Swift

public var pointNormals: [PointNormal<Vector>] { get }


                    
                    
                    mappingPointNormals(_:)

Returns a new ConvexLineIntersection where any LineIntersectionPointNormal value is mapped by a provided closure before being stored back into the same enum case and returned.

Declaration

Swift

public func mappingPointNormals(
    _ mapper: (LineIntersectionPointNormal<Vector>, LineIntersectionPointNormalKind) -> LineIntersectionPointNormal<Vector>
) -> ConvexLineIntersection<Vector>


                    
                    
                    replacingPointNormals(_:)

Returns a new ConvexLineIntersection where any LineIntersectionPointNormal value is replaced by a provided closure before being stored back into the same enum case and returned.

Declaration

Swift

public func replacingPointNormals<NewVector: VectorType>(
    _ mapper: (LineIntersectionPointNormal<Vector>, LineIntersectionPointNormalKind) -> LineIntersectionPointNormal<NewVector>
) -> ConvexLineIntersection<NewVector>


                    
                    
                    LineIntersectionPointNormalKind

Parameter passed along point normals in mappingPointNormals(_:) and replacingPointNormals(_:) to specify to the closure which kind of point normal was provided.

Declaration

Swift

public enum LineIntersectionPointNormalKind