.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Graphics::Primitive::Canvas 3pm"
.TH Graphics::Primitive::Canvas 3pm "2022-06-14" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Graphics::Primitive::Canvas \- Component composed of paths
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Graphics::Primitive::Canvas is a component for drawing arbitrary things.  It
holds Paths and
Operations.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Graphics::Primitive::Canvas;
\&
\&  my $canvas = Graphics::Primitive::Canvas\->new;
\&  $canvas\->move_to($point); # or just $x, $y
\&  $canvas\->do($op);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Canvas is a container for multiple Paths.
It has a \fIpath\fR that is the operative path for all path-related
methods.  You can treat the Canvas as if it was a path, calling methods
like \fIline_to\fR or \fImove_to\fR.
.PP
When you are ready to perform an operation on the path, call the \fIdo\fR method
with the operation you want to call as an argument.  Drawing a line and
stroking it would look like:
.PP
.Vb 7
\&  $canvas\->move_to(0, 0);
\&  $canvas\->line_to(10, 10);
\&  my $op = Graphics::Primitive::Operation::Stroke\->new;
\&  $stroke\->brush\->color(
\&      Graphics::Color::RGB\->new(red => 0, blue => 1, green => 1)
\&  );
\&  $canvas\->do($op);
.Ve
.PP
When you instantiate a Canvas a newly instantiated path resides in
\&\fIpath\fR.  After you call \fIdo\fR that current path is moved to the \fIpaths\fR
list and new path is placed in \fIcurrent_path\fR.  If you want to keep the path
around you can call \fIsave\fR before \fIdo\fR then call \fIrestore\fR to put a saved
copy of the path back into \fIpath\fR.
.SH "METHODS"
.IX Header "METHODS"
.SS "Constructor"
.IX Subsection "Constructor"
.IP "\fInew\fR" 4
.IX Item "new"
Creates a new Graphics::Primitive::Canvas
.SS "Instance Methods"
.IX Subsection "Instance Methods"
.IP "\fIdo\fR" 4
.IX Item "do"
Given an operation, pushes the current path onto the path stack.
.Sp
.Vb 1
\&  FIXME: Example
.Ve
.IP "\fIpath\fR" 4
.IX Item "path"
The current path this canvas is using.
.IP "\fIpath_count\fR" 4
.IX Item "path_count"
Count of paths in \fIpaths\fR.
.IP "\fIpaths\fR" 4
.IX Item "paths"
Arrayref of hashrefs representing paths combined with their operations:
.Sp
.Vb 6
\&  [
\&    {
\&        path => $path,
\&        op   => $op
\&    },
\&  ]
.Ve
.IP "\fIrestore\fR" 4
.IX Item "restore"
Replace the current path by popping the top path from the saved path list.
.IP "\fIsave\fR" 4
.IX Item "save"
Copy the current path and push it onto the stack of saved paths.
.IP "\fIsaved_paths\fR" 4
.IX Item "saved_paths"
List of saved paths.  Add to the list with \fIsave\fR and pop from it using
\&\fIrestore\fR.
.IP "\fIsaved_path_count\fR" 4
.IX Item "saved_path_count"
Count of paths saved in \fIsaved_paths\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
Cory Watson <gphat@cpan.org>
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2008\-2010 by Cory G Watson.
.PP
You can redistribute and/or modify this code under the same terms as Perl
itself.