First cut at the documentation

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

diff --git a/lib/LaTeX/TikZ/Set/Circle.pm b/lib/LaTeX/TikZ/Set/Circle.pm
index b1d83b83454a9217715d5c57769b25dee7b1720c..c035562cad6fbe0d5505fec979dd8e25c634796a 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Circle.pm
+++ b/lib/LaTeX/TikZ/Set/Circle.pm
@@ -15,30 +15,57 @@ Version 0.01
 
 our $VERSION = '0.01';
 
+use LaTeX::TikZ::Set::Point;
+
+use LaTeX::TikZ::Interface;
+use LaTeX::TikZ::Functor;
+
 use LaTeX::TikZ::Tools;
 
 use Any::Moose;
 use Any::Moose 'Util::TypeConstraints';
 
+=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<center>
+
+A L<LaTeX::TikZ::Set::Point> object describing the center of the circle.
+
+=cut
+
 has 'center' => (
  is       => 'ro',
- does     => 'LaTeX::TikZ::Point',
+ isa      => 'LaTeX::TikZ::Set::Point',
  required => 1,
+ coerce   => 1,
 );
 
-subtype 'LaTeX::TikZ::Set::Circle::Radius'
-     => as 'Num'
-     => where { LaTeX::TikZ::Tools::numcmp($_, 0) >= 1 }
-     => message { "$_ isn't a non-negative real number" };
+=head2 C<radius>
+
+The radius of the circle as a non-negative real number.
+
+=cut
 
 has 'radius' => (
  is       => 'ro',
- isa      => 'LaTeX::TikZ::Set::Circle::Radius',
+ isa      => subtype('Num' => where { LaTeX::TikZ::Tools::numcmp($_, 0) > 0 }),
  required => 1,
 );
 
+=head1 METHODS
+
+=head2 C<path>
+
+=cut
+
 sub path {
  my $set  = shift;
  my $tikz = $_[0];
@@ -46,11 +73,23 @@ sub path {
  $set->center->path(@_) . ' circle (' . $tikz->len($set->radius) . ')';
 }
 
-use LaTeX::TikZ::Interface circle => sub {
- shift;
+LaTeX::TikZ::Interface->register(
+ circle => sub {
+  shift;
 
- __PACKAGE__->new(center => $_[0], radius => $_[1]);
-};
+  __PACKAGE__->new(center => $_[0], radius => $_[1]);
+ },
+);
+
+LaTeX::TikZ::Functor->default_rule(
+ (__PACKAGE__) => sub {
+  my ($functor, $set, @args) = @_;
+  $set->new(
+   center => $set->center->$functor(@args),
+   radius => $set->radius,
+  );
+ }
+);
 
 __PACKAGE__->meta->make_immutable;