Geo::Surface(3pm)

1Geo::Surface(3)       User Contributed Perl Documentation      Geo::Surface(3)
2
3
4

NAME

6       Geo::Surface - A surface description.
7

INHERITANCE

9        Geo::Surface
10          is a Geo::Shape
11

SYNOPSIS

13        my $island = Geo::Surface->new($outer, $lake1, $lake2);
14

DESCRIPTION

16       In this context, a "surface" is defined as a single filled area with
17       possible enclosures in one projection system.
18
19       Extends "DESCRIPTION" in Geo::Shape.
20

METHODS

22       Extends "METHODS" in Geo::Shape.
23
24   Constructors
25       Extends "Constructors" in Geo::Shape.
26
27       $obj->new( <$surface | <$outer,$inner,...> >, %options )
28       Geo::Surface->new( <$surface | <$outer,$inner,...> >, %options )
29           When called as instance method, some defaults are copied from the
30           object where the call is made upon.
31
32           You may either provide a Math::Polygon::Surface $surface, or a LIST
33           of lines.  In the latter case, the first line is the $outer polygon
34           of the surface, and the other are all $inner enclosures: lakes.
35           Lines are and Geo::Line, Math::Polygon objects, or ARRAY of points.
36
37           If no projection is specified, then the projection of the first
38           Geo-encoded line will be used.
39
40            -Option--Defined in--Default
41             proj    Geo::Shape  see Geo::Proj::defaultProjection()
42
43           proj => LABEL
44
45   Attributes
46       Extends "Attributes" in Geo::Shape.
47
48       $obj->geoInner()
49           Returns a LIST of enclosed polygons, converted to Geo::Line
50           objects.
51
52       $obj->geoOuter()
53           Returns the outer polygon as Geo::Line object.
54
55       $obj->inner()
56           Returns a LIST of enclosed Math::Polygon objects.
57
58       $obj->outer()
59           Returns the outer Math::Polygon.
60
61       $obj->proj()
62           Inherited, see "Attributes" in Geo::Shape
63
64       $obj->proj4()
65           Inherited, see "Attributes" in Geo::Shape
66
67   Projections
68       Extends "Projections" in Geo::Shape.
69
70       $obj->in( <$label|'utm'> )
71           Inherited, see "Projections" in Geo::Shape
72
73       $obj->projectOn($nick, @points)
74           Inherited, see "Projections" in Geo::Shape
75
76   Geometry
77       Extends "Geometry" in Geo::Shape.
78
79       $obj->area()
80           Returns the area enclosed by the outer polygon, minus the erea of
81           the enclosures.  Only useful when the points are in some orthogonal
82           projection.
83
84       $obj->bbox()
85           The bounding box of outer surface polygon.
86
87       $obj->bboxCenter()
88           Inherited, see "Geometry" in Geo::Shape
89
90       $obj->bboxRing( [$xmin, $ymin, $xmax, $ymax, [$proj]] )
91       Geo::Surface->bboxRing( [$xmin, $ymin, $xmax, $ymax, [$proj]] )
92           Inherited, see "Geometry" in Geo::Shape
93
94       $obj->distance( $object, [$unit] )
95           Inherited, see "Geometry" in Geo::Shape
96
97       $obj->perimeter()
98           The length of the outer polygon. Only useful in a orthogonal
99           coordinate systems.
100
101   Display
102       Extends "Display" in Geo::Shape.
103
104       $obj->deg2dm($degrees, $pos, $neg)
105       Geo::Surface->deg2dm($degrees, $pos, $neg)
106           Inherited, see "Display" in Geo::Shape
107
108       $obj->deg2dms($degrees, $pos, $neg)
109       Geo::Surface->deg2dms($degrees, $pos, $neg)
110           Inherited, see "Display" in Geo::Shape
111
112       $obj->dms2deg($dms)
113       Geo::Surface->dms2deg($dms)
114           Inherited, see "Display" in Geo::Shape
115
116       $obj->toString( [$projection] )
117           Returns a string representation of the line, which is also used for
118           stringification.
119

OVERLOAD

121       Extends "OVERLOAD" in Geo::Shape.
122
123       overload: '""' (stringification)
124           Inherited, see "OVERLOAD" in Geo::Shape
125
126       overload: 'bool' (truth value)
127           Inherited, see "OVERLOAD" in Geo::Shape
128

DIAGNOSTICS

130       Warning: Geo::Line is should be filled
131           When Geo::Line objects are used to compose a surface, each of them
132           must be filled.  Representation of rivers and such do not belong in
133           a surface description.
134
135       Error: distance calculation not implemented between a $kind and a $kind
136           Only a subset of all objects can be used in the distance
137           calculation.  The limitation is purely caused by lack of time to
138           implement this.
139
140       Error: in() not implemented for a $class
141       Error: not known what to do with $component
142

LICENSE

148       Copyrights 2005-2019 by [Mark Overmeer]. For other contributors see
149       ChangeLog.
150
151       This program is free software; you can redistribute it and/or modify it
152       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
153
154
155
156perl v5.30.0                      2019-07-26                   Geo::Surface(3)