io.lumine.xikage.mythicmobs.adapters

Class AbstractVector

java.lang.Object

io.lumine.xikage.mythicmobs.adapters.AbstractVector

All Implemented Interfaces:

Cloneable

public class AbstractVector
extends Object
implements Cloneable

Represents a mutable vector. Because the components of Vectors are mutable, storing Vectors long term may be dangerous if passing code modifies the Vector later. If you want to keep around a Vector, it may be wise to call clone() in order to get a copy.

Field Summary

Fields

Modifier and Type	Field and Description
protected double	x
protected double	y
protected double	z

Constructor Summary

Constructors

Constructor and Description
AbstractVector() Construct the vector with all components as 0.
AbstractVector(double x, double y, double z) Construct the vector with provided double components.
AbstractVector(float x, float y, float z) Construct the vector with provided float components.
AbstractVector(int x, int y, int z) Construct the vector with provided integer components.

Method Summary

Modifier and Type	Method and Description
AbstractVector	add(AbstractVector vec) Adds a vector to this one
float	angle(AbstractVector other) Gets the angle between this vector and another in radians.
AbstractVector	clone() Get a new vector.
AbstractVector	copy(AbstractVector vec) Copies another vector
AbstractVector	divide(AbstractVector vec) Divides the vector by another.
double	dot(AbstractVector other) Calculates the dot product of this vector with another.
boolean	equals(Object obj) Checks to see if two objects are equal.
int	getBlockX() Gets the floored value of the X component, indicating the block that this vector is contained with.
int	getBlockY() Gets the floored value of the Y component, indicating the block that this vector is contained with.
int	getBlockZ() Gets the floored value of the Z component, indicating the block that this vector is contained with.
static double	getEpsilon() Get the threshold used for equals().
double	getX() Gets the X component.
double	getY() Gets the Y component.
double	getZ() Gets the Z component.
int	hashCode() Returns a hash code for this vector
double	length() Gets the magnitude of the vector, defined as sqrt(x^2+y^2+z^2).
double	lengthSquared() Gets the magnitude of the vector squared.
AbstractVector	multiply(AbstractVector vec) Multiplies the vector by another.
AbstractVector	multiply(double m) Performs scalar multiplication, multiplying all components with a scalar.
AbstractVector	multiply(float m) Performs scalar multiplication, multiplying all components with a scalar.
AbstractVector	multiply(int m) Performs scalar multiplication, multiplying all components with a scalar.
AbstractVector	normalize() Converts this vector to a unit vector (a vector with length of 1).
AbstractVector	rotate(float degrees) Rotates the vector a certain number of degrees.
AbstractVector	setX(double x) Set the X component.
AbstractVector	setX(float x) Set the X component.
AbstractVector	setX(int x) Set the X component.
AbstractVector	setY(double y) Set the Y component.
AbstractVector	setY(float y) Set the Y component.
AbstractVector	setY(int y) Set the Y component.
AbstractVector	setZ(double z) Set the Z component.
AbstractVector	setZ(float z) Set the Z component.
AbstractVector	setZ(int z) Set the Z component.
AbstractVector	subtract(AbstractVector vec) Subtracts a vector from this one.
AbstractLocation	toLocation(AbstractWorld world) Gets a Location version of this vector with yaw and pitch being 0.
AbstractLocation	toLocation(AbstractWorld world, float yaw, float pitch) Gets a Location version of this vector.
String	toString() Returns this vector's components as x,y,z.

Methods inherited from class java.lang.Object

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

Field Detail

x

protected double x

y

protected double y

z

protected double z

Constructor Detail

AbstractVector

public AbstractVector(int x,
                      int y,
                      int z)

Construct the vector with provided integer components.

Parameters:

x - X component

y - Y component

z - Z component

AbstractVector

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

Construct the vector with provided double components.

Parameters:

x - X component

y - Y component

z - Z component

AbstractVector

public AbstractVector(float x,
                      float y,
                      float z)

Construct the vector with provided float components.

Parameters:

x - X component

y - Y component

z - Z component

AbstractVector

public AbstractVector()

Construct the vector with all components as 0.

Method Detail

add

public AbstractVector add(AbstractVector vec)

Adds a vector to this one

Parameters:

vec - The other vector

Returns:

the same vector

subtract

public AbstractVector subtract(AbstractVector vec)

Subtracts a vector from this one.

Parameters:

vec - The other vector

Returns:

the same vector

multiply

public AbstractVector multiply(AbstractVector vec)

Multiplies the vector by another.

Parameters:

vec - The other vector

Returns:

the same vector

multiply

public AbstractVector multiply(int m)

