Class Vector3d

java.lang.Object

net.risingworld.api.utils.Vector3d

All Implemented Interfaces:

Serializable

public class Vector3d
extends Object
implements Serializable

A Vector which holds three double values: X, Y and Z
It can be used to represent a three dimensional value, like a position or a direction.

Note that this explicitly uses 64 bit values (double precision). For regular calculations you should use Vector3f instead!

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Vector3d	BACK	A unit vector along the -Z axis (backward direction)
static final Vector3d	DOWN	A unit vector along the -Y axis (down direction)
static final Vector3d	FORWARD	A unit vector along the Z axis (forward direction)
static final Vector3d	LEFT	A unit vector along the -X axis (left direction)
static final Vector3d	ONE	A vector with values 1, 1, 1
static final Vector3d	RIGHT	A unit vector along the X axis (right direction)
static final Vector3d	UP	A unit vector along the Y axis (up direction)
double	x	The X value of this vector
double	y	The Y value of this vector
double	z	The Z value of this vector
static final Vector3d	ZERO	A vector with values 0, 0, 0

Constructor Summary

Constructors

Constructor	Description
Vector3d()	Creates a new vector with default values 0, 0, 0.
Vector3d(double x, double y, double z)	Creates a new vector with the provided values.
Vector3d(Vector3d copy)	Creates a new vector and copies the X, Y and Z values from the provided vector.
Vector3d(Vector3f copy)	Creates a new vector and copies the X, Y and Z values from the provided vector.

Method Summary

