Commit Graph

95 Commits

Author SHA1 Message Date
Frederic Junod
f7943b9401 Set extent and extentRevision variables to private 2015-01-14 11:01:18 +01:00
Frederic Junod
8bd0a1232a Add geom.ol.geom.Geometry#computeExtent function 2015-01-14 11:01:18 +01:00
Éric Lemoine
14ea2bf413 Add ol.geom.Geometry#translate 2014-12-18 18:42:36 +01:00
Éric Lemoine
a740f32e4d Add ol.geom.Geometry#intersectsExtent (abstract method) 2014-09-17 12:17:32 +02:00
Guillaume Beraudo
d67cefdf3a Consistent circle transform
Depending on compilation flags, applying a transform used to either:
- work;
- fail throwing an abstract method not implemented message;
- fail silently.

Now it should consistently work, like the other geometries.

Adding a polygon factory method creating an approximation of a circle on
a plane would be useful for users wanting the circle to be deformed.
It would be similar to the `circular` function which creates an
approximation of a circle on a sphere.
2014-09-16 13:41:17 +02:00
Frederic Junod
6e3354ab7b Indicates that ol.geom.Geometry#clone never return null 2014-08-25 16:44:52 +02:00
Éric Lemoine
4764cbc908 Remove the ol.geom.RawMultiPolygon type 2014-08-21 10:56:50 +02:00
Éric Lemoine
95d7598227 Remove the ol.geom.RawMultiLineString type 2014-08-21 10:56:50 +02:00
Éric Lemoine
d17993794d Remove the ol.geom.RawMultiPoint type 2014-08-21 10:56:50 +02:00
Éric Lemoine
47c1f1908e Remove the ol.geom.RawPolygon type 2014-08-21 10:56:50 +02:00
Éric Lemoine
838415218f Remove the ol.geom.RawLinearRing type 2014-08-21 10:56:50 +02:00
Éric Lemoine
fb1c764a38 Remove the ol.geom.RawLineString type 2014-08-21 10:56:50 +02:00
Éric Lemoine
72bcb2db80 Remove the ol.geom.RawPoint type 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
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
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
c1ddc92cc8 Fix typo in comment 2014-06-09 15:17:14 -04:00
Peter Robins
41d9f0360a Add @classdesc to classes 2014-06-09 12:10:19 -04: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
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
08ec3480ed Add stability annotation to ol.geom.Geometry 2014-02-03 14:45:00 +01:00
Tom Payne
edcb38232f Use inherited dispatchChangeEvent and getRevision in ol.geom.Geometry 2014-01-21 11:43:13 +01:00
Tom Payne
3647f13e2e Add ol.geom.Circle 2014-01-14 12:31:50 +01:00
oterral
235af49f0b Add goog.provide('ol.geom.GeometryType') 2014-01-10 14:00:30 +01:00
Tom Payne
d7eb4db69e Add ol.geom.GeometryCollection 2013-12-11 16:49:47 +01:00
Tom Payne
6295fa6088 Add ol.geom.Geometry#clone 2013-12-11 16:49:47 +01:00
Tom Payne
76a6e08ec1 Factor out ol.geom.SimpleGeometry 2013-12-11 16:49:47 +01:00
Tom Payne
f4fe0046b2 Check closest point against extent 2013-12-09 16:40:55 +01:00
Tom Payne
35c20bea79 Add ol.geom.Geometry#getClosestPoint 2013-12-09 16:40:53 +01:00
Tom Payne
b374d5c5b8 Avoid simplifying geometries when it will have no effect 2013-12-09 16:37:33 +01:00
Tom Payne
9612182f70 Add ol.geom.Geometry#getSimplifiedGeometry 2013-12-09 16:37:32 +01:00
Tom Payne
554e17ac22 Set geometry to null if no geometry given 2013-12-07 19:51:54 +01:00
Tom Payne
1ae13f152d Fire change event when an ol.geom.Geometry is transformed 2013-12-06 21:12:32 +01:00
Tom Payne
6c5f1fbcce Make ol.geom.Geometry inherit from ol.Observable 2013-12-06 16:30:00 +01:00
Tom Payne
057cda42be Rename ol.geom.Type to ol.geom.GeometryType 2013-12-04 16:28:36 +01:00
Tom Payne
c2228b1d19 Rename ol.geom.Layout to ol.geom.GeometryLayout 2013-12-04 16:27:03 +01:00
Tom Payne
1a9d19a2fb Allow geometries to have null coordinates and add setFlatCoordinates 2013-12-03 19:58:34 +01:00
Tom Payne
27982ec5e7 Factor out ol.geom.Geometry.getStrideForLayout_ 2013-12-03 15:44:44 +01:00
Tom Payne
0477101c28 Factor out ol.geom.Geometry.getLayoutForStride_ 2013-12-03 15:44:25 +01:00
Tom Payne
b2a93dcda7 Add ol.geom.LinearRing 2013-12-01 21:06:11 +01:00
Tom Payne
f93ae0392a Improve type checking in ol.geom 2013-11-20 11:45:23 +01:00