graphics::primitive::driver(3pm) [debian man page]

Graphics::Primitive::Driver(3pm)			User Contributed Perl Documentation			  Graphics::Primitive::Driver(3pm)

NAME

       Graphics::Primitive::Driver - Role for driver implementations

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!

       To write a driver for Graphics::Primitive implement this role.

SYNOPSIS

	 my $c = Graphics::Primitive::Component->new({
	   origin => Geometry::Primitive::Point->new({
	       x => $x, y => $y
	   }),
	   width => 500, height => 350
	 });

CANVASES

       When a path is added to the internal list via do, it is stored in the paths attribute as a hashref.  The hashref has two keys: path and op.
       The path is, well, the path.  The op is the operation provided to do.  As canvases are just lists of paths you should consult the next
       section as well.

PATHS AND HINTING

       Paths are lists of primitives.  Primitives are all descendants of Geometry::Shape and therefore have point_start and point_end.	These two
       attributes allow the chaining of primitives.  To draw a path you should iterate over the primitives, drawing each.

       When you pull each path from the arrayref you should pull it's accompanying hints via get_hint (the indexes match).  The hint may provide
       you with additional information:

   PRIMITIVE HINTS
       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.

   OPERATION HINTS
       preserve

WARNING

       Only this class or the driver itself should call methods starting with an underscore, as this interface may change.

METHODS

       _do_stroke ($strokeop)
	   Perform a stroke.

       _do_fill ($fillop)
	   Perform a fill.

       _draw_arc ($arc)
	   Draw an arc.

       _draw_canvas ($canvas)
	   Draw a canvas.

       _draw_component ($comp)
	   Draw a component.

       _draw_line ($line)
	   Draw a line.

       _draw_rectangle ($rect)
	   Draw a rectangle.

       _draw_textbox
	   Draw a textbox.

       _resize ($width, $height)
	   Resize the current working surface to the size specified.

       _finish_page
	   Finish the current 'page' and start a new one.  Some drivers that are not paginated may need to emulate this behaviour.

       data
	   Retrieve the results of this driver's operations.

       draw
	   Draws the given Graphics::Primitive::Component.  If the component is a container then all components therein are drawn, recursively.

       get_text_bounding_box
	   Given a Font and a string, returns a bounding box of the rendered text.

       finalize
	   Finalize the supplied component and any child components, recursively.

       prepare
	   Prepare the supplied component and any child components, recursively.

       write
	   Write out the results of this driver's operations to the specified file.

AUTHOR

       Cory Watson, "<gphat@cpan.org>"

COPYRIGHT &; LICENSE
       Copyright 2008-2010 by Cory G Watson.

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

perl v5.12.3							    2010-08-21					  Graphics::Primitive::Driver(3pm)

Check Out this Related Man Page

Graphics::Primitive(3pm)				User Contributed Perl Documentation				  Graphics::Primitive(3pm)

NAME

       Graphics::Primitive - Device and library agnostic graphic primitives

SYNOPSIS

       Graphics::Primitive is a device and library agnostic system for creating and manipulating various graphical elements such as Borders,
       Fonts, Paths and the like.

	   my $c = Graphics::Primitive::Component->new(
	     background_color => Graphics::Color::RGB->new(
		 red => 1, green => 0, blue => 0
	     ),
	     width => 500, height => 350,
	     border => new Graphics::Primitive::Border->new( width => 5 )
	   );

	   my $driver = Graphics::Primitive::Driver::Cairo->new(format => 'SVG');

	   $driver->prepare($c);
	   $driver->finalize($c);
	   $driver->draw($c);

	   $driver->write($filename)

DESCRIPTION

       Graphics::Primitive is library agnostic system for drawing things.

       The idea is to allow you to create and manipulate graphical components and then pass them off to a Driver for actual drawing.

CONCEPTS

       The root object for Graphics::Primitive is the Component.  Components contain all the common elements that you'd expect: margins, padding,
       background color etc.

       The next most important is the Container.  Containers are Components that can hold other Components.  Containers have all the attributes
       and methods of a Component with the addition of the layout_manager attribute for us with Layout::Manager.

       Another important Component is the Canvas.  The Canvas differs from other components by being a container for various Geometry::Primitive
       objects.  This allows drawing of arbitrary shapes that do not fit existing components.

DRAWING LIFECYCLE

       After creating all your components, there is a lifecycle that allows them to do their internal housekeeping to prepare for eventual
       drawing.  The lifecycle is: prepare, layout and pack.  Detailed explanation of these methods can be found in Component.

PREPARATION

       Graphics::Primitive::Component has a "prepared" flag.  This flag is set as part of the "prepare" method (shocking, I know).  If this flag
       is set, then subsequent calls to "prepare" are ignored.	Containers also have a prepare flag, but this flag is not set when calling
       "prepare".  A Container's flag should be set by the layout manager.  More information may be found with Layout::Manager.

INSPIRATION

       Most of the concepts that you'll find in Graphics::Primitive are inspired by Cairo <http://cairographics.org>'s API and CSS
       <http://www.w3.org/Style/CSS/>'s box model.

AUTHOR

       Cory Watson, "<gphat@cpan.org>"

CONTRIBUTORS

       Florian Ragwitz

ACKNOWLEDGEMENTS

       Many of the ideas here come from my experience using the Cairo library.

COPYRIGHT &; LICENSE
       Copyright 2008-2010 by Cory G Watson.

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

perl v5.12.3							    2011-06-02						  Graphics::Primitive(3pm)

Linux and UNIX Man Pages

graphics::primitive::driver(3pm) [debian man page]

Check Out this Related Man Page