thothbot.parallax.core.shared.math

Class Vector3

java.lang.Object

thothbot.parallax.core.shared.math.Vector2

thothbot.parallax.core.shared.math.Vector3

Direct Known Subclasses:

Vector4

public class Vector3
extends Vector2

This class is realization of (X, Y, Z) vector. Where: X - x coordinate of the vector. Y - y coordinate of the vector. Z - z coordinate of the vector.

Author:

thothbot

Constructor Summary

Constructors

Constructor and Description
Vector3() This default constructor will initialize vector (0, 0, 0);
Vector3(double x, double y, double z) This constructor will initialize vector (X, Y, Z) from the specified X, Y, Z coordinates.

Method Summary

Modifier and Type	Method and Description
Vector3	add(double s)
Vector3	add(Vector3 v)
Vector3	add(Vector3 v1, Vector3 v2)
void	addZ(double z) This method will add specified value to Z coordinate of the vector.
double	angleTo(Vector3 v)
Vector3	apply(Matrix3 m)
Vector3	apply(Matrix4 m)
Vector3	apply(Quaternion q)
Vector3	applyAxisAngle(Vector3 axis, double angle)
Vector3	applyEuler(Euler euler)
Vector3	applyProjection(Matrix4 m)
Vector3	ceil()
Vector3	clamp(double minVal, double maxVal)
Vector3	clamp(Vector3 min, Vector3 max) This function assumes min < max, if this assumption isn't true it will not operate correctly
Vector3	clone()
Vector3	copy(Vector3 v) Set value of the vector from another vector.
Vector3	cross(Vector3 v)
Vector3	cross(Vector3 a, Vector3 b) Sets this vector to be the vector cross product of vectors v1 and v2.
double	distanceTo(Vector3 v1)
double	distanceToSquared(Vector3 v1)
Vector3	divide(double scalar)
Vector3	divide(Vector3 v)
Vector3	divide(Vector3 v1, Vector3 v2)
double	dot(Vector3 v1) Computes the dot product of this vector and vector v1.
boolean	equals(Vector3 v1) Returns true if all of the data members of v1 are equal to the corresponding data members in this Vector3.
Vector3	floor()
Vector3	fromArray(Float32Array array)
Vector3	fromArray(Float32Array array, int offset)
double	getComponent(int index)
double	getZ() get Z coordinate from the vector
double	length() Returns the length of this vector.
double	lengthManhattan()
double	lengthSq() Returns the squared length of this vector.
Vector3	lerp(Vector3 v1, double alpha)
Vector3	max(Vector3 v)
Vector3	min(Vector3 v)
Vector3	multiply(double s)
Vector3	multiply(Vector3 v)
Vector3	multiply(Vector3 v1, Vector3 v2)
Vector3	negate() Negates the value of this vector in place.
Vector3	normalize() Normalizes this vector in place.
Vector3	project(Camera camera)
Vector3	projectOnPlane(Vector3 planeNormal)
Vector3	projectOnVector(Vector3 vector)
Vector3	reflect(Vector3 normal) reflect incident vector off plane orthogonal to normal normal is assumed to have unit length
Vector3	round()
Vector3	roundToZero()
Vector3	set(double a) Set value of the vector to the specified (A, A, A) coordinates.
Vector3	set(double x, double y, double z) Set value of the vector to the specified (X, Y, Z) coordinates.
void	setComponent(int index, double value)
Vector3	setFromMatrixColumn(int index, Matrix4 matrix)
Vector3	setFromMatrixPosition(Matrix4 m)
Vector3	setFromMatrixScale(Matrix4 m)
Vector3	setLength(double l)
void	setZ(double z) This method sets Z coordinate of the vector.
Vector3	sub(Vector3 v)
Vector3	sub(Vector3 v1, Vector3 v2)
Float32Array	toArray()
Float32Array	toArray(Float32Array array, int offset)
java.lang.String	toString()
Vector3	transformDirection(Matrix4 m)
Vector3	unproject(Camera camera)

Methods inherited from class thothbot.parallax.core.shared.math.Vector2

add, add, addX, addY, clamp, copy, distanceTo, distanceToSquared, divide, divide, dot, equals, getX, getY, isZero, lerp, max, min, multiply, multiply, set, setX, setY, sub, sub

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Vector3

public Vector3()

This default constructor will initialize vector (0, 0, 0);

Vector3

public Vector3(double x,
               double y,
               double z)

This constructor will initialize vector (X, Y, Z) from the specified X, Y, Z coordinates.

Parameters:

x - the X coordinate

y - the Y coordinate

z - the Z coordinate

Method Detail

getZ

public double getZ()

get Z coordinate from the vector

Returns:

a Z coordinate

addZ

public void addZ(double z)

This method will add specified value to Z coordinate of the vector. In another words: z += value.

Parameters:

z - the Y coordinate

setZ

public void setZ(double z)

This method sets Z coordinate of the vector.

Parameters:

z - the Z coordinate

set

public Vector3 set(double x,
                   double y,
                   double z)

Set value of the vector to the specified (X, Y, Z) coordinates.

Parameters:

x - the X coordinate

y - the Y coordinate

z - the Z coordinate

set

public Vector3 set(double a)

Set value of the vector to the specified (A, A, A) coordinates.

