NAME

Math::Shape::Point - a 2d point object in cartesian space with utility angle methods

DESCRIPTION

This module is designed to provide some useful 2d functions for manipulating point shapes in cartesian space. Apart from storing its location and direction and providing the usual get/set methods, the point object can rotate around another point, calculate the distance to and the angle to another point. The module uses cartesian coordinates and radians throughout.

SYNOPSIS

use Math::Shape::Point;
use Math::Trig ':pi';

my $p0 = Math::Shape::Point->new(0, 0, 0);
my $p1 = Math::Shape::Point->new(5, 5, 0);
$p0->rotateAboutPoint($p1, pip2);
$p0->getAngleToPoint($p1);
$p0->getDistanceToPoint($p1);

METHODS

new

Instantiates a new point object. Requires the x and y cartesian coordinates and the facing direction in radians.

getLocation

Returns an arrayref containing the point's location in cartesian coordinates.

setLocation

Sets the point's location in cartesian coordinates. Requires two numbers as inputs for the x and y location.

getDirection

Returns the current facing direction in radians.

setDirection

Sets the current facing direction in radians.

advance

Requires a numeric distance argument - moves the point forward that distance in Cartesian coordinates towards the direction it is facing.

rotate

Updates the point's facing direction by radians.

rotateAboutPoint

Rotates the point around another point of origin. Requires a point object and the angle in radians to rotate. This method updates the facing direction of the point object, as well as it's location.

getDistanceToPoint

Returns the distance to another point object. Requires a point object as an argument.

getAngleToPoint

Returns the angle of another point object. Requires a point as an argument.

normalizeRadian

Takes a radian argument and returns it between 0 and PI2. Negative numbers are assumed to be backwards (e.g. -1.57 == PI + PI / 2)