Introduce LaTeX::TikZ::Mod::Scale

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

diff --git a/lib/LaTeX/TikZ/Mod/Scale.pm b/lib/LaTeX/TikZ/Mod/Scale.pm
new file mode 100644 (file)
index 0000000..51c79e9
--- /dev/null
+++ b/lib/LaTeX/TikZ/Mod/Scale.pm
@@ -0,0 +1,109 @@
+package LaTeX::TikZ::Mod::Scale;
+
+use strict;
+use warnings;
+
+=head1 NAME
+
+LaTeX::TikZ::Mod::Scale - A modifier that scales a TikZ set tree.
+
+=head1 VERSION
+
+Version 0.02
+
+=cut
+
+our $VERSION = '0.02';
+
+use LaTeX::TikZ::Interface;
+
+use LaTeX::TikZ::Tools;
+
+use Any::Moose;
+
+=head1 RELATIONSHIPS
+
+This class consumes the L<LaTeX::TikZ::Mod> role, and as such implements the L</tag>, L</covers>, L</declare> and L</apply> methods.
+
+=cut
+
+with 'LaTeX::TikZ::Mod';
+
+=head1 ATTRIBUTES
+
+=head2 C<scale>
+
+=cut
+
+has 'scale' => (
+ is       => 'ro',
+ isa      => 'Num',
+ required => 1,
+);
+
+=head1 METHODS
+
+=head2 C<tag>
+
+=cut
+
+sub tag { ref $_[0] }
+
+=head2 C<covers>
+
+=cut
+
+sub covers { LaTeX::TikZ::Tools::numeq($_[0]->scale, $_[1]->scale) }
+
+=head2 C<declare>
+
+=cut
+
+sub declare { }
+
+=head2 C<apply>
+
+=cut
+
+sub apply { sprintf 'scale=%0.3f', $_[0]->scale }
+
+LaTeX::TikZ::Interface->register(
+ scale => sub {
+  shift;
+
+  __PACKAGE__->new(scale => $_[0]);
+ },
+);
+
+__PACKAGE__->meta->make_immutable;
+
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>, L<LaTeX::TikZ::Mod>.
+
+=head1 AUTHOR
+
+Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
+
+You can contact me by mail or on C<irc.perl.org> (vincent).
+
+=head1 BUGS
+
+Please report any bugs or feature requests to C<bug-latex-tikz at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=LaTeX-TikZ>.
+I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
+
+=head1 SUPPORT
+
+You can find documentation for this module with the perldoc command.
+
+    perldoc LaTeX::TikZ
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2011 Vincent Pit, all rights reserved.
+
+This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
+
+=cut
+
+1; # End of LaTeX::TikZ::Mod::Scale