=head1 NAME
-LaTeX::TikZ::Set::Polyline - A set object representing a line.
+LaTeX::TikZ::Set::Polyline - A set object representing a possibly closed path composed of contiguous lines.
=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 Any::Moose 'Util::TypeConstraints';
-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';
subtype 'LaTeX::TikZ::Set::Polyline::Vertices'
=> as 'ArrayRef[LaTeX::TikZ::Set::Point]'
=> from 'ArrayRef[Any]'
=> via { [ map LaTeX::TikZ::Set::Point->new(point => $_), @$_ ] };
+=head1 ATTRIBUTES
+
+=head2 C<points>
+
+The list of the successive vertices of the path.
+
+=cut
+
has '_points' => (
is => 'ro',
isa => 'LaTeX::TikZ::Set::Polyline::Vertices',
sub points { @{$_[0]->_points} }
+=head2 C<closed>
+
+A boolean that indicates whether the path is closed or not.
+
+=cut
+
has 'closed' => (
is => 'ro',
isa => 'Bool',
default => 0,
);
+=head1 METHODS
+
+=head2 C<path>
+
+=cut
+
sub path {
my $set = shift;
($set->closed ? 'cycle' : ());
}
-use LaTeX::TikZ::Interface polyline => sub {
- shift;
+=head2 C<begin>
- __PACKAGE__->new(points => \@_);
-};
+=cut
-use LaTeX::TikZ::Interface closed_polyline => sub {
- shift;
+sub begin {
+ my $set = shift;
+
+ my @points = $set->points;
+ return undef unless @points;
+
+ $points[0]->begin;
+}
+
+=head2 C<end>
+
+=cut
+
+sub end {
+ my $set = shift;
- __PACKAGE__->new(points => \@_, closed => 1);
-};
+ my @points = $set->points;
+ return undef unless @points;
+
+ $points[-1]->end;
+}
+
+LaTeX::TikZ::Interface->register(
+ polyline => sub {
+ shift;
+
+ __PACKAGE__->new(points => \@_);
+ },
+ closed_polyline => sub {
+ shift;
+
+ __PACKAGE__->new(points => \@_, closed => 1);
+ },
+);
LaTeX::TikZ::Functor->default_rule(
(__PACKAGE__) => sub {
__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>.