Modifier and Type	Method	Description
Vector3d	add(double addX, double addY, double addZ)	Creates a new vector with the same values of this vector and adds the provided values.
Vector3d	add(Vector3d other)	Creates a new vector with the same values of this vector and adds the values of the provided vector.
Vector3d	addLocal(double addX, double addY, double addZ)	Adds the provided values to the values of this vector.
Vector3d	addLocal(Vector3d other)	Adds the values of the provided vector to the values of this vector.
double	angleBetween(Vector3d other)	Gets the angle between this vector and another vector.
Vector3d	copy()	Creates a copy of this vector.
Vector3d	cross(Vector3d other)	Creates a new vector containing the cross product of this vector and another vector.
Vector3d	crossLocal(double v2x, double v2y, double v2z)	Calculates the cross product of this vector and the provided coordinates.
Vector3d	crossLocal(Vector3d other)	Calculates the cross product of this vector and another vector.
double	distance(double x, double y, double z)	Gets the distance between this vector and the provided coordinates.
double	distance(Vector3d other)	Gets the distance between this vector and another vector.
double	distanceSquared(double x, double y, double z)	Gets the squared distance between this vector and the provided coordinates.
double	distanceSquared(Vector3d other)	Gets the squared distance between this vector and another Vector3d.
Vector3d	divide(Vector3d other)	Creates a new vector with the same values of this vector and divides the values of the provided vector.
Vector3d	divideLocal(double scalar)
Vector3d	divideLocal(Vector3d other)
double	dot(double x, double y, double z)	Gets the dot product of this vector with the provided coordinates.
double	dot(Vector3d other)	Gets the dot product of this vector with the provided vector.
boolean	equals(double x, double y, double z)
boolean	equals(Object o)	Gets whether or not this vector is equal to another object.
Vector3d	fromString(String input)
double	getX()	Returns the x value of this vector.
double	getY()	Returns the y value of this vector.
double	getZ()	Returns the z value of this vector.
int	hashCode()	Gets a unique* hash code for this vector, based on its values.
Vector3d	interpolate(Vector3d startVector, Vector3d finalVector, double mu)	Creates a new vector containing the interpolated values between the start vector and the final vector.
Vector3d	interpolateLocal(Vector3d finalVector, double mu)	Interpolates this vector to the provided final vector, e.g if this vector is (0, 5, 10), and the final vector is (-10, 0, 10), the result (by using a mu-value of 0.5d) would be (-5, 2.5, 10)
Vector3d	interpolateLocal(Vector3d startVector, Vector3d finalVector, double mu)	Interpolates between the provided start and end vector and stores the result in this vector.
boolean	isOrthogonal(double x, double y, double z)	Checks if this vector is orthogonal to another vector (i.e the angle between both vectors is ~ 90° degree).
boolean	isOrthogonal(Vector3d other)	Checks if this vector is orthogonal to another vector (i.e the angle between both vectors is ~ 90° degree).
boolean	isUnitVector()	Checks if this vector is a unit vector.
double	length()	Gets the length of this vector.
double	lengthSquared()	Gets the squared length of this vector.
Vector3d	mult(double scalar)	Creates a new vector with the same values of this vector and multiplies them with the provided scalar.
Vector3d	mult(double multX, double multY, double multZ)	Creates a new vector with the same values of this vector and multiplies the provided values.
Vector3d	mult(Vector3d other)	Creates a new vector with the same values of this vector and multiplies the values of the provided vector.
Vector3d	multLocal(double scalar)	Multiplies the values of this vector with the provided scalar.
Vector3d	multLocal(double multX, double multY, double multZ)	Multiplies the values of this vector with the provided values.
Vector3d	multLocal(Vector3d other)	Multiplies the values of this vector with the values of the provided vector.
Vector3d	negate()	Creates a new vector which contains negated values of this vector.
Vector3d	negateLocal()	Negates all values of this vector.
Vector3d	normalize()	Creates a new vector containing normalized values of this vector (i.e as a unit vector).
Vector3d	normalizeLocal()	Normalizes this vector (i.e turn it into a unit vector).
Vector3d	set(double x, double y, double z)	Sets the x, y and z values of this vector to the provided values.
Vector3d	set(Vector3d vector)	Sets the x, y and z values of this vector to the values of the provided vector.
Vector3d	set(Vector3f vector)	Sets the x, y and z values of this vector to the values of the provided vector.
Vector3d	setX(double x)	Sets the x value of this vector.
Vector3d	setY(double y)	Sets the y value of this vector.
Vector3d	setZ(double z)	Sets the z value of this vector.
Vector3d	subtract(double subtractX, double subtractY, double subtractZ)	Creates a new vector with the same values of this vector and subtracts the provided values.
Vector3d	subtract(Vector3d other)	Creates a new vector with the same values of this vector and subtracts the values of the provided vector.
Vector3d	subtractLocal(double subtractX, double subtractY, double subtractZ)	Subtracts the provided values from the values of this vector.
Vector3d	subtractLocal(Vector3d other)	Subtracts the values of the provided vector from the values of this vector.
String	toString()	Gets a String representation of this vector, for example (4.0, 5.25, 10.998)

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ZERO

public static final Vector3d ZERO

A vector with values 0, 0, 0

ONE

public static final Vector3d ONE

A vector with values 1, 1, 1

RIGHT

public static final Vector3d RIGHT

A unit vector along the X axis (right direction)

LEFT

public static final Vector3d LEFT

A unit vector along the -X axis (left direction)

UP

public static final Vector3d UP

A unit vector along the Y axis (up direction)

DOWN

public static final Vector3d DOWN

A unit vector along the -Y axis (down direction)

FORWARD

public static final Vector3d FORWARD

A unit vector along the Z axis (forward direction)

BACK

public static final Vector3d BACK

A unit vector along the -Z axis (backward direction)

x

public double x

The X value of this vector

y

public double y

The Y value of this vector

z

public double z

The Z value of this vector

Constructor Details

Vector3d

public Vector3d()

Creates a new vector with default values 0, 0, 0.

Vector3d

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

Creates a new vector with the provided values.

Parameters:

x - the x value of the vector.

y - the y value of the vector.

z - the z value of the vector.

Vector3d

public Vector3d(Vector3d copy)

Creates a new vector and copies the X, Y and Z values from the provided vector.

