NAME

Graphics::Grid::Grob::Circle - Circle grob

VERSION

version 0.001

SYNOPSIS

    use Graphics::Grid::Grob::Circle;
    use Graphics::Grid::GPar;
    my $circle = Graphics::Grid::Grob::Circle->new(
            x => 0.5, y => 0.5, r => 0.5,
            gp => Graphics::Grid::GPar->new());

    # or use the function interface
    use Graphics::Grid::Functions qw(:all);
    my $circle = circle_grob(%params);

DESCRIPTION

This class represents a circle graphical object.

ATTRIBUTES

x

A Grahpics::Grid::Unit object specifying x-location.

Default to unit(0.5, "npc").

y

A Grahpics::Grid::Unit object specifying y-location.

Default to unit(0.5, "npc").

The reference point is the left-bottom of parent viewport.

r

Radius of the circle. Default is 0.5 npc relative to the smaller one of viewport's width and height.

vp

A viewport object. When drawing a grob, if the grob has this attribute, the viewport would be temporily pushed onto the global viewport stack before drawing takes place, and be poped after drawing. If the grob does not have this attribute set, it would be drawn on the existing current viewport in the global viewport stack.

elems

Get number of sub-elements in the grob.

Grob classes shall implement a _build_elems() method to support this attribute.

METHODS

length

This is an alias of elems.

extents($grid)

Returns info about the grob's extents (bounding box, etc) on the drawing layer, in cm.

Note that not all grob classes have got this method implemented.

For this module elems returns the number of circles.

SEE ALSO

Graphics::Grid::Functions

Graphics::Grid::Grob

AUTHOR

Stephan Loyd <sloyd@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2018-2023 by Stephan Loyd.

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

cpanm Graphics::Grid

perl -MCPAN -e shell
install Graphics::Grid