NAME

Math::Vec3 - Perl class to represent rotations

HIERARCHY

-+- Math::Vec3

SEE ALSO

Math::Color, Math::Image, Math::Vec2, Math::Vec3, Math::Rotation Math::Quaternion

SYNOPSIS

use Math::Vec3;
my $v = new Math::Vec3;  # Make a new vec3

my $v1 = new Math::Vec3(0,1,0);

DESCRIPTION

METHODS

new

my $v = new Math::Vec3; 					  
my $v1 = new Math::Vec3($v);   
my $v2 = new Math::Vec3(1,2,3);   
my $v3 = new Math::Vec3([1,2,3]); 

copy

Makes a copy of the rotation

$v2 = $v1->copy;
$v2 = new Math::Vec3($v1);

setValue(x,y,z)

Sets the value of the vector

$v1->setValue(1,2,3);

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;

setZ(z)

Sets the third value of the vector

$v1->setZ(3);

$v1->z   = 3;
$v1->[2] = 3;

getValue

Returns the @value of the vector

@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];

z

getZ

Returns the third value of the vector

$z = $v1->getZ;
$z = $v1->z;
$z = $v1->[2];

negate

$v = $v1->negate;
$v = -$v1;

add(vec3)

$v = $v1->add($v2);
$v = $v1 + $v2;
$v1 += $v2;

subtract(vec3)

$v = $v1->subtract($v2);
$v = $v1 - $v2;
$v1 -= $v2;

multiply(scalar)

$v = $v1->multiply($v2);

$v = $v1->multiply(2);
$v = $v1 * 2;
$v1 *= 2;

divide(scalar)

$v = $v1->divide($v2);

$v = $v1->divide(2);
$v = $v1 / 2;
$v1 /= 2;

dot(vec3)

$s = $v1->dot($v2);
$s = $v1 . $v2;
$s = $v1 . [ 2, 3, 4 ];

cross(vec3)

$v = $v1->cross($v2);
$v = $v1 x $v2;
$v = $v1 x [ 2, 3, 4 ];

length

Returns the length of the vector

$l = $v1->length;

normalize

$v = $v1->normalize;

eq(vec3)

my $bool = $v1->eq($v2);
my $bool = $v1 eq $v2;
my $bool = $v1 == $v2;

ne(vec3)

my $bool = $v1->ne($v2);
my $bool = $v1 ne $v2;
my $bool = $v1 != $v2;

stringify

Returns a string representation of the vector. This is used to overload the '""' operator, so that vector may be freely interpolated in strings.

my $v = new Math::Vec3(1,2,3,4);
print $v->stringify;                # "1 2 3"
print "$v";                         # "1 2 3"