Parameters:

copy - the Vector3d to copy.

Vector3d

public Vector3d(Vector3f copy)

Creates a new vector and copies the X, Y and Z values from the provided vector.

Parameters:

copy - the Vector3f to copy.

Method Details

copy

public Vector3d copy()

Creates a copy of this vector.

Returns:

a new instance with the same values of this vector.

set

public Vector3d set(Vector3d vector)

Sets the x, y and z values of this vector to the values of the provided vector.

Parameters:

vector - the Vector3d to copy.

Returns:

this vector.

set

public Vector3d set(Vector3f vector)

Sets the x, y and z values of this vector to the values of the provided vector.

Parameters:

vector - the Vector3f to copy.

Returns:

this vector.

set

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

Sets the x, y and z values of this vector to the provided values.

Parameters:

x - the x value.

y - the y value.

z - the z value.

Returns:

this vector.

setX

public Vector3d setX(double x)

Sets the x value of this vector.

Parameters:

x - the new x value.

Returns:

this vector.

setY

public Vector3d setY(double y)

Sets the y value of this vector.

Parameters:

y - the new y value.

Returns:

this vector.

setZ

public Vector3d setZ(double z)

Sets the z value of this vector.

Parameters:

z - the new z value.

Returns:

this vector.

getX

public double getX()

Returns the x value of this vector.

Returns:

the current x value.

getY

public double getY()

Returns the y value of this vector.

Returns:

the current y value.

getZ

public double getZ()

Returns the z value of this vector.

Returns:

the current z value.

dot

public double dot(Vector3d other)

Gets the dot product of this vector with the provided vector.

Parameters:

other - the vector to calculate the dot product with.

Returns:

the resulting dot product.

dot

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

Gets the dot product of this vector with the provided coordinates.

Parameters:

x - the x coordinate.

y - the y coordinate.

z - the z coordinate.

Returns:

the resulting dot product.

length

public double length()

Gets the length of this vector.

Returns:

the length of this vector.

See Also:

• lengthSquared()

lengthSquared

public double lengthSquared()

Gets the squared length of this vector. Use this function to avoid calculating the squareroot.

Returns:

the squared length of this vector.

See Also:

• length()

distance

public double distance(Vector3d other)

Gets the distance between this vector and another vector.

Parameters:

other - the other vector.

Returns:

the distance between this vector and another vector.

See Also:

• distanceSquared(Vector3d)

distance

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

Gets the distance between this vector and the provided coordinates.

Parameters:

x - the other x coordinate.

y - the other y coordinate.

z - the other z coordinate.

Returns:

the distance between this vector and the provided coordinates.

See Also:

• distanceSquared(double, double, double)

distanceSquared

public double distanceSquared(Vector3d other)

Gets the squared distance between this vector and another Vector3d. Use this function to avoid calculating the squareroot.

Parameters:

other - the other Vector3d.

Returns:

the squared distance between this vector and the provided Vector3d.

distanceSquared

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

Gets the squared distance between this vector and the provided coordinates. Use this function to avoid calculating the squareroot.

Parameters:

x - the other x coordinate.

y - the other y coordinate.

z - the other z coordinate.

Returns:

the squared distance between this vector and the provided coordinates.

add

public Vector3d add(Vector3d other)

Creates a new vector with the same values of this vector and adds the values of the provided vector. Same as new Vector3d(this).addLocal(other);

Parameters:

other - the vector to add.

Returns:

the newly created vector.

add

public Vector3d add(double addX,
 double addY,
 double addZ)

Creates a new vector with the same values of this vector and adds the provided values. Same as new Vector3d(this).addLocal(x, y, z);

Parameters:

addX - the x value to add.

addY - the y value to add.

addZ - the z value to add.

Returns:

the newly created vector.

addLocal

public Vector3d addLocal(Vector3d other)

Adds the values of the provided vector to the values of this vector.

Parameters:

