X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FLaTeX%2FTikZ%2FSet%2FRectangle.pm;h=322329abd7f96187af6bf8d4a106fc6a6c25d0e1;hb=3661d7849ae4636b74000e33e068493d90ed8337;hp=5c20fa8e95a0a769d3c84ce9cbfd085fa66ba3b9;hpb=fcf49f47b7655e0bc3ed8c3da7f1004cbb70c7a5;p=perl%2Fmodules%2FLaTeX-TikZ.git

diff --git a/lib/LaTeX/TikZ/Set/Rectangle.pm b/lib/LaTeX/TikZ/Set/Rectangle.pm
index 5c20fa8..322329a 100644
--- a/lib/LaTeX/TikZ/Set/Rectangle.pm
+++ b/lib/LaTeX/TikZ/Set/Rectangle.pm
@@ -9,20 +9,34 @@ LaTeX::TikZ::Set::Rectangle - A set object representing a rectangle.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.02
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
 
 use LaTeX::TikZ::Set::Point;
 
 use LaTeX::TikZ::Interface;
 use LaTeX::TikZ::Functor;
 
-use Any::Moose;
+use Mouse;
 
-with 'LaTeX::TikZ::Set::Op';
+=head1 RELATIONSHIPS
+
+This class consumes the L<LaTeX::TikZ::Set::Path> role, and as such implements the L</path> method.
+
+=cut
+
+with 'LaTeX::TikZ::Set::Path';
+
+=head1 ATTRIBUTES
+
+=head2 C<from>
+
+The first corner of the rectangle, as a L<LaTeX::TikZ::Set::Point> object.
+
+=cut
 
 has 'from' => (
  is       => 'ro',
@@ -31,6 +45,12 @@ has 'from' => (
  coerce   => 1,
 );
 
+=head2 C<to>
+
+The opposite endpoint of the rectangle, also as a L<LaTeX::TikZ::Set::Point> object.
+
+=cut
+
 has 'to' => (
  is       => 'ro',
  isa      => 'LaTeX::TikZ::Set::Point',
@@ -38,22 +58,52 @@ has 'to' => (
  coerce   => 1,
 );
 
+=head2 C<width>
+
+The algebraic width of the rectangle.
+
+=cut
+
 has 'width' => (
  is  => 'ro',
  isa => 'Num',
 );
 
+=head2 C<height>
+
+The algebraic height of the rectangle.
+
+=cut
+
 has 'height' => (
  is  => 'ro',
  isa => 'Num',
 );
 
+=head1 METHODS
+
+=head2 C<path>
+
+=cut
+
 sub path {
  my $set = shift;
 
  $set->from->path(@_) . ' rectangle ' . $set->to->path(@_);
 }
 
+=head2 C<begin>
+
+=cut
+
+sub begin { $_[0]->from->begin }
+
+=head2 C<end>
+
+=cut
+
+sub end { $_[0]->to->end }
+
 my $meta = __PACKAGE__->meta;
 my $tc1  = $meta->find_attribute_by_name('from')->type_constraint;
 my $tc2  = $meta->find_attribute_by_name('to')->type_constraint;
@@ -78,7 +128,7 @@ Attributes 'width' and 'height' are required when 'to' was not given
    MSG
    $args{from} = $tc1->coerce($args{from});
    $meta->find_attribute_by_name($_)->type_constraint->assert_valid($args{$_})
-                                                      for qw/from width height/;
+                                                      for qw<from width height>;
    my $p = $args{from}->point;
    $args{to} = LaTeX::TikZ::Point->new(
     x => $p->x + $args{width},
@@ -100,7 +150,7 @@ LaTeX::TikZ::Interface->register(
 
   __PACKAGE__->new(
    from => $p,
-   ($is_relative ? (map +($_ => $q->{$_}), qw/width height/) : (to => $q)),
+   ($is_relative ? (map +($_ => $q->{$_}), qw<width height>) : (to => $q)),
   );
  },
 );
@@ -108,12 +158,16 @@ LaTeX::TikZ::Interface->register(
 LaTeX::TikZ::Functor->default_rule(
  (__PACKAGE__) => sub {
   my ($functor, $set, @args) = @_;
-  $set->new(map { $_ => $set->$_->$functor(@args) } qw/from to/)
+  $set->new(map { $_ => $set->$_->$functor(@args) } qw<from to>)
  }
 );
 
 __PACKAGE__->meta->make_immutable;
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>, L<LaTeX::TikZ::Set::Path>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.