File Coverage

blib/lib/Geometry/Primitive/Arc.pm

Criterion	Covered	Total	%
statement	1	3	33.3
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	2	4	50.0

package Geometry::Primitive::Arc;
use Moose;
use MooseX::Storage;

with qw(Geometry::Primitive::Shape MooseX::Clone MooseX::Storage::Deferred);

use Geometry::Primitive::Point;

has 'angle_start' => (
    is => 'rw',
    isa => 'Num',
    required => 1
);
has 'angle_end' => (
    is => 'rw',
    isa => 'Num',
    required => 1
);
has 'origin' => (
    is => 'rw',
    isa => 'Geometry::Primitive::Point',
    coerce => 1
);
has 'radius' => (
    is => 'rw',
    isa => 'Num',
    required => 1
);

# Area of a sector, if it's ever needed...
# sub area {
#     my ($self) = @_;
#
#     return (($self->radius**2 * ($self->angle_end - $self->angle_start)) / 2
#     );
# }

sub get_point_at_angle {
    my ($self, $angle) = @_;

    return Geometry::Primitive::Point->new(
        x => $self->origin->x + ($self->radius * cos($angle)),
        y => $self->origin->y + ($self->radius * sin($angle))
    );
}

sub length {
    my ($self) = @_;

    return $self->radius * ($self->angle_end - $self->angle_start);
}

sub point_end {
    my ($self) = @_;

    return $self->get_point_at_angle($self->angle_end);
}

sub point_start {
    my ($self) = @_;

    return $self->get_point_at_angle($self->angle_start);
}

sub scale {
    my ($self, $amount) = @_;

    $self->radius($self->radius * $amount);
}

__PACKAGE__->meta->make_immutable;

no Moose;
1;

__END__

=head1 NAME

Geometry::Primitive::Arc - Portion of the circumference of a Circle

=head1 DESCRIPTION

Geometry::Primitive::Arc represents a closed segment of a curve.

=head1 SYNOPSIS

  use Geometry::Primitive::Arc;

  my $arc = Geometry::Primitive::Arc->new(
      angle_start => 0,
      angle_end => 1.57079633,
      radius => 15
  );

=head1 ATTRIBUTES

=head2 angle_start

The starting angle for this arc in radians.

=head2 angle_end

The ending angle for this arc in radians.

=head2 radius

Returns the radius of the arc.

=head2 origin

Set/Get the origin of this arc.

=head1 METHODS

=head2 new

Creates a new Geometry::Primitive::Arc

=head2 get_point_at_angle

Given angle in radians returns the point at that angle on this arc.  Returns
undef if the angle falls outside this arc's range.

=head2 length

Returns the length of this arc.

=head2 point_end

Get the end point.  Provided for Shape role.

=head2 point_start

Get the start point.  Provided for Shape role.

=head2 scale ($amount)

Increases the radius by multiplying it by the supplied amount.

=head1 AUTHOR

Cory Watson <[e-mail]>

=head1 COPYRIGHT & LICENSE

You can redistribute and/or modify this code under the same terms as Perl
itself.