The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Graphics-Grid-0.001
River stage zero No dependents
1 ++
/ Graphics::Grid::Grob::Rect

NAME

Graphics::Grid::Grob::Rect - Rectangular grob

VERSION

version 0.001

SYNOPSIS

    use Graphics::Grid::Grob::Rect;
    use Graphics::Grid::GPar;
    my $rect = Graphics::Grid::Grob::Rect->new(
            x => 0.5, y => 0.5, width => 1, height => 1,
            just => "centre",
            gp => Graphics::Grid::GPar->new());

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

DESCRIPTION

This class represents a rectangular 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.

width

A Grahpics::Grid::Unit object specifying width.

Default to unit(1, "npc").

height

Similar to the width attribute except that it is for height.

just

The justification of the object, which consumes this role, relative to its (x, y) location.

The value is an arrayref in the form of [$hjust, $vjust], where $hjust and $vjust are two numbers for horizontal and vertical justification respectively. Each number is usually from 0 to 1, but can also beyond hat range. 0 means left alignment and 1 means right alighment.

Default is [0.5, 0.5], which means the object's center is aligned to its (x, y) position.

For example, for a rectangle which has $width and $height, and positioned at ($x, $y), the position of its left-bottom corner can be calculated in this way,

    $left   = $x - $hjust * $width;
    $bottom = $y - $vjust * $height;

This attribute also supports some string values. They map to numeric values like below.

    string                          numeric
    ---------------------------     ------------
    left                            [ 0,   0.5 ]
    top                             [ 0.5, 1   ]
    right                           [ 1,   0.5 ]
    bottom                          [ 0.5, 0   ]
    center | centre                 [ 0.5, 0.5 ]
    bottom_left | left_bottom       [ 0,   0   ]
    top_left | left_top             [ 0,   1   ]
    bottom_right | right_bottom     [ 1,   0   ]
    top_right | right_top           [ 1,   1   ]

hjust

A reader accessor for the horizontal justification.

vjust

A reader accessor for vertical justification.

gp

An object of Graphics::Grid::GPar. Default is an empty gpar object.

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 rectangles.

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.