NAME

Ogre::Vector3

SYNOPSIS

use Ogre;
use Ogre::Vector3;
# (for now see examples/README.txt)

DESCRIPTION

See the online API documentation at http://www.ogre3d.org/docs/api/html/classOgre_1_1Vector3.html

Note: this Perl binding is currently experimental and subject to API changes.

CLASS METHODS

Ogre::Vector3->new(...)

Parameter types

... : this varies... (sorry, look in the .xs file)

Returns

Vector3 *

Ogre::Vector3->DESTROY()

This method is called automatically; don't call it yourself.

\&eq_xs

This is an operator overload method; don't call it yourself.

\&plus_xs

This is an operator overload method; don't call it yourself.

\&mult_xs

This is an operator overload method; don't call it yourself.

\&neg_xs

This is an operator overload method; don't call it yourself.

INSTANCE METHODS

$obj->length()

Returns

Real

$obj->squaredLength()

Returns

Real

$obj->distance($rhs)

Parameter types

$rhs : Vector3 *

Returns

Real

$obj->squaredDistance($rhs)

Parameter types

$rhs : Vector3 *

Returns

Real

$obj->dotProduct($vec)

Parameter types

$vec : Vector3 *

Returns

Real

$obj->absDotProduct($vec)

Parameter types

$vec : Vector3 *

Returns

Real

$obj->normalise()

Returns

Real

$obj->crossProduct($rkVector)

Parameter types

$rkVector : const Vector3 *

Returns

Vector3 *

$obj->midPoint($rkVector)

Parameter types

$rkVector : const Vector3 *

Returns

Vector3 *

$obj->makeFloor($cmp)

Parameter types

$cmp : Vector3 *

Returns

void

$obj->makeCeil($cmp)

Parameter types

$cmp : Vector3 *

Returns

void

$obj->perpendicular()

Returns

Vector3 *

$obj->randomDeviant($angle, $up=&Vector3::ZERO)

Parameter types

$angle : Degree (or Radian) *

$up=&Vector3::ZERO : const Vector3 *

Returns

Vector3 *

$obj->getRotationTo($dest, $fallbackAxis=&Vector3::ZERO)

Parameter types

$dest : const Vector3 *

$fallbackAxis=&Vector3::ZERO : const Vector3 *

Returns

Quaternion *

$obj->isZeroLength()

Returns

bool

$obj->normalisedCopy()

Returns

Vector3 *

$obj->reflect($normal)

Parameter types

$normal : const Vector3 *

Returns

Vector3 *

$obj->positionEquals($rhs, $tolerance=0.001)

Parameter types

$rhs : Vector3 *

$tolerance=0.001 : Real

Returns

bool

$obj->positionCloses($rhs, $tolerance=0.001)

Parameter types

$rhs : Vector3 *

$tolerance=0.001 : Real

Returns

bool

$obj->directionEquals($rhs, $tolerance)

Parameter types

$rhs : Vector3 *

$tolerance : Degree (or Radian) *

Returns

bool

$obj->x()

Returns

Real

$obj->y()

Returns

Real

$obj->z()

Returns

Real

$obj->setX($x)

Parameter types

$x : Real

Returns

void

$obj->setY($y)

Parameter types

$y : Real

Returns

void

$obj->setZ($z)

Parameter types

$z : Real

Returns

void

AUTHOR

Scott Lanning <slanning@cpan.org>

For licensing information, see README.txt .

cpanm Ogre

perl -MCPAN -e shell
install Ogre