Éric Lemoine
feba61af25
Add @api stable annotations for ol.geom.SimpleGeometry
2014-08-21 10:56:49 +02:00
Éric Lemoine
e9eb22bc47
Add @api stable annotations for ol.geom.Polygon
2014-08-21 10:56:49 +02:00
Éric Lemoine
b865958efb
Add @api stable annotations for ol.geom.Point
2014-08-21 10:56:49 +02:00
Éric Lemoine
2c5464aa76
Add @api stable annotations for ol.geom.MultiPolygon
2014-08-21 10:56:49 +02:00
Éric Lemoine
6ecd31fe62
Add @api stable annotations for ol.geom.MultiPoint
2014-08-21 10:56:49 +02:00
Éric Lemoine
ce7fda71af
Add @api stable annotations for ol.geom.MultiLineString
2014-08-21 10:56:49 +02:00
Éric Lemoine
180c6aa7a9
Add @api stable annotations for ol.geom.LineString
2014-08-21 10:56:49 +02:00
Éric Lemoine
516be9041e
Add @api stable annotations for ol.geom.LinearRing
2014-08-21 10:56:49 +02:00
Éric Lemoine
5ccb0fae07
Add @api stable annotations for ol.geom.GeometryCollection
2014-08-21 10:56:49 +02:00
Éric Lemoine
9b0ce7b80c
Add @api stable annotations for ol.geom.Geometry
2014-08-21 10:56:49 +02:00
Peter Robins
d3683fcab9
Correct wrong docs for LinearRing
2014-08-05 11:08:44 +00:00
Peter Robins
652fcede22
Document LinearRing as abstract class
2014-08-04 10:05:01 +00:00
Peter Robins
c86569684e
Document that geom.getArea/Length on projected plane
2014-08-04 08:02:01 +00:00
Éric Lemoine
9c70a49fb0
Add ol.geom.flat.geodesic
...
Inspired by #1884 by @twpayne.
2014-07-24 17:59:56 +02:00
Erik Timmers
fe8a72dce5
Allow for empty Point & GeometryCollection
2014-07-15 13:20:58 +02:00
Éric Lemoine
31fa59c996
Merge pull request #2329 from tsauerwein/multipolygon-empty-array
...
Also accept empty array for ol.geom.MultiPolygon
2014-07-10 18:35:43 +02:00
tsauerwein
7c22d8ffd4
Also accept empty array for ol.geom.MultiPolygon
2014-07-10 17:18:24 +02:00
Éric Lemoine
d57a35ffcb
Fix stride related bug in Canvas immediate API
2014-07-10 14:21:56 +02:00
Paul Spencer
8d991bd638
Add @todo API and describe ol.geom.Geometry funcs
...
The `clone()`, `getSimplifiedGeometry()` and `getType()` methods are all
base class methods documented in subclasses. They should appear in
ol.geom.Geometry in the API docs as well.
2014-07-07 08:29:56 -04:00
Tim Schaub
4cf5ab4620
Use @api annotation instead of @todo api
2014-07-05 15:41:14 -04:00
Andreas Hocevar
efc3e3244a
Merge pull request #2254 from elemoine/replaygroup
...
Use replay groups for feature overlays
2014-06-27 12:59:06 +02:00
Andreas Hocevar
cf13cb5e32
Fix remaining API doc issues with squared tolerance vs. tolerance
2014-06-27 12:20:16 +02:00
Andreas Hocevar
f67767aaf0
Add ol.renderer.vector.getSquaredTolerance and ol.SIMPLIFY_TOLERANCE
2014-06-27 12:10:46 +02:00
Peter Robins
ff3e66d550
Improve docs for projection/transform functions
2014-06-23 06:16:35 -04:00
Peter Robins
75be215497
Add standard docs text to abstract base classes
2014-06-14 07:20:33 -04:00
Paul Spencer
50b63b4a30
Merge pull request #2179 from pagameba/remove-getsimplifiedgeometry
...
Remove getSimplifiedGeometry from ol.geom.Circle
2014-06-09 16:10:02 -04:00
Paul Spencer
c1ddc92cc8
Fix typo in comment
2014-06-09 15:17:14 -04:00
Paul Spencer
7d8dbbc7cc
Remove getSimplifiedGeometry from ol.geom.Circle
...
The `getSimplifiedGeometry` method is unnecessary as
`ol.geom.SimpleGeometry`'s default implementation is to do the
same thing (return `this`).
2014-06-09 14:37:39 -04:00
Peter Robins
41d9f0360a
Add @classdesc to classes
2014-06-09 12:10:19 -04:00
Frédéric Junod
9e7bfda9f7
Merge pull request #2096 from fredj/unused-require
...
Remove unused goog.require
2014-05-21 17:36:29 +02:00
Tim Schaub
9341e98374
Merge pull request #2093 from bjornharrtell/fix_opt_dest2
...
Assign to provided array instead of pushing when getting a linestring midpoint.
2014-05-21 09:28:06 -06:00
Frederic Junod
2f918ea2a4
Remove unused goog.require
2014-05-21 16:06:32 +02:00
Björn Harrtell
ce40a142fa
opt_dest should be assigned to not pushed
2014-05-21 12:02:26 +02:00
Andreas Hocevar
d163f60e34
Make sure that opt_layout is listed as optional
2014-05-15 20:29:16 +02:00
Andreas Hocevar
b2805c58de
Better document which events are fired
...
The map does not fire ol.render.Event#render. Change events are
now only listed for classes that fire them, and a description
about when they are fired is added.
2014-05-15 20:28:09 +02:00
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