com.mapbox.turf.models

Class LineIntersectsResult

java.lang.Object

com.mapbox.turf.models.LineIntersectsResult

public abstract class LineIntersectsResult
extends java.lang.Object

if the lines intersect, the result contains the x and y of the intersection (treating the lines as infinite) and booleans for whether line segment 1 or line segment 2 contain the point.

Since:

1.2.0

See Also:

Good example of how this class works written in JavaScript

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LineIntersectsResult.Builder Build a new LineIntersectsResult instance and define its features by passing in information through the offered methods.

Constructor Summary

Constructors

Constructor and Description
LineIntersectsResult()

Method Summary

Modifier and Type	Method and Description
static LineIntersectsResult.Builder	builder() Builds a new instance of a lineIntersection.
abstract java.lang.Double	horizontalIntersection() If the lines intersect, use this method to get the intersecting point X value.
abstract boolean	onLine1() Determine if the intersecting point lands on line 1 or not.
abstract boolean	onLine2() Determine if the intersecting point lands on line 2 or not.
abstract LineIntersectsResult.Builder	toBuilder() Convert current instance values into another Builder to quickly change one or more values.
abstract java.lang.Double	verticalIntersection() If the lines intersect, use this method to get the intersecting point Y value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LineIntersectsResult

public LineIntersectsResult()

Method Detail

builder

public static LineIntersectsResult.Builder builder()

Builds a new instance of a lineIntersection. This class is mainly used internally for other turf objects to recall memory when performing calculations.

Returns:

LineIntersectsResult.Builder for creating a new instance

Since:

3.0.0

horizontalIntersection

@Nullable
public abstract java.lang.Double horizontalIntersection()

If the lines intersect, use this method to get the intersecting point X value.

Returns:

the X value where the lines intersect

Since:

1.2.0

verticalIntersection

@Nullable
public abstract java.lang.Double verticalIntersection()

If the lines intersect, use this method to get the intersecting point Y value.

Returns:

the Y value where the lines intersect

Since:

1.2.0

onLine1

public abstract boolean onLine1()

Determine if the intersecting point lands on line 1 or not.

Returns:

true if the intersecting point is located on line 1, otherwise false

Since:

1.2.0

onLine2

public abstract boolean onLine2()

Determine if the intersecting point lands on line 2 or not.

Returns:

true if the intersecting point is located on line 2, otherwise false

Since:

1.2.0

toBuilder

public abstract LineIntersectsResult.Builder toBuilder()

Convert current instance values into another Builder to quickly change one or more values.

Returns:

a new instance of LineIntersectsResult using the newly defined values

Since:

3.0.0