NAME
Math::Vec2 - Perl class to represent 2d vectors
TREE
-+- Math::Vec2
SEE ALSO
Math::Color, Math::Image, Math::Vec2, Math::Vec3, Math::Rotation
SYNOPSIS
use Math::Vec2;
my $v = new Math::Vec2; # Make a new Vec2
my $v1 = new Math::Vec2(0,1);DESCRIPTION
DefaultValue
0 0OPERATORS
Overview
'abs' => abs
'~' => reverse
'>>' => rotate
'<<' => rotate
'bool' => length
'eq' => eq
'==' => eq
'ne' => ne
'!=' => ne
'neg' => negate
'+=' => add
'-=' => subtract
'*=' => multiply
'/=' => divide
'+' => add
'-' => subtract
'*' => multiply
'/' => divide
'.' => dot
'""' => toString~
Returns the reverse of this vector.
my $v = new Math::Vec2(1,2);
printf "2 1 = %s\n", ~$v; # swap components
printf "1 2 = %s\n", ~~$v;<<
Performs a counter-clockwise rotation of the components. Very similar to bitwise left-shift.
my $v = new Math::Vec2(1,2);
printf "2 1 = %s\n", $v << 1;
printf "1 2 = %s\n", $v << 2;>>
Performs a clockwise rotation of the components. Very similar to bitwise right-shift.
my $v = new Math::Vec2(1,2);
printf "2 1 = %s\n", $v >> 1;
printf "1 2 = %s\n", $v >> 2;METHODS
DefaultValue
Get the default value as array ref
$default = $v1->DefaultValue;
@default = @{ Math::Vec2->DefaultValue };
$n = @{ Math::Vec2->DefaultValue };new
my $v = new Math::Vec2;
my $v2 = new Math::Vec2(1,2);
my @v3 = @$v; If you call new() with a reference to an array, it will be used as reference.
my $v3 = new Math::Vec2([1,2]); copy
Makes a copy
$v2 = $v1->copy;setValue(x,y,z)
Sets the value of the vector
$v1->setValue(1,2);setX(x)
Sets the first value of the vector
$v1->setX(1);
$v1->x = 1;
$v1->[0] = 1;setY(y)
Sets the second value of the vector
$v1->setY(2);
$v1->y = 2;
$v1->[1] = 2;getArray ()
Returns the reference to the array that represents this vector.
$v = $vec2->getArray;getValue
Returns the value of the vector (x, y) as a 2 components array.
@v = $v1->getValue;x
getX
Returns the first value of the vector.
$x = $v1->getX;
$x = $v1->x;
$x = $v1->[0];y
getY
Returns the second value of the vector.
$y = $v1->getY;
$y = $v1->y;
$y = $v1->[1];eq(vec2)
my $bool = $v1->eq($v2);
my $bool = $v1 eq $v2;
my $bool = $v1 == $v2;ne(vec2)
my $bool = $v1->ne($v2);
my $bool = $v1 ne $v2;
my $bool = $v1 != $v2;negate
$v = $v1->negate;
$v = -$v1;add(vec2)
$v = $v1->add($v2);
$v = $v1 + $v2;
$v1 += $v2;subtract(vec2)
$v = $v1->subtract($v2);
$v = $v1 - $v2;
$v1 -= $v2;multiply(scalar)
multiply(vec2)
$v = $v1->multiply(2);
$v = $v1 * 2;
$v1 *= 2;divide(scalar)
divide(vec2)
$v = $v1->divide(2);
$v = $v1 / 2;
$v1 /= 2;dot(vec2)
$s = $v1->dot($v2);
$s = $v1 . $v2;
$s = $v1 . [ 2, 3 ];length
Returns the length of the vector
$l = $v1->length;normalize
$v = $v1->normalize;abs()
Performs a componentwise abs. This is used to overload the 'abs' operator.
$v = $vec2->abs;reverse()
Returns the reverse of this vector. This is used to overload the '~' operator.
$v = $vec2->reverse;rotate(n)
Performs a componentwise rotation. This is used to overload the '>>' and '<<' operator.
$v = $vec2->rotate(1); # swap
$v = $vec2->rotate(2); # eqtoString
Returns a string representation of the vector. This is used to overload the '""' operator, so that vector may be freely interpolated in strings.
my $q = new Math::Vec2(1,2);
print $q->toString; # "1 2"
print "$q"; # "1 2"SEE ALSO
Math::Color, Math::Image, Math::Vec2, Math::Vec3, Math::Rotation
BUGS & SUGGESTIONS
If you run into a miscalculation, need some sort of feature or an additional holiday, or if you know of any new changes to the funky math, please drop the author a note.
ARRANGED BY
Holger Seelig holger.seelig@yahoo.de
COPYRIGHT
This is free software; you can redistribute it and/or modify it under the same terms as Perl itself.