New module @turf/polygon-tangents
#708
Conversation
| var suite = new Benchmark.Suite('turf-point-on-surface'); | ||
| suite | ||
| .add('turf-point-on-surface',function () { | ||
| centroid(fc); |
There was a problem hiding this comment.
@rowanwins Might want to change this 🤦♂️ to @turf/tangents
| @@ -0,0 +1,12 @@ | |||
| /// <reference types="geojson" /> | |||
|
|
|||
| type Point = GeoJSON.Feature<GeoJSON.Point>; | |||
There was a problem hiding this comment.
Started including Geometry Object as a valid input.
type Point = GeoJSON.Feature<GeoJSON.Point> | GeoJSON.Point;
type Polygon = GeoJSON.Feature<GeoJSON.Polygon> | GeoJSON.Polygon;| * @name polygonTangents | ||
| * @param {Feature<Point>} point to calculate the tangent points from | ||
| * @param {Feature<Polygon>} polygon to get tangents from | ||
| * @returns {FeatureCollection|Feature<Point>} Feature Collection containing the two tangent points |
There was a problem hiding this comment.
Should only return FeatureCollection<Point>
| var rtan = 0; | ||
| var ltan = 0; | ||
|
|
||
| coordEach(polygon, function (currentCoords, currentIndex) { |
There was a problem hiding this comment.
You might need to look into using coordReduce, seems like this is the type of operation you are doing with eprev & enext.
|
|
||
| coordEach(polygon, function (currentCoords, currentIndex) { | ||
| if (currentIndex === 0) { | ||
| eprev = isLeft(polygon.geometry.coordinates[0][0], polygon.geometry.coordinates[0][1], point.geometry.coordinates); |
There was a problem hiding this comment.
Might want to consider using a shorter variable to declare your coordinates instead of always having to use polygon.geometry.coordinates (hard to read).
var polyCoords = getCoords(polygon);
var ptCoords = getCoords(point);Also this normalizes retrieving coordinates from either Feature or Geometry Object.
| return turfFc([turfPoint(polygon.geometry.coordinates[0][rtan]), turfPoint(polygon.geometry.coordinates[0][ltan])]); | ||
| }; | ||
|
|
||
| function isAbove(Point1, Point2, Point3) { |
There was a problem hiding this comment.
Normally capitalized Javascript variables are used for Class objects.
Point1 should be lowercased, we can look into including this as a warning in the ESLinter.
| "tangent", | ||
| "polygon" | ||
| ], | ||
| "author": "Turf Authors", |
There was a problem hiding this comment.
Add yourself in contributors
"contributors": [
"Rowan Winsemius <@rowanwins>"
]
- Added types test `tsc test/types.ts` to execute (if nothing happens, then it passes) - Added MultiPolygon to Types & JSDocs - Updated bench name :)
CC: @rowanwins This one is for you :)
Supporting Geometry ObjectsYou might find ErrorFeature{
"type": "Feature",
"properties": {},
"geometry": {
"type": "Point",
"coordinates": [132, -26]
}
}Geometry{
"type": "Point",
"coordinates": [132, -26]
}Using
|
- Dropped unused slice() methods - Prevent input mutation tests
|
@rowanwins 👍 Looks good to publish now. If you have anymore improvements just send over a new PR or simply push directly to master if they are minor changes (if |
DenisCarriere
changed the title
@turf/polygon-tangents
New Module
@turf/polygon-tangentsInitial commit of a new
@turf/polygonTangentsmodule as per #648The only downside at the moment is that it doesnt handle a multipolygon input as
@turf/meta.coordsEachfunction is a bit limited.coordsEachwill loop through a multipoly but there isn't doesnt provide much useful information in the currentIndex as to what depth you're at etc so I just need to do some refactoring.If there is anything else you notice let me know, otherwise I'll get the multipoly thing sorted and recommit.
Cheers
Rowan