graphics::primitive::container(3pm) [debian man page]
Graphics::Primitive::Container(3pm) User Contributed Perl Documentation Graphics::Primitive::Container(3pm) NAME
Graphics::Primitive::Container - Component that holds other Components DESCRIPTION
Containers are components that contain other components. They can also hold an instance of a Layout::Manager for automatic layout of their internal components. See the Component's Lifecycle Section for more information. SYNOPSIS
my $c = Graphics::Primitive::Container->new( width => 500, height => 350, layout_manager => Layout::Manager::Compass->new ); $c->add_component($comp, { meta => 'data' }); METHODS
Constructor new Creates a new Container. Instance Methods add_component ($component, [ $constraint ]) Add a component to the container. Returns a true value if the component was added successfully. A second argument may be required, please consult the POD for your specific layout manager implementation. Before the component is added, it is passed to the validate_component method. If validate_component does not return a true value, then the component is not added. clear_components Remove all components from the layout manager. component_count Returns the number of components in this container. component_list Returns this Container's ComponentList. find_component Returns the index of the first component with the supplied name. Returns undef if no component with that name is found. get_component Get the component at the specified index. get_constraint Get the constraint at the specified index. get_tree Returns a Forest::Tree object with this component at the root and all child components as children. Calling this from your root container will result in a tree representation of the entire scene. prepare Prepares this container. Does not mark as prepared, as that's done by the layout manager. remove_component Removes a component. Components must have names to be removed. Returns an arrayref of removed components. validate_component Optionally overridden by an implementation, allows it to deem a component as invalid. If this sub returns false, the component won't be added. AUTHOR
Cory Watson, "<gphat@cpan.org>" BUGS
Please report any bugs or feature requests to "bug-geometry-primitive at rt.cpan.org", or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Geometry-Primitive <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Geometry-Primitive>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. COPYRIGHT &; LICENSE Copyright 2008-2009 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::Container(3pm)
Check Out this Related 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)