CairoX-Sweet

 view release on metacpan or  search on metacpan

lib/CairoX/Sweet.pm  view on Meta::CPAN


    if($self->has_background_color) {
        $self->c->rectangle(0, 0, $self->width, $self->height);
        $self->c->set_source_rgb($self->background_color->color);
        $self->c->fill;
    }
}
sub new_svg {
    my $class = shift;
    my $width = shift;
    my $height = shift;
    my $filename = AbsPath->coerce(shift);
    my %args = @_;

    $args{'surface'} = Cairo::SvgSurface->create($filename, $width, $height);
    $args{'filename'} = $filename;
    return $class->new($width, $height, %args);
}

sub add_path {

    my $self = shift;
    my $path = shift; # CairoX::Sweet::Path
    my %options = @_;
    my $close = $options{'close'} || 0;

    if($path->has_background_color) {
        foreach my $command ($path->all_commands) {
            my $method = $command->method;
            $self->c->$method($command->out);
        }
        $self->c->set_source_rgb($path->background_color->color);
        $self->c->fill;
    }
    if(($path->has_background_color && $path->has_color) || !$path->has_background_color) {
        foreach my $command ($path->all_commands) {
            my $method = $command->method;
            $self->c->$method($command->out);
        }
        $self->c->set_line_cap($path->cap);
        $self->c->set_line_join($path->join);
        $self->c->set_source_rgb($path->color->color) if $path->has_color;
        $self->c->set_line_width($path->width) if $path->has_width;
        $self->c->close_path if $close;
        $self->c->stroke;
    }
}

sub add_text {
    my $self = shift;
    my %args = @_;

    my $text = $args{'text'};
    my $x = $args{'x'};
    my $y = $args{'y'};
    my $color = shift;
    $color = Color->check($color) ? $color : Color->coerce($color);
    my $font_face = $args{'font_face'} || [];
    my $font_size = shift;
    my $slant = $args{'slant'} || 'normal'; # normal italic oblique
    my $weight = $args{'weight'} || 'normal'; # normal bold


    $self->c->select_font_face(@{ $font_face }, $slant, $weight) if scalar @$font_face;
    $self->c->set_font_size($font_size) if defined $font_size;
    $self->c->set_source_rgb($color->color) if defined $color;
    $self->c->move_to($x, $y)               if defined $x && defined $y;

    $self->c->show_text($text);
    $self->c->fill;

}

1;

__END__

=pod

=encoding utf-8

=head1 NAME

CairoX::Sweet - Wraps Cairo for easier drawing



=begin html

<p>
<img src="https://img.shields.io/badge/perl-5.10+-blue.svg" alt="Requires Perl 5.10+" />
<a href="https://travis-ci.org/Csson/p5-CairoX-Sweet"><img src="https://api.travis-ci.org/Csson/p5-CairoX-Sweet.svg?branch=master" alt="Travis status" /></a>
<a href="http://cpants.cpanauthors.org/release/CSSON/CairoX-Sweet-0.0200"><img src="http://badgedepot.code301.com/badge/kwalitee/CSSON/CairoX-Sweet/0.0200" alt="Distribution kwalitee" /></a>
<a href="http://matrix.cpantesters.org/?dist=CairoX-Sweet%200.0200"><img src="http://badgedepot.code301.com/badge/cpantesters/CairoX-Sweet/0.0200" alt="CPAN Testers result" /></a>
<img src="https://img.shields.io/badge/coverage-65.4%-red.svg" alt="coverage 65.4%" />
</p>

=end html

=head1 VERSION

Version 0.0200, released 2016-08-22.

=head1 SYNOPSIS

    use CairoX::Sweet;

    my $c = CairoX::Sweet->new(500, 500, '#ffffff');
    my $path = CairoX::Sweet::Path->new(start => [35, 50], color => '#8855bb', width => 10, cap => 'round', join => 'round');

    $path->add_relative_line(qw/
        20 -5
        10 0
        30 -20
        -50 0
    /);
    $c->add_path($path, close => 1);

    $c->surface->write_to_png('a_short_line.png');

=head1 DESCRIPTION

lib/CairoX/Sweet.pm  view on Meta::CPAN


=head2 background_color

    my $c1 = CairoX::Sweet->new(..., background_color => '#83f9e2');
    my $c2 = CairoX::Sweet->new(..., background_color => [220, 75, 230]);
    my $c3 = CairoX::Sweet->new(..., background_color => [0.2, 0.4, 0.6]);

String or array reference of numbers. Optional. The starting background color.

You can pick one of three ways to give a color:

=over 4

=item *

As a hexadecimal string

=item *

As an array reference giving a number each for red, green and blue (between 0 and 255).

=item *

As an array reference in fractions between 0 and 1. This is the C<cairo> style. B<Note:> A color given as C<[1, 1, 1]> is interpreted as (nearly) black, and not white as C<cairo> would do.

=back

=head2 filename

    my $c = CairoX::Sweet->new_svg(..., filename => 'mysvg.svg');

String or a L<Path::Tiny> path. Required for L<new_svg|/"new_svg($width, $height, $filename, %args)">.

=head1 METHODS

=head2 add_path()

Adds a L<CairoX::Sweet::Path> to the C<cairo> object.

    $c->add_path($path, close => 1);

C<$path>

The L<CairoX::Sweet::Path> to add. Required.

C<close => Bool>

Boolean. Optional named parameter, defaults to C<0>. If positive, will call C<close_path|http://cairographics.org/manual/cairo-Paths.html#cairo-close-path>
on the C<$path> (connects the two end points of the C<$path>).

=head2 add_text()

Adds a string to the C<cairo> object. Takes only named parameters.

    $c->add_text( text => "The text to add",
                  color => '#444444',
                  x => 37,
                  y => 115,
                  font_face => ['courier'],
                  font_size => 13
                  weight => 'bold',
    );

C<text => 'the text'>

String. The only required parameter. The text to add.

C<x>

C<y>

Integers. The position to start at.

C<color>

A color. The color of the text. See L</"background_color"> for more information on colors.

C<font_face>

An array reference of font faces. There is no list of available font faces.

C<font_size>

Number. The size of the text. Default is C<10>.

C<weight>

One of C<normal> or C<bold>.

C<slant>

One of C<normal>, C<italic> or C<oblique>.

=head2 c()

Returns the L<Cairo> object itself.

    $c->c->set_source_rgb(0.4, 0.3, 0.2);
    $c->c->set_line_cap('round');
    $c->c->arc(150, 200, 35, 0, 3.1415);
    $c->c->stroke;

=head2 surface()

Return the L<Cairo surface|https://metacpan.org/pod/Cairo#Surfaces>.

    $c->surface->write_to_png('a_short_line.png');

=head1 STABILITY

Since this is an early release things might break, but hopefully not without good cause.

=head1 PERFORMANCE

Using both L<Moose> and L<Moops> adds a little startup cost. If you need performance it is recommended to use L<Cairo> directly.

=head1 SEE ALSO

=over 4

=item *

L<CairoX::Sweet::Path>

=item *

L<Cairo>

=back

=head1 SOURCE

L<https://github.com/Csson/p5-CairoX-Sweet>

=head1 HOMEPAGE

L<https://metacpan.org/release/CairoX-Sweet>

=head1 AUTHOR

Erik Carlsson <info@code301.com>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Erik Carlsson.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.



( run in 1.012 second using v1.01-cache-2.11-cpan-364913b4093 )