Skip to content

Refactor turf measurement functions #1139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kmadsen merged 2 commits into from
May 1, 2020
Merged

Refactor turf measurement functions #1139

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7230568
Refactor turf measurement functions
May 1, 2020
6c935bf
javadoc
May 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions services-turf/src/main/java/com/mapbox/turf/TurfMeasurement.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,16 @@ public static double length(@NonNull MultiPolygon multiPolygon,
return len;
}

private static double length(List<Point> coords, String units) {
/**
* Takes a {@link List} of {@link Point} and measures its length in the specified units.
*
* @param coords geometry to measure
* @param units one of the units found inside {@link TurfConstants.TurfUnitCriteria}
* @return length of the input line in the units specified
* @see <a href="http://turfjs.org/docs/#linedistance">Turf Line Distance documentation</a>
* @since 5.2.0
*/
public static double length(List<Point> coords, String units) {
double travelled = 0;
Point prevCoords = coords.get(0);
Point curCoords;
Expand Down Expand Up @@ -253,7 +262,21 @@ public static Point midpoint(@NonNull Point from, @NonNull Point to) {
*/
public static Point along(@NonNull LineString line, @FloatRange(from = 0) double distance,
@NonNull @TurfConstants.TurfUnitCriteria String units) {
List<Point> coords = line.coordinates();
return along(line.coordinates(), distance, units);
}

/**
* Takes a list of points and returns a point at a specified distance along the line.
*
* @param coords that the point should be placed upon
* @param distance along the linestring geometry which the point should be placed on
* @param units one of the units found inside {@link TurfConstants.TurfUnitCriteria}
* @return a {@link Point} which is on the linestring provided and at the distance from
* the origin of that line to the end of the distance
* @since 5.2.0
*/
public static Point along(@NonNull List<Point> coords, @FloatRange(from = 0) double distance,
@NonNull @TurfConstants.TurfUnitCriteria String units) {

double travelled = 0;
for (int i = 0; i < coords.size(); i++) {
Expand Down