com.sk89q.worldedit

Class Vector

java.lang.Object

com.sk89q.worldedit.Vector

All Implemented Interfaces:

Comparable<Vector>

Direct Known Subclasses:

BlockVector, WorldVector

public class Vector
extends Object
implements Comparable<Vector>

Author:

sk89q

Field Summary

Fields

Modifier and Type	Field and Description
static Vector	ONE
static Vector	UNIT_X
static Vector	UNIT_Y
static Vector	UNIT_Z
protected double	x
protected double	y
protected double	z
static Vector	ZERO

Constructor Summary

Constructors

Constructor and Description
Vector() Construct the Vector object.
Vector(double x, double y, double z) Construct the Vector object.
Vector(float x, float y, float z) Construct the Vector object.
Vector(int x, int y, int z) Construct the Vector object.
Vector(Vector pt) Construct the Vector object.

Method Summary

Methods

Modifier and Type	Method and Description
Vector	add(double x, double y, double z) Adds two points.
Vector	add(int x, int y, int z) Adds two points.
Vector	add(Vector... others) Adds points.
Vector	add(Vector other) Adds two points.
Vector	ceil() Rounds all components up.
Vector	clampY(int min, int max) Clamp the Y component.
int	compareTo(Vector other)
boolean	containedWithin(Vector min, Vector max) Checks to see if a vector is contained with another.
boolean	containedWithinBlock(Vector min, Vector max) Checks to see if a vector is contained with another.
Vector	cross(Vector other) Gets the cross product of this and another vector.
double	distance(Vector pt) Get the distance away from a point.
double	distanceSq(Vector pt) Get the distance away from a point, squared.
Vector	divide(double n) Scalar division.
Vector	divide(double x, double y, double z) Component-wise division
Vector	divide(float n) Scalar division.
Vector	divide(int n) Scalar division.
Vector	divide(int x, int y, int z) Component-wise division
Vector	divide(Vector other) Component-wise division
double	dot(Vector other) Gets the dot product of this and another vector.
boolean	equals(Object obj) Checks if another object is equivalent.
Vector	floor() Rounds all components down.
int	getBlockX()
int	getBlockY()
int	getBlockZ()
static Vector	getMaximum(Vector v1, Vector v2) Gets the maximum components of two vectors.
static Vector	getMidpoint(Vector v1, Vector v2) Gets the midpoint of two vectors.
static Vector	getMinimum(Vector v1, Vector v2) Gets the minimum components of two vectors.
double	getX()
double	getY()
double	getZ()
int	hashCode() Gets the hash code.
boolean	isCollinearWith(Vector other)
double	length() Get the length of the vector.
double	lengthSq() Get the length^2 of the vector.
Vector	multiply(double n) Scalar multiplication.
Vector	multiply(double x, double y, double z) Component-wise multiplication
Vector	multiply(float n) Scalar multiplication.
Vector	multiply(int n) Scalar multiplication.
Vector	multiply(int x, int y, int z) Component-wise multiplication
Vector	multiply(Vector... others) Component-wise multiplication
Vector	multiply(Vector other) Component-wise multiplication
Vector	normalize() Get the normalized vector.
Vector	positive() Returns a vector with the absolute values of the components of this vector.
Vector	round() Rounds all components to the closest integer. Components < 0.5 are rounded down, otherwise up
Vector	setX(double x) Set X.
Vector	setX(int x) Set X.
Vector	setY(double y) Set Y.
Vector	setY(int y) Set Y.
Vector	setZ(double z) Set Z.
Vector	setZ(int z) Set Z.
Vector	subtract(double x, double y, double z) Subtract two points.
Vector	subtract(int x, int y, int z) Subtract two points.
Vector	subtract(Vector... others) Subtract points.
Vector	subtract(Vector other) Subtracts two points.
BlockVector	toBlockPoint() Get a block point from a point.
static BlockVector	toBlockPoint(double x, double y, double z) Get a block point from a point.
BlockVector	toBlockVector() Gets a BlockVector version.
String	toString() Returns string representation "(x, y, z)".
Vector2D	toVector2D() Creates a 2D vector by dropping the Y component from this vector.
Vector	transform2D(double angle, double aboutX, double aboutZ, double translateX, double translateZ) 2D transformation.