Performs scalar multiplication, multiplying all components with a scalar.

Parameters:

m - The factor

Returns:

the same vector

multiply

public AbstractVector multiply(double m)

Performs scalar multiplication, multiplying all components with a scalar.

Parameters:

m - The factor

Returns:

the same vector

multiply

public AbstractVector multiply(float m)

Performs scalar multiplication, multiplying all components with a scalar.

Parameters:

m - The factor

Returns:

the same vector

divide

public AbstractVector divide(AbstractVector vec)

Divides the vector by another.

Parameters:

vec - The other vector

Returns:

the same vector

copy

public AbstractVector copy(AbstractVector vec)

Copies another vector

Parameters:

vec - The other vector

Returns:

the same vector

length

public double length()

Gets the magnitude of the vector, defined as sqrt(x^2+y^2+z^2). The value of this method is not cached and uses a costly square-root function, so do not repeatedly call this method to get the vector's magnitude. NaN will be returned if the inner result of the sqrt() function overflows, which will be caused if the length is too long.

Returns:

the magnitude

lengthSquared

public double lengthSquared()

Gets the magnitude of the vector squared.

Returns:

the magnitude

getX

public double getX()

Gets the X component.

Returns:

The X component.

getBlockX

public int getBlockX()

Gets the floored value of the X component, indicating the block that this vector is contained with.

Returns:

block X

getY

public double getY()

Gets the Y component.

Returns:

The Y component.

getBlockY

public int getBlockY()

Gets the floored value of the Y component, indicating the block that this vector is contained with.

Returns:

block y

getZ

public double getZ()

Gets the Z component.

Returns:

The Z component.

getBlockZ

public int getBlockZ()

Gets the floored value of the Z component, indicating the block that this vector is contained with.

Returns:

block z

setX

public AbstractVector setX(int x)

Set the X component.

Parameters:

x - The new X component.

Returns:

This vector.

setX

public AbstractVector setX(double x)

Set the X component.

Parameters:

x - The new X component.

Returns:

This vector.

setX

public AbstractVector setX(float x)

Set the X component.

Parameters:

x - The new X component.

Returns:

This vector.

setY

public AbstractVector setY(int y)

Set the Y component.

Parameters:

y - The new Y component.

Returns:

This vector.

setY

public AbstractVector setY(double y)

Set the Y component.

Parameters:

y - The new Y component.

Returns:

This vector.

setY

public AbstractVector setY(float y)

Set the Y component.

Parameters:

y - The new Y component.

Returns:

This vector.

setZ

public AbstractVector setZ(int z)

Set the Z component.

Parameters:

z - The new Z component.

Returns:

This vector.

setZ

public AbstractVector setZ(double z)

Set the Z component.

Parameters:

z - The new Z component.

Returns:

This vector.

setZ

public AbstractVector setZ(float z)

Set the Z component.

Parameters:

z - The new Z component.

Returns:

This vector.

normalize

public AbstractVector normalize()

Converts this vector to a unit vector (a vector with length of 1).

Returns:

the same vector

rotate

public AbstractVector rotate(float degrees)

Rotates the vector a certain number of degrees.

Returns:

the same vector

equals

public boolean equals(Object obj)

Checks to see if two objects are equal.

Only two Vectors can ever return true. This method uses a fuzzy match to account for floating point errors. The epsilon can be retrieved with epsilon.

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns a hash code for this vector

Overrides:

hashCode in class Object

Returns:

hash code

clone

public AbstractVector clone()

Get a new vector.

Overrides:

clone in class Object

Returns:

vector

toString

public String toString()

Returns this vector's components as x,y,z.

Overrides:

toString in class Object

toLocation

public AbstractLocation toLocation(AbstractWorld world)

Gets a Location version of this vector with yaw and pitch being 0.

Parameters:

world - The world to link the location to.

Returns:

the location

toLocation

public AbstractLocation toLocation(AbstractWorld world,
                                   float yaw,
                                   float pitch)

Gets a Location version of this vector.

Parameters:

world - The world to link the location to.

yaw - The desired yaw.

pitch - The desired pitch.

Returns:

the location

getEpsilon

public static double getEpsilon()

Get the threshold used for equals().

Returns:

The epsilon.

dot

public double dot(AbstractVector other)

Calculates the dot product of this vector with another. The dot product is defined as x1*x2+y1*y2+z1*z2. The returned value is a scalar.

Parameters:

other - The other vector

Returns:

dot product

angle

public float angle(AbstractVector other)

Gets the angle between this vector and another in radians.

Parameters:

other - The other vector

Returns:

angle in radians