com.mapbox.services.api.utils.turf.models

Class LineIntersectsResult

java.lang.Object

com.mapbox.services.api.utils.turf.models.LineIntersectsResult

public 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

Constructor Summary

Constructors

Constructor and Description
LineIntersectsResult() Public constructor

Method Summary

Modifier and Type	Method and Description
java.lang.Double	getX() If the lines intersect, use this method to get the intersecting points X value
java.lang.Double	getY() If the lines intersect, use this method to get the intersecting points Y value
boolean	isOnLine1() Determine if the intersecting point lands on line 1 or not.
boolean	isOnLine2() Determine if the intersecting point lands on line 2 or not.
void	setOnLine1(boolean onLine1) Set whether the intersecting point should land on line 1.
void	setOnLine2(boolean onLine2) Set whether the intersecting point should land on line 2.
void	setX(java.lang.Double x) Set the points X value where the two lines should intersect.
void	setY(java.lang.Double y) Set the points Y value where the two lines should intersect.

Methods inherited from class java.lang.Object

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

Constructor Detail

LineIntersectsResult

public LineIntersectsResult()

Public constructor

Since:

1.2.0

Method Detail

getX

public java.lang.Double getX()

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

Returns:

The X value where the lines intersect.

Since:

1.2.0

setX

public void setX(java.lang.Double x)

Set the points X value where the two lines should intersect.

Parameters:

x - Double value representing the intersecting X coordinate.

Since:

1.2.0

getY

public java.lang.Double getY()

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

Returns:

The Y value where the lines intersect.

Since:

1.2.0

setY

public void setY(java.lang.Double y)

Set the points Y value where the two lines should intersect.

Parameters:

y - Double value representing the intersecting Y coordinate.

Since:

1.2.0

isOnLine1

public boolean isOnLine1()

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

setOnLine1

public void setOnLine1(boolean onLine1)

Set whether the intersecting point should land on line 1.

Parameters:

onLine1 - True if you want the intersecting point to lie on line 1, otherwise pass in false.

Since:

1.2.0

isOnLine2

public boolean isOnLine2()

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

setOnLine2

public void setOnLine2(boolean onLine2)

Set whether the intersecting point should land on line 2.

Parameters:

onLine2 - True if you want the intersecting point to lie on line 2, otherwise pass in false.

Since:

1.2.0