First cut at the documentation

[perl/modules/LaTeX-TikZ.git] / lib / LaTeX / TikZ / Set / Rectangle.pm

diff --git a/lib/LaTeX/TikZ/Set/Rectangle.pm b/lib/LaTeX/TikZ/Set/Rectangle.pm
index 08cba5a7034e315a3ef77fc2a64e771dd6daad7d..3d11cc57a5aaf1f514edfdf18d2cd626ab00453b 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Rectangle.pm
+++ b/lib/LaTeX/TikZ/Set/Rectangle.pm
@@ -17,10 +17,27 @@ our $VERSION = '0.01';
 
 use LaTeX::TikZ::Set::Point;
 
+use LaTeX::TikZ::Interface;
+use LaTeX::TikZ::Functor;
+
 use Any::Moose;
 
+=head1 RELATIONSHIPS
+
+This class consumes the L<LaTeX::TikZ::Set::Op> role, and as such implements the L</path> method.
+
+=cut
+
 with 'LaTeX::TikZ::Set::Op';
 
+=head1 ATTRIBUTES
+
+=head2 C<from>
+
+The first corner of the rectangle, as a L<LaTeX::TikZ::Set::Point> object.
+
+=cut
+
 has 'from' => (
  is       => 'ro',
  isa      => 'LaTeX::TikZ::Set::Point',
@@ -28,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',
@@ -35,16 +58,34 @@ 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;
 
@@ -60,9 +101,12 @@ around 'BUILDARGS' => sub {
  my $class = shift;
 
  if (@_ == 2 and $tc1->check($_[0]) and $tc2->check($_[1])) {
+  my ($from, $to) = @_;
   @_ = (
-   from => $_[0],
-   to   => $_[1],
+   from   => $from,
+   to     => $to,
+   width  => $to->x - $from->x,
+   height => $to->y - $from->y,
   );
  } else {
   my %args = @_;
@@ -72,7 +116,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/width height/;
+                                                      for qw/from width height/;
    my $p = $args{from}->point;
    $args{to} = LaTeX::TikZ::Point->new(
     x => $p->x + $args{width},
@@ -85,17 +129,26 @@ Attributes 'width' and 'height' are required when 'to' was not given
  $class->$orig(@_);
 };
 
-use LaTeX::TikZ::Interface rectangle => sub {
- shift;
- my ($p, $q) = @_;
+LaTeX::TikZ::Interface->register(
+ rectangle => sub {
+  shift;
+  my ($p, $q) = @_;
 
- my $is_relative = !blessed($q) && ref($q) eq 'HASH';
+  my $is_relative = !blessed($q) && ref($q) eq 'HASH';
 
- __PACKAGE__->new(
-  from => $p,
-  ($is_relative ? (map +($_ => $q->{$_}), qw/width height/) : (to => $q)),
- );
-};
+  __PACKAGE__->new(
+   from => $p,
+   ($is_relative ? (map +($_ => $q->{$_}), qw/width height/) : (to => $q)),
+  );
+ },
+);
+
+LaTeX::TikZ::Functor->default_rule(
+ (__PACKAGE__) => sub {
+  my ($functor, $set, @args) = @_;
+  $set->new(map { $_ => $set->$_->$functor(@args) } qw/from to/)
+ }
+);
 
 __PACKAGE__->meta->make_immutable;