File Coverage

blib/lib/Location/GeoTool/Direction.pm

Criterion	Covered	Total	%
statement	66	80	82.5
branch	5	16	31.2
condition	3	5	60.0
subroutine	14	16	87.5
pod	3	6	50.0
total	91	123	73.9

package Location::GeoTool::Direction;

################################################################
#
#  Geometric Functions
#  Location::GeoTool::Direction
#

use 5.008;
use strict;
use warnings;
use vars qw($VERSION);
$VERSION = 0.97;

use Location::GeoTool;
use Carp;

__PACKAGE__->_make_accessors(
    qw(from_point to_point direction distance)
);

# Constructor -- set Startpoint
sub new
{
  my $class = shift;
  $class = ref($class) if (ref($class));
  my $arg = $_[0];
  my $self = {};

  if (UNIVERSAL::isa($arg, 'Location::GeoTool'))
  {
    $self->{'from_point'} = $arg->_clone;
  }
  else
  {
    $self->{'from_point'} = Location::GeoTool->create_coord(@_);
  }
  bless $self, $class;
}

# Set direction/distance and create Endpoint
sub set_vector
{
  my $self = shift;
  my ($dir,$dist) = @_[0..1];

  $self->{'direction'} = $dir;
  $self->{'distance'} = $dist;

  $dir = _regular_dir($dir);

  my $fp = $self->from_point;
  my ($flat,$flong) = $fp->format_degree->array;
  my $fdatum = $fp->out_datum;
  my $fformat = $fp->out_format;

  my ($tlat,$tlong) = Location::GeoTool::vector2point_degree($flat,$flong,$dir,$dist,$fdatum);

  my $to_point = Location::GeoTool->create_coord($tlat,$tlong,$fdatum,'degree');
  my $meth = "format_$fformat";
  $self->{'to_point'} = ($fdatum eq 'degree') ? $to_point : $to_point->$meth;

  return $self;
}

# Set Endpoint and calcurate direction/distance
sub set_topoint
{
  my $self = shift;
  my $arg = $_[0];

  if (UNIVERSAL::isa($arg, 'Location::GeoTool'))
  {
    $self->{'to_point'} = $arg->_clone;
  }
  else
  {
    $self->{'to_point'} = Location::GeoTool->create_coord(@_);
  }

  my $fp = $self->from_point;
  my ($flat,$flong) = $fp->format_degree->array;
  my $fdatum = $fp->out_datum;

  my $meth = "datum_$fdatum";
  my ($tlat,$tlong) = $self->{'to_point'}->$meth->format_degree->array;

  my ($dir,$dist) = Location::GeoTool::point2vector_degree($flat,$flong,$tlat,$tlong,$fdatum);

  $dir = _regular_dir($dir);

  $self->{'direction'} = $dir;
  $self->{'distance'} = $dist;

  return $self;
}

# Return a new Location::GeoTool::Direction object
# rotate around Startpoint and extend distance
sub pivot
{
  my $self = shift;
  croak "Please set End-point before call this method!!" unless ($self->to_point);
  my ($rot,$pow) = @_;

  my $dir = $self->direction + $rot;
  my $dist = $self->distance * $pow;

  if ($dist < 0)
  {
    $dir += 180;
    $dist = abs($dist);
  }

  return $self->new($self->from_point)->set_vector(_regular_dir($dir),$dist);
}

# Return a new Location::GeoTool::Direction object
# reverse between Startpoint and Endpoint
sub reverse
{
  my $self = shift;
  croak "Please set End-point before call this method!!" unless ($self->to_point);

  return $self->new($self->to_point)->set_topoint($self->from_point);
}

# Return the name of direction
sub dir_string
{
  return Location::GeoTool::direction_string(_regular_dir($_[0]->direction),$_[1] || 16,$_[2]);
}

# Normalize direction 0-360
sub _regular_dir
{
  my $dir = $_[0];
  while ($dir < 0 || $dir >= 360)
  {
    $dir += $dir < 0 ? 360 : -360;
  }
  return $dir;
}

sub _make_accessors
{
  my($class, @attr) = @_;
  for my $attr (@attr) {
    no strict 'refs';
    *{"$class\::$attr"} = sub { shift->{$attr} };
  }
}

1;
__END__