This is 0.02

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

diff --git a/lib/LaTeX/TikZ/Formatter.pm b/lib/LaTeX/TikZ/Formatter.pm
index efa7dc6ed1da9c6558a18a02940163bdaa3d55b7..1acf9b8a731b97575916d28ae4744b447cad9127 100644 (file)
--- a/lib/LaTeX/TikZ/Formatter.pm
+++ b/lib/LaTeX/TikZ/Formatter.pm
@@ -9,11 +9,17 @@ LaTeX::TikZ::Formatter - LaTeX::TikZ formatter object.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.02
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
+
+=head1 DESCRIPTION
+
+A formatter object turns a L<LaTeX::TikZ::Set> tree into the actual TikZ code, depending on some parameters such as the scale, the unit or the origin.
+
+=cut
 
 use Sub::Name ();
 
@@ -26,40 +32,100 @@ use LaTeX::TikZ::Tools;
 use Any::Moose;
 use Any::Moose 'Util::TypeConstraints';
 
+=head1 ATTRIBUTES
+
+=head2 C<unit>
+
+The unit in which lengths are printed.
+Valid units are C<cm> for centimeters and C<pt> for points.
+
+Defaults to C<cm>.
+
+=cut
+
 has 'unit' => (
  is      => 'ro',
  isa     => enum([ qw/cm pt/ ]),
  default => 'cm',
 );
 
+=head2 C<format>
+
+The format used to print the numbers.
+
+Defaults to C<%s>.
+
+=cut
+
 has 'format' => (
  is      => 'ro',
  isa     => 'Str',
  default => '%s',
 );
 
+=head2 C<scale>
+
+The scale of the drawing.
+
+Defaults to C<1>.
+
+=cut
+
 has 'scale' => (
  is      => 'rw',
  isa     => 'Num',
  default => 1,
 );
 
+=head2 C<width>
+
+The width of the drawing area.
+
+Defaults to C<undef> for none.
+
+=cut
+
 has 'width' => (
  is  => 'rw',
  isa => 'Maybe[Num]',
 );
 
+=head2 C<height>
+
+The height of the drawing area.
+
+Defaults to C<undef> for none.
+
+=cut
+
 has 'height' => (
  is  => 'rw',
  isa => 'Maybe[Num]',
 );
 
+=head2 C<origin>
+
+A point coerced into a L<LaTeX::TikZ::Point> object that represents the logical origin of the printed area.
+If L</width> and L</height> are set, the canvas will be equivalent to a rectangle whose lower left corner at C<-$origin> and of given width and length.
+
+Defaults to C<(0, 0)>, meaning that the drawing area goes from C<(0, 0)> to C<($width, $height)>.
+
+=cut
+
 has 'origin' => (
  is     => 'rw',
  isa    => 'LaTeX::TikZ::Point::Autocoerce',
  coerce => 1,
 );
 
+=head1 METHODS
+
+=head2 C<id>
+
+An unique identifier of the formatter object.
+
+=cut
+
 sub id {
  my $tikz = shift;
 
@@ -76,6 +142,55 @@ sub id {
  } map($tikz->$_, qw/unit format scale width height/), $origin;
 }
 
+=head2 C<render @sets>
+
+Processes all the L<LaTeX::TikZ::Set> objects given in C<@sets> to produce the actual TikZ code to insert in the LaTeX file.
+First, all the mods applied to the sets and their subsets are collected, and a declaration is emitted if needed for each of them by calling L<LaTeX::TikZ::Mod/declare>.
+Then, the image code is generated for each set.
+
+This method returns a list of array references :
+
+=over 4
+
+=item *
+
+The first one contains the header lines to include between the C<\documentclass> and the C<\begin{document}>.
+
+=item *
+
+The second one contains the mod declaration lines to put inside the document, between C<\begin{document}> and C<\end{document}>.
+
+=item *
+
+Finally, there's one array reference for each given TikZ set, which contain the lines for the actual TikZ pictures.
+
+=back
+
+The lines returned by L</render> don't end with a line feed.
+
+    my ($header, $declarations, $set1_body, $set2_body) = $formatter->render($set1, $set2);
+
+    open my $tex, '>', 'test.tex' or die "open('>test.tex'): $!";
+
+    print $tex "$_\n" for (
+     "\\documentclass[12pt]{article}",
+     @$header,
+     "\\begin{document}",
+      "\\pagestyle{empty}",
+      @$declarations,
+      "First set :"
+      "\\begin{center}",
+       @$set1_body,
+      "\\end{center}",
+      "Second set :"
+      "\\begin{center}",
+       @$set2_body,
+      "\\end{center}",
+     "\\end{document}",
+    );
+
+=cut
+
 my $find_mods = do {
  our %seen;
 
@@ -183,6 +298,12 @@ sub render {
  return \@header, \@decls, @bodies;
 }
 
+=head2 C<len $len>
+
+Format the given length according to the formatter options.
+
+=cut
+
 sub len {
  my ($tikz, $len) = @_;
 
@@ -191,6 +312,12 @@ sub len {
  sprintf $tikz->format . $tikz->unit, $len * $tikz->scale;
 }
 
+=head2 C<angle $theta>
+
+Format the given angle (in radians) according to the formatter options.
+
+=cut
+
 sub angle {
  my ($tikz, $a) = @_;
 
@@ -201,6 +328,12 @@ sub angle {
  sprintf $tikz->format, POSIX::ceil($a);
 }
 
+=head2 C<label $name, $pos>
+
+Returns the TikZ code for a point labeled C<$name> at position C<$pos> according to the formatter options.
+
+=cut
+
 sub label {
  my ($tikz, $name, $pos) = @_;
 
@@ -209,6 +342,12 @@ sub label {
  "node[scale=$scale,$pos] {$name}";
 }
 
+=head2 C<thickness>
+
+Format the given line thickness according to the formatter options.
+
+=cut
+
 sub thickness {
  my ($tikz, $width) = @_;
 
@@ -226,6 +365,10 @@ LaTeX::TikZ::Interface->register(
 
 __PACKAGE__->meta->make_immutable;
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.