Geo::Space(3pm)

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

NAME

6       Geo::Space - A collection of various  items
7

INHERITANCE

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

SYNOPSIS

13        my $island1 = Geo::Line->filled(...);
14        my $island2 = Geo::Space->new(...);
15        my $islands = Geo::Space->new($island1, $island2)
16

DESCRIPTION

18       Where a Geo::Surface can only contains sets of nested polygons, the
19       Space can contain anything you like: lines, points, and unrelated
20       polygons.
21
22       Extends "DESCRIPTION" in Geo::Shape.
23

METHODS

25       Extends "METHODS" in Geo::Shape.
26
27   Constructors
28       Extends "Constructors" in Geo::Shape.
29
30       $obj->new( [$components], %options )
31       Geo::Space->new( [$components], %options )
32           When called as instance method, some defaults are copied from the
33           object where the call is made upon.  Usually called as class
34           method.
35
36           $components are Math::Polygon, Math::Polygon::Surface, Geo::Point,
37           Geo::Line, Geo::Surface, Geo::Space objects.
38
39            -Option--Defined in--Default
40             proj    Geo::Shape  see Geo::Proj::defaultProjection()
41
42           proj => LABEL
43
44   Attributes
45       Extends "Attributes" in Geo::Shape.
46
47       $obj->component( $index, [$index, ...] )
48           Returns the component (or components) with the specified
49           $index(es). One Geo::Shape object in scalar context, and multiple
50           in list context.
51
52       $obj->components()
53           Returns a list of Geo::Shape objects, all located in this space.
54
55       $obj->lines()
56           Returns a list of Geo::Line objects, which are defined as separate
57           components.
58
59       $obj->nrComponents()
60           Returns the number of components.
61
62       $obj->onlyLines()
63           Returns true when all components are lines; Geo::Line objects.
64
65       $obj->onlyPoints()
66           Returns true when all components are points; Geo::Point objects.
67
68       $obj->onlyRings()
69           Returns true when all components are closed lines; Geo::Line
70           objects each defined as ring.
71
72       $obj->points()
73           Returns a list of Geo::Point objects, which are defined as separate
74           components.
75
76       $obj->proj()
77           Inherited, see "Attributes" in Geo::Shape
78
79       $obj->proj4()
80           Inherited, see "Attributes" in Geo::Shape
81
82   Projections
83       Extends "Projections" in Geo::Shape.
84
85       $obj->in( <$label|'utm'> )
86           Inherited, see "Projections" in Geo::Shape
87
88       $obj->projectOn($nick, @points)
89           Inherited, see "Projections" in Geo::Shape
90
91   Geometry
92       Extends "Geometry" in Geo::Shape.
93
94       $obj->area()
95           Returns the area enclosed by the combined components.  Only useful
96           when the points are in some orthogonal projection.
97
98       $obj->bbox()
99           Inherited, see "Geometry" in Geo::Shape
100
101       $obj->bboxCenter()
102           Inherited, see "Geometry" in Geo::Shape
103
104       $obj->bboxRing( [$xmin, $ymin, $xmax, $ymax, [$proj]] )
105       Geo::Space->bboxRing( [$xmin, $ymin, $xmax, $ymax, [$proj]] )
106           Inherited, see "Geometry" in Geo::Shape
107
108       $obj->distance( $object, [$unit] )
109           Inherited, see "Geometry" in Geo::Shape
110
111       $obj->perimeter()
112           The length of the outer polygons of all components. Only useful in
113           a orthogonal coordinate systems.
114
115   Display
116       Extends "Display" in Geo::Shape.
117
118       $obj->deg2dm($degrees, $pos, $neg)
119       Geo::Space->deg2dm($degrees, $pos, $neg)
120           Inherited, see "Display" in Geo::Shape
121
122       $obj->deg2dms($degrees, $pos, $neg)
123       Geo::Space->deg2dms($degrees, $pos, $neg)
124           Inherited, see "Display" in Geo::Shape
125
126       $obj->dms2deg($dms)
127       Geo::Space->dms2deg($dms)
128           Inherited, see "Display" in Geo::Shape
129
130       $obj->toString( [$projection] )
131           Returns a string representation of the line, which is also used for
132           stringification.
133
134           example:
135

OVERLOAD

137       Extends "OVERLOAD" in Geo::Shape.
138
139       overload: '""' (stringification)
140           Inherited, see "OVERLOAD" in Geo::Shape
141
142       overload: 'bool' (truth value)
143           Inherited, see "OVERLOAD" in Geo::Shape
144

DIAGNOSTICS

146       Error: distance calculation not implemented between a $kind and a $kind
147           Only a subset of all objects can be used in the distance
148           calculation.  The limitation is purely caused by lack of time to
149           implement this.
150
151       Error: in() not implemented for a $class
152

LICENSE

158       Copyrights 2005-2019 by [Mark Overmeer]. For other contributors see
159       ChangeLog.
160
161       This program is free software; you can redistribute it and/or modify it
162       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
163
164
165
166perl v5.30.0                      2019-07-26                     Geo::Space(3)