other - the vector to add.

Returns:

this vector.

addLocal

public Vector3d addLocal(double addX,
 double addY,
 double addZ)

Adds the provided values to the values of this vector.

Parameters:

addX - the x value to add.

addY - the y value to add.

addZ - the z value to add.

Returns:

this vector.

subtract

public Vector3d subtract(Vector3d other)

Creates a new vector with the same values of this vector and subtracts the values of the provided vector. Same as new Vector3d(this).subtractLocal(other);

Parameters:

other - the vector to subtract.

Returns:

the newly created vector.

subtract

public Vector3d subtract(double subtractX,
 double subtractY,
 double subtractZ)

Creates a new vector with the same values of this vector and subtracts the provided values. Same as new Vector3d(this).subtractLocal(x, y, z);

Parameters:

subtractX - the x value to subtract.

subtractY - the y value to subtract.

subtractZ - the z value to subtract.

Returns:

the newly created vector.

subtractLocal

public Vector3d subtractLocal(Vector3d other)

Subtracts the values of the provided vector from the values of this vector.

Parameters:

other - the vector to subtract.

Returns:

this vector.

subtractLocal

public Vector3d subtractLocal(double subtractX,
 double subtractY,
 double subtractZ)

Subtracts the provided values from the values of this vector.

Parameters:

subtractX - the x value to subtract.

subtractY - the y value to subtract.

subtractZ - the z value to subtract.

Returns:

this vector.

mult

public Vector3d mult(double scalar)

Creates a new vector with the same values of this vector and multiplies them with the provided scalar.

Parameters:

scalar - the value to multiply the vector by.

Returns:

the newly created vector.

mult

public Vector3d mult(Vector3d other)

Creates a new vector with the same values of this vector and multiplies the values of the provided vector. Same as new Vector3d(this).multLocal(other);

Parameters:

other - the vector to multiply.

Returns:

the newly created vector.

mult

public Vector3d mult(double multX,
 double multY,
 double multZ)

Creates a new vector with the same values of this vector and multiplies the provided values. Same as new Vector3d(this).multLocal(x, y, z);

Parameters:

multX - the x value to multiply.

multY - the y value to multiply.

multZ - the z value to multiply.

Returns:

the newly created vector.

multLocal

public Vector3d multLocal(double scalar)

Multiplies the values of this vector with the provided scalar.

Parameters:

scalar - the value to multiply this vector by.

Returns:

this vector.

multLocal

public Vector3d multLocal(Vector3d other)

Multiplies the values of this vector with the values of the provided vector.

Parameters:

other - the vector to multiply.

Returns:

this vector.

multLocal

public Vector3d multLocal(double multX,
 double multY,
 double multZ)

Multiplies the values of this vector with the provided values.

Parameters:

multX - the x value to multiply the x coordinate of this vector by.

multY - the y value to multiply the y coordinate of this vector by.

multZ - the z value to multiply the z coordinate of this vector by.

Returns:

this vector.

divide

public Vector3d divide(Vector3d other)

Creates a new vector with the same values of this vector and divides the values of the provided vector. Same as new Vector3d(this).divideLocal(other);

Parameters:

other - the vector to divide.

Returns:

the newly created vector.

divideLocal

public Vector3d divideLocal(double scalar)

divideLocal

public Vector3d divideLocal(Vector3d other)

negate

public Vector3d negate()

Creates a new vector which contains negated values of this vector.

Returns:

the newly created vector.

negateLocal

public Vector3d negateLocal()

Negates all values of this vector.

Returns:

this vector.

cross

public Vector3d cross(Vector3d other)

Creates a new vector containing the cross product of this vector and another vector.

Parameters:

other - the other vector.

Returns:

the newly created vector.

crossLocal

public Vector3d crossLocal(Vector3d other)

Calculates the cross product of this vector and another vector.

Parameters:

other - the other vector.

Returns:

this vector.

crossLocal

