com.mapbox.turf.models

Class LineIntersectsResult.Builder

java.lang.Object

com.mapbox.turf.models.LineIntersectsResult.Builder

Enclosing class:

LineIntersectsResult

public static class LineIntersectsResult.Builder
extends java.lang.Object

Build a new LineIntersectsResult instance and define its features by passing in information through the offered methods.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
LineIntersectsResult	build() Builds a new instance of a LineIntersectsResult class.
LineIntersectsResult.Builder	horizontalIntersection(java.lang.Double horizontalIntersection) If the lines intersect, use this method to get the intersecting point X value.
LineIntersectsResult.Builder	onLine1(boolean onLine1) Determine if the intersecting point lands on line 1 or not.
LineIntersectsResult.Builder	onLine2(boolean onLine2) Determine if the intersecting point lands on line 2 or not.
LineIntersectsResult.Builder	verticalIntersection(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

Method Detail

horizontalIntersection

public LineIntersectsResult.Builder horizontalIntersection(@Nullable
                                                           java.lang.Double horizontalIntersection)

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

Parameters:

horizontalIntersection - the x coordinates intersection point

Returns:

the X value where the lines intersect

Since:

3.0.0

verticalIntersection

public LineIntersectsResult.Builder verticalIntersection(@Nullable
                                                         java.lang.Double verticalIntersection)

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

Parameters:

verticalIntersection - the y coordinates intersection point

Returns:

the Y value where the lines intersect

Since:

3.0.0

onLine1

public LineIntersectsResult.Builder onLine1(boolean onLine1)

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

Parameters:

onLine1 - true if the points land on line one, else false

Returns:

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

Since:

3.0.0

onLine2

public LineIntersectsResult.Builder onLine2(boolean onLine2)

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

Parameters:

onLine2 - true if the points land on line two, else false

Returns:

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

Since:

3.0.0

build

public LineIntersectsResult build()

Builds a new instance of a LineIntersectsResult class.

Returns:

a new instance of LineIntersectsResult

Since:

3.0.0