Methods inherited from class java.lang.Object

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

Field Detail

ZERO

public static final Vector ZERO

UNIT_X

public static final Vector UNIT_X

UNIT_Y

public static final Vector UNIT_Y

UNIT_Z

public static final Vector UNIT_Z

ONE

public static final Vector ONE

x

protected final double x

y

protected final double y

z

protected final double z

Constructor Detail

Vector

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

Construct the Vector object.

Parameters:

x -

y -

z -

Vector

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

Construct the Vector object.

Parameters:

x -

y -

z -

Vector

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

Construct the Vector object.

Parameters:

x -

y -

z -

Vector

public Vector(Vector pt)

Construct the Vector object.

Parameters:

pt -

Vector

public Vector()

Construct the Vector object.

Method Detail

getX

public double getX()

Returns:

the x

getBlockX

public int getBlockX()

Returns:

the x

setX

public Vector setX(double x)

Set X.

Parameters:

x -

Returns:

new vector

setX

public Vector setX(int x)

Set X.

Parameters:

x -

Returns:

new vector

getY

public double getY()

Returns:

the y

getBlockY

public int getBlockY()

Returns:

the y

setY

public Vector setY(double y)

Set Y.

Parameters:

y -

Returns:

new vector

setY

public Vector setY(int y)

Set Y.

Parameters:

y -

Returns:

new vector

getZ

public double getZ()

Returns:

the z

getBlockZ

public int getBlockZ()

Returns:

the z

setZ

public Vector setZ(double z)

Set Z.

Parameters:

z -

Returns:

new vector

setZ

public Vector setZ(int z)

Set Z.

Parameters:

z -

Returns:

new vector

add

public Vector add(Vector other)

Adds two points.

Parameters:

other -

Returns:

New point

add

public Vector add(double x,
         double y,
         double z)

Adds two points.

Parameters:

x -

y -

z -

Returns:

New point

add

public Vector add(int x,
         int y,
         int z)

Adds two points.

Parameters:

x -

y -

z -

Returns:

New point

add

public Vector add(Vector... others)

Adds points.

Parameters:

others -

Returns:

New point

subtract

public Vector subtract(Vector other)

Subtracts two points.

Parameters:

other -

Returns:

New point

subtract

public Vector subtract(double x,
              double y,
              double z)

Subtract two points.

Parameters:

x -

y -

z -

Returns:

New point

subtract

public Vector subtract(int x,
              int y,
              int z)

Subtract two points.

Parameters:

x -

y -

z -

Returns:

New point

subtract

public Vector subtract(Vector... others)

Subtract points.

Parameters:

others -

Returns:

New point

multiply

public Vector multiply(Vector other)

Component-wise multiplication

Parameters:

other -

Returns:

New point

multiply

public Vector multiply(double x,
              double y,
              double z)

Component-wise multiplication

Parameters:

x -

y -

z -

Returns:

New point

multiply

public Vector multiply(int x,
              int y,
              int z)

Component-wise multiplication

Parameters:

x -

y -

z -

Returns:

New point

multiply

public Vector multiply(Vector... others)

Component-wise multiplication

Parameters:

others -

Returns:

New point

multiply

public Vector multiply(double n)

Scalar multiplication.

Parameters:

n -

Returns:

New point

multiply

public Vector multiply(float n)

Scalar multiplication.

Parameters:

n -

Returns:

New point

multiply

public Vector multiply(int n)

Scalar multiplication.

Parameters:

n -

Returns:

New point

divide

public Vector divide(Vector other)

Component-wise division

Parameters:

other -

Returns:

New point

divide

public Vector divide(double x,
            double y,
            double z)

Component-wise division

Parameters:

x -

y -

z -

Returns:

New point

divide

public Vector divide(int x,
            int y,
            int z)

Component-wise division

Parameters:

x -

y -

z -

Returns:

New point

divide

public Vector divide(int n)

Scalar division.

Parameters:

n -

Returns:

new point

divide

public Vector divide(double n)

Scalar division.

Parameters:

n -

Returns:

new point

divide

public Vector divide(float n)

Scalar division.

Parameters:

n -

Returns:

new point

length

public double length()

Get the length of the vector.

Returns:

length

lengthSq

public double lengthSq()

Get the length^2 of the vector.

Returns:

length^2

distance

public double distance(Vector pt)

Get the distance away from a point.

Parameters:

pt -

Returns:

distance

distanceSq

public double distanceSq(Vector pt)

Get the distance away from a point, squared.

Parameters:

pt -

Returns:

distance

normalize

public Vector normalize()

Get the normalized vector.

Returns:

vector

dot

public double dot(Vector other)

Gets the dot product of this and another vector.

Parameters:

other -

Returns:

the dot product of this and the other vector

cross

public Vector cross(Vector other)

Gets the cross product of this and another vector.

Parameters:

other -

Returns:

the cross product of this and the other vector

containedWithin

public boolean containedWithin(Vector min,
                      Vector max)

Checks to see if a vector is contained with another.

Parameters:

min -

max -

Returns:

containedWithinBlock

public boolean containedWithinBlock(Vector min,
                           Vector max)

Checks to see if a vector is contained with another.

Parameters:

min -

max -

Returns:

clampY

public Vector clampY(int min,
            int max)

Clamp the Y component.

Parameters:

min -

max -

Returns:

floor

public Vector floor()

Rounds all components down.

Returns:

ceil

public Vector ceil()

Rounds all components up.

Returns:

round

public Vector round()

Rounds all components to the closest integer.

Components < 0.5 are rounded down, otherwise up

Returns:

positive

public Vector positive()

Returns a vector with the absolute values of the components of this vector.

Returns:

transform2D

public Vector transform2D(double angle,
                 double aboutX,
                 double aboutZ,
                 double translateX,
                 double translateZ)

2D transformation.

Parameters:

angle - in degrees

aboutX - about which x coordinate to rotate

aboutZ - about which z coordinate to rotate

translateX - what to add after rotation

translateZ - what to add after rotation

Returns:

isCollinearWith

public boolean isCollinearWith(Vector other)

toBlockPoint

public static BlockVector toBlockPoint(double x,
                       double y,
                       double z)

Get a block point from a point.

Parameters:

x -

y -

z -

Returns:

point

toBlockPoint

public BlockVector toBlockPoint()

Get a block point from a point.

Returns:

point

equals

public boolean equals(Object obj)

Checks if another object is equivalent.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

whether the other object is equivalent

compareTo

public int compareTo(Vector other)

Specified by:

compareTo in interface Comparable<Vector>

hashCode

public int hashCode()

Gets the hash code.

Overrides:

hashCode in class Object

Returns:

hash code

toString

public String toString()

Returns string representation "(x, y, z)".

Overrides:

toString in class Object

Returns:

string

toBlockVector

public BlockVector toBlockVector()

Gets a BlockVector version.

Returns:

BlockVector

toVector2D

public Vector2D toVector2D()

Creates a 2D vector by dropping the Y component from this vector.

Returns:

Vector2D

getMinimum

public static Vector getMinimum(Vector v1,
                Vector v2)

Gets the minimum components of two vectors.

Parameters:

v1 -

v2 -

Returns:

minimum

getMaximum

public static Vector getMaximum(Vector v1,
                Vector v2)

Gets the maximum components of two vectors.

Parameters:

v1 -

v2 -

Returns:

maximum

getMidpoint

public static Vector getMidpoint(Vector v1,
                 Vector v2)

Gets the midpoint of two vectors.

Parameters:

v1 -

v2 -

Returns:

maximum