public Vector3d crossLocal(double v2x,
 double v2y,
 double v2z)

Calculates the cross product of this vector and the provided coordinates.

Parameters:

v2x - the other x coordinate.

v2y - the other y coordinate.

v2z - the other z coordinate.

Returns:

this vector.

normalize

public Vector3d normalize()

Creates a new vector containing normalized values of this vector (i.e as a unit vector).

Returns:

a newly created, normalized vector.

normalizeLocal

public Vector3d normalizeLocal()

Normalizes this vector (i.e turn it into a unit vector).

Returns:

this vector (normalized).

angleBetween

public double angleBetween(Vector3d other)

Gets the angle between this vector and another vector.

Parameters:

other - the other vector (unit vector).

Returns:

the angle in degrees.

isUnitVector

public boolean isUnitVector()

Checks if this vector is a unit vector.

Returns:

true if this is a unit vector, false if not.

isOrthogonal

public boolean isOrthogonal(Vector3d other)

Checks if this vector is orthogonal to another vector (i.e the angle between both vectors is ~ 90° degree).

Parameters:

other - the other vector.

Returns:

true if this vector is orthogonal to the other vector, false if not.

isOrthogonal

public boolean isOrthogonal(double x,
 double y,
 double z)

Checks if this vector is orthogonal to another vector (i.e the angle between both vectors is ~ 90° degree).

Parameters:

x - the x coordinate of the other vector.

y - the y coordinate of the other vector.

z - the z coordinate of the other vector.

Returns:

true if this vector is orthogonal to the other vector, false if not.

interpolateLocal

public Vector3d interpolateLocal(Vector3d finalVector,
 double mu)

Interpolates this vector to the provided final vector, e.g if this vector is (0, 5, 10), and the final vector is (-10, 0, 10), the result (by using a mu-value of 0.5d) would be (-5, 2.5, 10)

Parameters:

finalVector - the final vector to interpolate towards.

mu - the mu value between 0.0 and 1.0 (i.e the percentage change from this vector to towards the final vector).

Returns:

this vector containing the interpolated values.

interpolateLocal

public Vector3d interpolateLocal(Vector3d startVector,
 Vector3d finalVector,
 double mu)

Interpolates between the provided start and end vector and stores the result in this vector.

Parameters:

startVector - the start vector to interpolate from.

finalVector - the final vector to interpolate towards.

mu - the mu value between 0.0 and 1.0 (i.e the percentage change from the start vector to towards the final vector).

Returns:

this vector containing the interpolated values.

interpolate

public Vector3d interpolate(Vector3d startVector,
 Vector3d finalVector,
 double mu)

Creates a new vector containing the interpolated values between the start vector and the final vector.

Parameters:

startVector - the start vector to interpolate from.

finalVector - the final vector to interpolate towards.

mu - the mu value between 0.0 and 1.0 (i.e the percentage change from the start vector to towards the final vector).

Returns:

a new vector containing the interpolated values.

equals

public boolean equals(Object o)

Gets whether or not this vector is equal to another object. This function returns true, if the other object is a Vector3d and if it has exactly the same x, y and z values.

Overrides:

equals in class Object

Parameters:

o - the object to compare to equality.

Returns:

true if the other object is a Vector3d and has the same values as this vector, false if not.

equals

public boolean equals(double x,
 double y,
 double z)

hashCode

public int hashCode()

Gets a unique* hash code for this vector, based on its values. If two vectors have the same x, y and z values, they will return the same hash code.

* Please keep in mind that the uniqueness is not fully reliable. There is always a small chance that collisions occur (i.e two completely different vectors return the same hash code). But usually the reliability is sufficient.

Overrides:

hashCode in class Object

Returns:

the hash code for this vector.

toString

public String toString()

Gets a String representation of this vector, for example (4.0, 5.25, 10.998)

Overrides:

toString in class Object

Returns:

a string representing the values of this vector.

fromString

public Vector3d fromString(String input)