Skip to content

Commit 94b0351

Browse files
authored
linear -> planar
1 parent 737340f commit 94b0351

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

GeometryOpsCore/src/types.jl

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ and that are usable in more than just GeometryOps.
1212
A manifold is mathematically defined as a topological space that resembles Euclidean space locally.
1313
1414
In GeometryOps (and geodesy more generally), there are three manifolds we care about:
15-
- [`Linear`](@ref): the 2d plane, a completely Euclidean manifold
15+
- [`Planar`](@ref): the 2d plane, a completely Euclidean manifold
1616
- [`Spherical`](@ref): the unit sphere, but one where areas are multiplied by the radius of the Earth. This is not Euclidean globally, but all map projections attempt to represent the sphere on the Euclidean 2D plane to varying degrees of success.
1717
- [`Geodesic`](@ref): the ellipsoid, the closest we can come to representing the Earth by a simple geometric shape. Parametrized by `semimajor_axis` and `inv_flattening`.
1818
1919
Generally, we aim to have `Linear` and `Spherical` be operable everywhere, whereas `Geodesic` will only apply in specific circumstances.
2020
Currently, those circumstances are `area` and `segmentize`, but this could be extended with time and https://github.com/JuliaGeo/SphericalGeodesics.jl.
2121
=#
2222

23-
export Linear, Spherical, Geodesic
23+
export Planar, Spherical, Geodesic
2424
export TraitTarget
2525
export BoolsAsTypes, _True, _False, _booltype
2626

@@ -31,17 +31,19 @@ A manifold is mathematically defined as a topological space that resembles Eucli
3131
3232
We use the manifold definition to define the space in which an operation should be performed, or where a geometry lies.
3333
34-
Currently we have [`Linear`](@ref), [`Spherical`](@ref), and [`Geodesic`](@ref) manifolds.
34+
Currently we have [`Planar`](@ref), [`Spherical`](@ref), and [`Geodesic`](@ref) manifolds.
3535
"""
3636
abstract type Manifold end
3737

3838
"""
39-
Linear()
39+
Planar()
4040
41-
A linear manifold means that the space is completely Euclidean,
42-
and planar geometry suffices.
41+
A planar manifold refers to the 2D Euclidean plane.
42+
43+
Z coordinates may be accepted but will not influence geometry calculations, which
44+
are done purely on 2D geometry. This is the standard "2.5D" model used by e.g. GEOS.
4345
"""
44-
struct Linear <: Manifold
46+
struct Planar <: Manifold
4547
end
4648

4749
"""

0 commit comments

Comments
 (0)