com.austinv11.collectiveframework.utils.math

Class ThreeDimensionalVector

java.lang.Object

com.austinv11.collectiveframework.utils.math.ThreeDimensionalVector

All Implemented Interfaces:

java.lang.Comparable

Direct Known Subclasses:

Location

public class ThreeDimensionalVector
extends java.lang.Object
implements java.lang.Comparable

Class for manipulating and holding coords on a 3D plane Remember, in Minecraft the y and z axises are switched

Constructor Summary

Constructors

Constructor and Description
ThreeDimensionalVector(double x, double y, double z) Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
ThreeDimensionalVector	add(ThreeDimensionalVector other) Returns a new vector with the result of the specified vector plus this.
int	compareTo(java.lang.Object o)
ThreeDimensionalVector	crossProduct(ThreeDimensionalVector other) Finds the cross product of the current vector and the other specified vector
double	distanceTo(ThreeDimensionalVector other) Finds the distance between two vectors
double	dotProduct() Finds the dot product of the current vector and itself
double	dotProduct(ThreeDimensionalVector other) Finds the dot product of the current vector and the other specified vector
boolean	equals(java.lang.Object other)
int	getRoundedX() Returns the x coord as an int
int	getRoundedY() Returns the y coord as an int
int	getRoundedZ() Returns the z coord as an int
double	getX() Gets the x coord of the vector
double	getY() Gets the y coord of the vector
double	getZ() Gets the z coord of the vector
double	length() Finds the length of the vector
ThreeDimensionalVector	midpoint(ThreeDimensionalVector other) Returns a vector representing the midpoint between the current vector and another
ThreeDimensionalVector	normalize() Normalizes the vector to a length of 1 (all coords add up to one)
ThreeDimensionalVector	rotateX(double angle) Rotates the vector around the X-axis about the origin
ThreeDimensionalVector	rotateX(ThreeDimensionalVector center, double angle) Rotates the vector around the X-axis
ThreeDimensionalVector	rotateY(double angle) Rotates the vector around the Y-axis about the origin
ThreeDimensionalVector	rotateY(ThreeDimensionalVector center, double angle) Rotates the vector around the Y-axis
ThreeDimensionalVector	rotateZ(double angle) Rotates the vector around the Z-axis about the origin
ThreeDimensionalVector	rotateZ(ThreeDimensionalVector center, double angle) Rotates the vector around the Z-axis
void	setComponents(double x, double y, double z) Sets the coordinates
ThreeDimensionalVector	subtract(ThreeDimensionalVector other) Returns a new vector with the result of the specified vector minus this.
TwoDimensionalVector	to2D() Converts this vector from a 3D plane to a 2D plane
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreeDimensionalVector

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

Default constructor

Parameters:

x - X coordinate

y - Y coordinate

z - Z coordinate

Method Detail

setComponents

public void setComponents(double x,
                 double y,
                 double z)

Sets the coordinates

Parameters:

x - X coordinate

y - Y coordinate

z - Z coordinate

getRoundedX

public int getRoundedX()

Returns the x coord as an int

Returns:

The rounded x coord

getRoundedY

public int getRoundedY()

Returns the y coord as an int

Returns:

The rounded y coord

getRoundedZ

public int getRoundedZ()

Returns the z coord as an int

Returns:

The rounded z coord

getX

public double getX()

Gets the x coord of the vector

Returns:

The coord

getY

public double getY()

Gets the y coord of the vector

Returns:

The coord

getZ

public double getZ()

Gets the z coord of the vector

Returns:

The coord

subtract

public ThreeDimensionalVector subtract(ThreeDimensionalVector other)

Returns a new vector with the result of the specified vector minus this.

Parameters:

other - The vector to subtract from

Returns:

New vector

add

public ThreeDimensionalVector add(ThreeDimensionalVector other)

Returns a new vector with the result of the specified vector plus this.

Parameters:

other - The vector to add to

Returns:

New vector

normalize

public ThreeDimensionalVector normalize()

Normalizes the vector to a length of 1 (all coords add up to one)

Returns:

Normalized vector

dotProduct

public double dotProduct()

Finds the dot product of the current vector and itself

Returns:

The dot product

dotProduct

public double dotProduct(ThreeDimensionalVector other)

Finds the dot product of the current vector and the other specified vector

Parameters:

other - The other vector

Returns:

The dot product

crossProduct

public ThreeDimensionalVector crossProduct(ThreeDimensionalVector other)

Finds the cross product of the current vector and the other specified vector

Parameters:

other - The other vector

Returns:

The cross product

distanceTo

public double distanceTo(ThreeDimensionalVector other)

Finds the distance between two vectors

Parameters:

other - The other vector

Returns:

The distance

length

public double length()

Finds the length of the vector

Returns:

The length

midpoint

public ThreeDimensionalVector midpoint(ThreeDimensionalVector other)

Returns a vector representing the midpoint between the current vector and another

Parameters:

other - The other vector

Returns:

The midpoint

rotateX

public ThreeDimensionalVector rotateX(ThreeDimensionalVector center,
                             double angle)

Rotates the vector around the X-axis

Parameters:

center - The coordinate to rotate around

angle - The angle to rotate by

Returns:

The rotated vector

rotateX

public ThreeDimensionalVector rotateX(double angle)

Rotates the vector around the X-axis about the origin

Parameters:

angle - The angle to rotate by

Returns:

The rotated vector

rotateY

public ThreeDimensionalVector rotateY(ThreeDimensionalVector center,
                             double angle)

Rotates the vector around the Y-axis

Parameters:

center - The coordinate to rotate around

angle - The angle to rotate by

Returns:

The rotated vector

rotateY

public ThreeDimensionalVector rotateY(double angle)

Rotates the vector around the Y-axis about the origin

Parameters:

angle - The angle to rotate by

Returns:

The rotated vector

rotateZ

public ThreeDimensionalVector rotateZ(ThreeDimensionalVector center,
                             double angle)

Rotates the vector around the Z-axis

Parameters:

center - The coordinate to rotate around

angle - The angle to rotate by

Returns:

The rotated vector

rotateZ

public ThreeDimensionalVector rotateZ(double angle)

Rotates the vector around the Z-axis about the origin

Parameters:

angle - The angle to rotate by

Returns:

The rotated vector

to2D

public TwoDimensionalVector to2D()

Converts this vector from a 3D plane to a 2D plane

Returns:

The converted vector

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable