.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Graphics::Primitive::Driver 3pm"
.TH Graphics::Primitive::Driver 3pm "2015-01-04" "perl v5.20.2" "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::Driver \- Role for driver implementations
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
What good is a library agnostic intermediary representation of graphical
components if you can't feed them to a library specific implementation that
turns them into drawings? Psht, none!
.PP
To write a driver for Graphics::Primitive implement this role.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&  my $c = Graphics::Primitive::Component\->new({
\&    origin => Geometry::Primitive::Point\->new({
\&        x => $x, y => $y
\&    }),
\&    width => 500, height => 350
\&  });
.Ve
.SH "CANVASES"
.IX Header "CANVASES"
When a path is added to the internal list via \fIdo\fR, it is stored in the
\&\fIpaths\fR attribute as a hashref.  The hashref has two keys: \fBpath\fR and \fBop\fR.
The path is, well, the path.  The op is the operation provided to \fIdo\fR.  As
canvases are just lists of paths you should consult the next section as well.
.SH "PATHS AND HINTING"
.IX Header "PATHS AND HINTING"
Paths are lists of primitives.  Primitives are all descendants of
Geometry::Shape and therefore have \fIpoint_start\fR and \fIpoint_end\fR.  These
two attributes allow the chaining of primitives.  To draw a path you should
iterate over the primitives, drawing each.
.PP
When you pull each path from the arrayref you should pull it's accompanying
hints via \fIget_hint\fR (the indexes match).  The hint may provide you with
additional information:
.SS "\s-1PRIMITIVE HINTS\s0"
.IX Subsection "PRIMITIVE HINTS"
.IP "\fIcontiguous\fR" 4
.IX Item "contiguous"
True if this primitive is contiguous with the previous one.  Example: Used to
determine if a new sub-path is needed for the Cairo driver.
.SS "\s-1OPERATION HINTS\s0"
.IX Subsection "OPERATION HINTS"
.IP "\fIpreserve\fR" 4
.IX Item "preserve"
.SH "WARNING"
.IX Header "WARNING"
Only this class or the driver itself should call methods starting with an
underscore, as this interface may change.
.SH "METHODS"
.IX Header "METHODS"
.IP "\fI_do_stroke ($strokeop)\fR" 4
.IX Item "_do_stroke ($strokeop)"
Perform a stroke.
.IP "\fI_do_fill ($fillop)\fR" 4
.IX Item "_do_fill ($fillop)"
Perform a fill.
.IP "\fI_draw_arc ($arc)\fR" 4
.IX Item "_draw_arc ($arc)"
Draw an arc.
.IP "\fI_draw_canvas ($canvas)\fR" 4
.IX Item "_draw_canvas ($canvas)"
Draw a canvas.
.IP "\fI_draw_component ($comp)\fR" 4
.IX Item "_draw_component ($comp)"
Draw a component.
.IP "\fI_draw_line ($line)\fR" 4
.IX Item "_draw_line ($line)"
Draw a line.
.IP "\fI_draw_rectangle ($rect)\fR" 4
.IX Item "_draw_rectangle ($rect)"
Draw a rectangle.
.IP "\fI_draw_textbox\fR" 4
.IX Item "_draw_textbox"
Draw a textbox.
.ie n .IP "\fI_resize ($width, \fI$height\fI)\fR" 4
.el .IP "\fI_resize ($width, \f(CI$height\fI)\fR" 4
.IX Item "_resize ($width, $height)"
Resize the current working surface to the size specified.
.IP "\fI_finish_page\fR" 4
.IX Item "_finish_page"
Finish the current 'page' and start a new one.  Some drivers that are not
paginated may need to emulate this behaviour.
.IP "\fIdata\fR" 4
.IX Item "data"
Retrieve the results of this driver's operations.
.IP "\fIdraw\fR" 4
.IX Item "draw"
Draws the given Graphics::Primitive::Component.  If the component is a
container then all components therein are drawn, recursively.
.IP "\fIget_text_bounding_box\fR" 4
.IX Item "get_text_bounding_box"
Given a Font and a string, returns a bounding box
of the rendered text.
.IP "\fIfinalize\fR" 4
.IX Item "finalize"
Finalize the supplied component and any child components, recursively.
.IP "\fIprepare\fR" 4
.IX Item "prepare"
Prepare the supplied component and any child components, recursively.
.IP "\fIwrite\fR" 4
.IX Item "write"
Write out the results of this driver's operations to the specified file.
.SH "AUTHOR"
.IX Header "AUTHOR"
Cory Watson, \f(CW\*(C`<gphat@cpan.org>\*(C'\fR
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2008\-2010 by Cory G Watson.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.