File Coverage

blib/lib/Geo/OSM/Render/Renderer/SVG.pm

Criterion	Covered	Total	%
statement	62	62	100.0
branch	7	12	58.3
condition	4	8	50.0
subroutine	11	11	100.0
pod	5	5	100.0
total	89	98	90.8

# Encoding and name #_{

=encoding utf8
=head1 NAME

Geo::OSM::Render::Renderer::SVG - Specialization of base class L for rendering SVG.

=cut
package Geo::OSM::Render::Renderer::SVG;
#_}
#_{ use …
use warnings;
use strict;

use utf8;
use Carp;

use SVG;
use Geo::OSM::Render::Renderer;

#_}
our $VERSION = 0.01;
our @ISA = qw(Geo::OSM::Render::Renderer);
#_{ Synopsis

=head1 SYNOPSIS


=cut
#_}
#_{ Overview

=head1 OVERVIEW

…

=cut

#_}
#_{ Methods
#_{ POD
=head1 METHODS
=cut
#_}
sub new { #_{
#_{ POD

=head2 new

    my $proj = Geo::OSM::Render::Projection::CH_LV03->new();
    my $vp   = Geo::OSM::Render::Viewport::Clipped->new(…);

    my $osm_renderer_svg = Geo::OSM::Render::Renderer->new(
      $svg_filename,
      $proj,
      $vp
    );

    …

    $osm_renderer_svg->end();

=cut

#_}

  my $class = shift;
  my $svg_filename     = shift;

  my $self = $class->SUPER::new(@_);

  croak "Wrong class $class" unless $self->isa('Geo::OSM::Render::Renderer');


# while (@_) {
#   if ($_[0] -> isa('Geo::OSM::Render::Viewport::Clipped')) {
#     $self->{viewport} = shift;
#     next;
#   }
#   if ($_[0] -> isa('Geo::OSM::Render::Projection')) {
#     $self->{projection} = shift;
#     next;
#   }
#   last;
# }

  croak 'Viewport must be Geo::OSM::Render::Viewport::Clipped' unless $self->{viewport   } -> isa('Geo::OSM::Render::Viewport::Clipped');
  croak 'Projection not defined'                               unless $self->{projection};

  open ($self->{svg_fh}, '>', $svg_filename) or croak "Could not open $svg_filename";

  $self->{svg} = SVG->new(
    width  => $self->{viewport}->map_width (),
    height => $self->{viewport}->map_height()
  ) or croak "Could not start svg";

  return $self;

} #_}
sub end { #_{
#_{ POD

=head2 end

When finished rendering, this method writes the SVG.

=cut
#_}
  my $self = shift;
  my $svg_text = $self->{svg}->xmlify();
  print {$self->{svg_fh}} $svg_text;
  close $self->{svg_fh};

} #_}
sub render_node { #_{
#_{ POD

=head2 render_node

    $osm_renderer_svg -> render_node(
      $node,
      r => $radius,
      styles=> { … }
    );

Renders a L<< node|Geo::OSM::Primitive::Node >>.

See also L.

=cut
#_}

  my $self      = shift;
  my $node      = shift;

  my %opts      = @_;

  $self->SUPER::render_node($node);

  my $r      = delete $opts{radius} // 1;
  my $styles = delete $opts{styles} // {};

  my ($x_map, $y_map) = $self->node_to_map_coordinates($node);

  $self->{svg}->circle(
      cx => $x_map,
      cy => $y_map,
      r  => $r,
      style=>$styles
  );

} #_}
sub render_way { #_{
#_{ POD

=head2 render_way

    $osm_renderer_svg -> render_way(
      styles=> { … }
    );

Renders a L<< way|Geo::OSM::Primitive::Way >>.

See also L<< Geo::OSM::Render::Renderer/render_way >>.

=cut
#_}

  my $self      = shift;
  my $way       = shift;

  my %opts      = @_;

  my $styles = delete $opts{styles} // {};

  $self->SUPER::render_way($way);

  my @nodes  = $way->nodes();
  my $points = '';
  for my $node (@nodes) {
    my ($x_map, $y_map) = $self->node_to_map_coordinates($node);
    $points .= ' ' if $points;
    $points .= "$x_map,$y_map";
  }

  $self->{svg}->polyline(
    points => $points,
    style  => $styles
  );

} #_}
sub line {
#_{ POD

=head2 line

    $osm_renderer_svg -> line(
      $lat_start, $lon_start,
      $lat_end  , $lon_end,
      styles=> { … }
    );

Draws a line on the SVG map.


See also L<< Geo::OSM::Render::Renderer/render_way >>.

=cut

   my $self      = shift;
   my $lat_start = shift;
   my $lon_start = shift;
   my $lat_end   = shift;
   my $lon_end   = shift;
   my %opts      = @_;

   my $styles = delete $opts{styles} // {};

   my ($map_x_start, $map_y_start) = $self->lat_lon_to_map_coordinates($lat_start, $lon_start);
   my ($map_x_end  , $map_y_end  ) = $self->lat_lon_to_map_coordinates($lat_end  , $lon_end  );

   $self->{svg}->line(
      x1 => $map_x_start, y1 => $map_y_start,
      x2 => $map_x_end  , y2 => $map_y_end,
      style => $styles
   );



#_}
}
# sub _determine_width_height { #_{
# #_{ POD
#
# =head2 _determine_width_height
#
# This method determines the width and height of the produced SVG so that C<< max($width, $height) >> is equal to C<< $max_width_height >> which was passed in the
# L method.
#
# =cut
#
#   my $self = shift;
#
# #_}
#
#  (
#   $self->{x_min}, $self->{y_min},
#   $self->{x_max}, $self->{y_max}
#  ) = (
#   &{$self->{cp_lat_lon_2_x_y}}($self->{lat_min}, $self->{lon_min}),
#   &{$self->{cp_lat_lon_2_x_y}}($self->{lat_max}, $self->{lon_max})
#  );
#
#   my $width_  = $self->{x_max}-$self->{x_min};
#   my $height_ = $self->{y_max}-$self->{y_min};
#
#   if ($width_ > $height_) {
#     $self->{width } = $self->{max_width_height};
#     $self->{height} = $self->{max_width_height} / $width_*$height_;
#   }
#   else {
#     $self->{height} = $self->{max_width_height};
#     $self->{width } = $self->{max_width_height} / $height_*$width_;
#   }
#
# } #_}
# sub _x_y_to_svg_x_y { #_{
# #_{ POD
#
# =head2 _x_y_to_svg_x_y
#
#     my ($svg_x, $svg_y) = $self->_x_y_to_svg_x_y($x, $y);
#
# This method converts an C coordinate pair to svg coordinates. Ideally, the
# returned values are greater or equal 0 and smaller or equal to the svg width or
# height respectively.
#
# =cut
# #_}
#
#   my $self = shift;
#   my $x    = shift;
#   my $y    = shift;
#
#   my $todo_width  = 1;
#   my $todo_height = 1;
#
# # In SVG, the coordinate 0/0 marks the *upper* left corner, so
# # for y, we have to make an additional substraction for $y.
#   my $x_ =                   ($x - $self->{x_min}) / $todo_width  * $self->{width };
#   my $y_ = $self->{height} - ($y - $self->{y_min}) / $todo_height * $self->{height};
#
#   return ($x_, $y_);
#
# } #_}
#_}
#_{ POD: Author

=head1 AUTHOR

René Nyffenegger

=cut

#_}
#_{ POD: Copyright and License

=head1 COPYRIGHT AND LICENSE
Copyright © 2017 René Nyffenegger, Switzerland. All rights reserved.

This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a
copy of the full license at: L
=cut

#_}
#_{ POD: Source Code

=head1 Source Code

The source code is on L<< github|https://github.com/ReneNyffenegger/perl-Geo-OSM-Render >>. Meaningful pull requests are welcome.

=cut

#_}

'tq84';