view release on metacpan or  search on metacpan

lib/Algorithm/Shape/RandomTree/Branch.pm  view on Meta::CPAN

package Algorithm::Shape::RandomTree::Branch;

use Moose;

use Algorithm::Shape::RandomTree::Branch::Point;

has 'name' => ( is => 'ro', isa => 'Str' );

has [ 'start_point', 'end_point'  ] => ( 
    is => 'ro',
    isa => 'Algorithm::Shape::RandomTree::Branch::Point' 
);

# Deltas: the difference between start and end x and y coordinates
# reflecting the slope of the branch
has [ 'dx', 'dy' ] => ( is => 'ro', isa => 'Int' );

# Level in which this branch stands in a linearly created tree
has 'level' => ( is => 'ro', isa => 'Int' );

# Line thickness
has 'width' => ( is => 'ro', isa => 'Int' );

# Contains a reference to the parent branch
has 'parent' => ( is => 'ro', isa => 'Ref' );

# Nodulation: is the attribute that determins whether this branch will
#             continue to create sub-branches
# Complexity: is the number of sub-branches this branch has if nodulation
#             is > 0 (otherwise, no new branches will be created on this 
#             branch, even if it's complexity is > 0
has [ 'nodulation', 'complexity' ] => ( is => 'ro', isa => 'Int' );

# The SVG string representaiton of the params required to create a curved path,
# which will represent the branch's geometry
has 'path_string' => ( is => 'ro', isa => 'Str' );

1;

__END__

=head1 NAME

Algorithm::Shape::RandomTree::Branch - This object contains the attributes necessary to generate a branch, using
the functions on Algorithm::Shape::RandomTree.

Meant to be used as part of the Algorithm::Shape::RandomTree module and
not really useful on it's own.

=head1 VERSION

Version 0.01

=head1 SYNOPSIS

    use Algorithm::Shape::RandomTree::Branch;

    my $parent = $tree->branches('b1');  # The parent of the next branch

    my $branch = Algorithm::Shape::RandomTree->new(
        name        => 'b2',
        start_point => $parent->end_point, 
        end_point   => $end_point,   # Obj: Algorithm::Shape::RandomTree::Branch::Point
        dy          => 5,
        dx          => 5,
        level       => ( $parent->level + 1 ),
        width       => ( $parent->width - 1 ),
        nodulation  => ( $parent->nodulation - 1),
        complexity  => ( $parent->complexity),
        path_string => "M $x1 $y1 C 3 3 2 2 $x2 $y2";   # SVG path string
    );

=head1 Attributes

=head2 name

=head2 start_point

A Algorithm::Shape::RandomTree::Branch::Point object

=head2 end_point

A Algorithm::Shape::RandomTree::Branch::Point object

=head2 dy

=head2 dx

=head2 level

=head2 width

=head2 nodulation

See in Algorithm::Shape::RandomTree

=head2 complexity

See in Algorithm::Shape::RandomTree

=head2 path_string

=head1 AUTHOR

Tamir Lousky, C<< <tlousky at cpan.org> >>

=head1 BUGS

Please report any bugs or feature requests to C<bug-algorithm-shape-randomtree at rt.cpan.org>, or through
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Algorithm-Shape-RandomTree>.  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 Algorithm::Shape::RandomTree


You can also look for information at:

=over 4

=item * RT: CPAN's request tracker

L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Algorithm-Shape-RandomTree>

=item * AnnoCPAN: Annotated CPAN documentation