Parameters:

a - the X, Y and Z coordinate

setComponent

public void setComponent(int index,
                         double value)

Overrides:

setComponent in class Vector2

getComponent

public double getComponent(int index)

Overrides:

getComponent in class Vector2

copy

public Vector3 copy(Vector3 v)

Set value of the vector from another vector.

Parameters:

v - the other vector

Returns:

the current vector

add

public Vector3 add(Vector3 v)

add

public Vector3 add(Vector3 v1,
                   Vector3 v2)

add

public Vector3 add(double s)

Overrides:

add in class Vector2

sub

public Vector3 sub(Vector3 v)

sub

public Vector3 sub(Vector3 v1,
                   Vector3 v2)

multiply

public Vector3 multiply(Vector3 v)

multiply

public Vector3 multiply(Vector3 v1,
                        Vector3 v2)

multiply

public Vector3 multiply(double s)

Overrides:

multiply in class Vector2

applyEuler

public Vector3 applyEuler(Euler euler)

applyAxisAngle

public Vector3 applyAxisAngle(Vector3 axis,
                              double angle)

apply

public Vector3 apply(Matrix3 m)

apply

public Vector3 apply(Matrix4 m)

Parameters:

m - Matrix4 affine matrix

Returns:

applyProjection

public Vector3 applyProjection(Matrix4 m)

Parameters:

m - the Matrix4 projection matrix

Returns:

apply

public Vector3 apply(Quaternion q)

project

public Vector3 project(Camera camera)

unproject

public Vector3 unproject(Camera camera)

transformDirection

public Vector3 transformDirection(Matrix4 m)

Parameters:

m - Matrix4 affine matrix vector interpreted as a direction

Returns:

divide

public Vector3 divide(Vector3 v)

divide

public Vector3 divide(Vector3 v1,
                      Vector3 v2)

divide

public Vector3 divide(double scalar)

Overrides:

divide in class Vector2

min

public Vector3 min(Vector3 v)

max

public Vector3 max(Vector3 v)

clamp

public Vector3 clamp(Vector3 min,
                     Vector3 max)

This function assumes min < max, if this assumption isn't true it will not operate correctly

clamp

public Vector3 clamp(double minVal,
                     double maxVal)

Overrides:

clamp in class Vector2

floor

public Vector3 floor()

Overrides:

floor in class Vector2

ceil

public Vector3 ceil()

Overrides:

ceil in class Vector2

round

public Vector3 round()

Overrides:

round in class Vector2

roundToZero

public Vector3 roundToZero()

Overrides:

roundToZero in class Vector2

negate

public Vector3 negate()

Description copied from class: Vector2

Negates the value of this vector in place.

Overrides:

negate in class Vector2

dot

public double dot(Vector3 v1)

Computes the dot product of this vector and vector v1.

Parameters:

v1 - the other vector

Returns:

the dot product of this vector and v1

lengthSq

public double lengthSq()

Returns the squared length of this vector.

Overrides:

lengthSq in class Vector2

Returns:

the squared length of this vector

length

public double length()

Returns the length of this vector.

Overrides:

length in class Vector2

Returns:

the length of this vector

lengthManhattan

public double lengthManhattan()

normalize

public Vector3 normalize()

Normalizes this vector in place.

Overrides:

normalize in class Vector2

setLength

public Vector3 setLength(double l)

Overrides:

setLength in class Vector2

lerp

public Vector3 lerp(Vector3 v1,
                    double alpha)

cross

public Vector3 cross(Vector3 a,
                     Vector3 b)

Sets this vector to be the vector cross product of vectors v1 and v2.

Parameters:

a - the first vector

b - the second vector

cross

public Vector3 cross(Vector3 v)

projectOnVector

public Vector3 projectOnVector(Vector3 vector)

projectOnPlane

public Vector3 projectOnPlane(Vector3 planeNormal)

reflect

public Vector3 reflect(Vector3 normal)

reflect incident vector off plane orthogonal to normal normal is assumed to have unit length

Parameters:

normal -

Returns:

angleTo

public double angleTo(Vector3 v)

distanceTo

public double distanceTo(Vector3 v1)

distanceToSquared

public double distanceToSquared(Vector3 v1)

setFromMatrixPosition

public Vector3 setFromMatrixPosition(Matrix4 m)

setFromMatrixScale

public Vector3 setFromMatrixScale(Matrix4 m)

setFromMatrixColumn

public Vector3 setFromMatrixColumn(int index,
                                   Matrix4 matrix)

equals

public boolean equals(Vector3 v1)

Returns true if all of the data members of v1 are equal to the corresponding data members in this Vector3.

Parameters:

v1 - the vector with which the comparison is made

Returns:

true or false

fromArray

public Vector3 fromArray(Float32Array array)

Overrides:

fromArray in class Vector2

fromArray

public Vector3 fromArray(Float32Array array,
                         int offset)

Overrides:

fromArray in class Vector2

toArray

public Float32Array toArray()

Overrides:

toArray in class Vector2

toArray

public Float32Array toArray(Float32Array array,
                            int offset)

Overrides:

toArray in class Vector2

clone

public Vector3 clone()

Overrides:

clone in class Vector2

toString

public java.lang.String toString()

Overrides:

toString in class Vector2