view release on metacpan or  search on metacpan

lib/Geo/Space.pod  view on Meta::CPAN

=encoding utf8

=head1 NAME

Geo::Space - A collection of various  items

=head1 INHERITANCE

 Geo::Space
   is a Geo::Shape

=head1 SYNOPSIS

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

=head1 DESCRIPTION

Where a L<Geo::Surface|Geo::Surface> can only contains sets of nested polygons, the
Space can contain anything you like: lines, points, and unrelated polygons.

Extends L<"DESCRIPTION" in Geo::Shape|Geo::Shape/"DESCRIPTION">.
 
=head1 METHODS

Extends L<"METHODS" in Geo::Shape|Geo::Shape/"METHODS">.
 
=head2 Constructors

Extends L<"Constructors" in Geo::Shape|Geo::Shape/"Constructors">.
 
=over 4

=item $obj-E<gt>B<new>( [$components], %options )

=item Geo::Space-E<gt>B<new>( [$components], %options )

When called as instance method, some defaults are copied from the
object where the call is made upon.  Usually called as class method.

$components are L<Math::Polygon|Math::Polygon>, L<Math::Polygon::Surface|Math::Polygon::Surface>,
L<Geo::Point|Geo::Point>, L<Geo::Line|Geo::Line>, L<Geo::Surface|Geo::Surface>, L<Geo::Space|Geo::Space> objects.

 -Option--Defined in--Default
  proj    Geo::Shape  see Geo::Proj::defaultProjection()

=over 2

=item proj => LABEL

=back

=back

=head2 Attributes

Extends L<"Attributes" in Geo::Shape|Geo::Shape/"Attributes">.
 
=over 4

=item $obj-E<gt>B<component>( $index, [$index, ...] )

Returns the component (or components) with the specified $index(es). One
L<Geo::Shape|Geo::Shape> object in scalar context, and multiple in list context.

=item $obj-E<gt>B<components>()

Returns a list of L<Geo::Shape|Geo::Shape> objects, all located in this space.

=item $obj-E<gt>B<lines>()

Returns a list of L<Geo::Line|Geo::Line> objects, which are defined as separate
components.

=item $obj-E<gt>B<nrComponents>()

Returns the number of components.

=item $obj-E<gt>B<onlyLines>()

Returns true when all components are lines; L<Geo::Line|Geo::Line> objects.

=item $obj-E<gt>B<onlyPoints>()

Returns true when all components are points; L<Geo::Point|Geo::Point> objects.

=item $obj-E<gt>B<onlyRings>()

Returns true when all components are closed lines; L<Geo::Line|Geo::Line> objects
each defined as ring.

=item $obj-E<gt>B<points>()

Returns a list of L<Geo::Point|Geo::Point> objects, which are defined as separate
components.

=item $obj-E<gt>B<proj>()

Inherited, see L<Geo::Shape/"Attributes">

=item $obj-E<gt>B<proj4>()