Andreas Hocevar
be73885e37
Merge pull request #2043 from ahocevar/nicer-api-docs
...
Nicer API docs
2014-05-07 09:20:22 -05:00
Andreas Hocevar
e6dbb61d68
Document raw geometry types
2014-05-06 12:45:53 -05:00
Tim Schaub
0b8f1e8944
Mark applyTransform as part of the API for all geometries
2014-05-02 13:24:04 -06:00
Tim Schaub
e448f100fd
Add a transform method to geometries
...
This accepts CRS identifiers for source and destination, transforms the geometry in place, and returns a reference to the geometry.
2014-05-02 11:47:59 -06:00
Tim Schaub
1110da37e1
Move ol.Sphere#circle to ol.geom.Polygon.circular
...
Previously, ol.geom.Polygon was a transitive dependency of ol.proj (since ol.proj requires ol.sphere.NORMAL, and all spheres were capable of generating circular polygons). Instead, ol.proj should be lower-level. Since it deals only with coordinate arrays, it shouldn't depend on all of the geometry code.
By adding a static `circular` function to `ol.geom.Polygon`, the dependency tree makes more sense. If you want to create a polygon that approximates a circle on a sphere, you require `ol.geom.Polygon` and `ol.Sphere` (or one of the constants).
This makes room for geometries to have a `transform` method that takes projection-like arguments (meaning that `ol.geom.Geometry` will require `ol.proj`).
2014-05-02 11:25:44 -06:00
Tim Schaub
4f9968d106
Rename transform to applyTransform for geometries
2014-05-02 09:27:53 -06:00
Andreas Hocevar
fbdbbfb7a7
Get rid of stability annotations and document stability with api
...
This change adds a stability value to the api annotation, with
'experimental' as default value.
enum, typedef and event annotations are never exportable, but
api annotations are needed there to make them appear in the
docs.
Nested typedefs are no longer inlined recursively, because the
resulting tables get too wide with the current template.
2014-04-29 09:53:07 -06:00
Andreas Hocevar
c17ac0cae3
Greatly simplify and document the usage of JSDoc
...
This commit simplifies the exports.js plugin so it only relies
on the stability notes to generate the documentation, which
completely decouples it from the exportable API.
As a rule of thumb, whenever something has an 'api' annotation,
it should also have a 'stability' annotation. A more verbose
documentation of ol3 specific annotation usage is available in
the new 'apidoc/readme.md' file.
This commit also modifies all source files to implement these
usage suggestions.
2014-04-29 09:53:06 -06:00
Tim Schaub
fb497f5288
Annotations for exports
2014-04-29 09:53:05 -06:00
Tom Payne
b613c9cde7
Merge pull request #1859 from pgiraud/geolocation_tracking_orientation
...
Geolocation tracking with orientation example
2014-03-24 12:53:53 +01:00
Pierre GIRAUD
8e9ffb377e
Geolocation tracking with orientation example
2014-03-24 12:26:17 +01:00
Tom Payne
dbc4f4e621
Use ol.array.safeExtend in ol.geom.Polygon
2014-03-24 11:56:53 +01:00
Tom Payne
c1d37195f5
Use ol.array.safeExtend in ol.geom.MultiPolygon
2014-03-24 11:56:53 +01:00
Tom Payne
b9a6048791
Use ol.array.safeExtend in ol.geom.MultiPoint
2014-03-24 11:56:53 +01:00
Tom Payne
765985c5a9
Use ol.array.safeExtend in ol.geom.MultiLineString
2014-03-24 11:56:53 +01:00
Tom Payne
de2ee2451e
Use ol.array.safeExtend in ol.geom.LineString
2014-03-24 11:56:53 +01:00
Tom Payne
78c8d976eb
Remove empty ol.geom.flat
2014-03-12 13:26:14 +01:00
Tom Payne
48af6ecd1c
Factor out ol.geom.flat.center
2014-03-12 13:26:14 +01:00
Tom Payne
ca44c6328c
Factor out ol.geom.flat.transform
2014-03-12 13:26:14 +01:00
Tom Payne
6a00c14841
Move squaredDistance and squaredSegmentDistance into ol.math
2014-03-12 13:26:14 +01:00
Tom Payne
65dcc38fad
Factor out ol.geom.flat.reverse
2014-03-12 13:26:14 +01:00
Tom Payne
3541a01aab
Factor out ol.geom.flat.inflate
2014-03-12 13:26:14 +01:00
Tom Payne
9ca996725e
Factor out ol.geom.flat.flip
2014-03-12 13:26:14 +01:00
Tom Payne
266c43dc78
Factor out ol.geom.flat.deflate
2014-03-12 13:26:14 +01:00
Tom Payne
d525b43d06
Factor out ol.geom.flat.contains and interiorpoint
2014-03-12 13:26:14 +01:00
Tom Payne
1363ce3a58
Factor out ol.geom.flat.orient
2014-03-12 13:26:14 +01:00
Tom Payne
becd1318bd
Factor out ol.geom.flat.area
2014-03-12 13:26:13 +01:00
Tom Payne
20ee1dc992
Factor out ol.geom.flat.length
2014-03-12 13:26:13 +01:00
Tom Payne
522fda1688
Factor out ol.geom.flat.interpolate
2014-03-12 13:26:13 +01:00
Tom Payne
c8165a8168
Factor out ol.geom.flat.simplify
2014-03-12 13:26:13 +01:00
Tom Payne
2b6845244c
Factor out ol.geom.flat.closest
2014-03-12 13:26:13 +01:00
Tom Payne
b565092d62
Use goog.math.lerp in ol.geom.flat.lineStringCoordinateAtM
2014-03-12 13:26:13 +01:00
Tom Payne
76779c175f
Use goog.math.lerp in ol.geom.flat.lineStringInterpolate
2014-03-12 13:26:13 +01:00
Tom Payne
b77f0e7d3a
Add ol.geom.MultiPolygon#appendPolygon
2014-03-10 16:53:20 +01:00
Tom Payne
c8bbeca06e
Add ol.geom.MultiPolygon#getPolygon
2014-03-10 16:53:20 +01:00
Tom Payne
719384ad14
Tidy up ol.geom.MultiPolygon#getPolygons
2014-03-10 16:53:20 +01:00
Tom Payne
7a51b4c7b6
Add ol.geom.MultiLineString#appendLineString
2014-03-10 16:53:20 +01:00
Tom Payne
7ee4fb8a2e
Add ol.geom.MultiLineString#getLineString
2014-03-10 16:53:20 +01:00
Tom Payne
669f21ca29
Construct individual line strings directly from flat coordinates
2014-03-10 16:53:20 +01:00
Tom Payne
ddfce24f05
Add ol.geom.MultiPoint#getPoint
2014-03-10 16:53:20 +01:00
Tom Payne
361d31b596
Construct individual points directly from flat coordinates
2014-03-10 16:53:19 +01:00
Tom Payne
033e2e7dd8
Add ol.geom.MultiPoint#appendPoint
2014-03-10 16:53:19 +01:00
Tom Payne
c2d4ffaba1
Add ol.geom.Polygon#getLinearRing
2014-03-10 16:53:19 +01:00
Tom Payne
03911e6c6b
Add ol.geom.Polygon#appendLinearRing
2014-03-10 16:53:19 +01:00
Tom Payne
94cfb3205a
Add ol.geom.LineString#appendCoordinate
2014-03-10 16:53:19 +01:00
Tom Payne
470790b811
Check arguments passed to ol.geom.MultiPolygon#setFlatCoordinates
2014-03-10 16:53:19 +01:00
Tom Payne
ee5a9d6a4e
Check arguments passed to ol.geom.MultiLineString#setFlatCoordinates
2014-03-10 16:53:19 +01:00
Tom Payne
23dc855c2f
Check arguments passed to ol.geom.Polygon#setFlatCoordinates
2014-03-10 16:53:19 +01:00
Tom Payne
f32d491d45
Fix calculation of ends in ol.geom.MultiPolygon#getPolygons
2014-03-07 19:49:38 +01:00
Tom Payne
8125b4a847
Add ol.geom.MultiLineString#getCoordinateAtM
2014-03-02 12:14:52 +01:00