Vector2D (WorldEdit 5.6.1-SNAPSHOT API)

java.lang.Object
- com.sk89q.worldedit.Vector2D

Direct Known Subclasses:

BlockVector2D, WorldVector2D
```
public class Vector2D
extends Object
```
Author:

sk89q

Field Summary

Fields
Modifier and Type	Field and Description
`static Vector2D`	`ONE`
`static Vector2D`	`UNIT_X`
`static Vector2D`	`UNIT_Z`
`protected double`	`x`
`protected double`	`z`
`static Vector2D`	`ZERO`

Constructor Summary

Constructors
Constructor and Description
`Vector2D()` Construct the Vector2D object.
`Vector2D(double x, double z)` Construct the Vector2D object.
`Vector2D(float x, float z)` Construct the Vector2D object.
`Vector2D(int x, int z)` Construct the Vector2D object.
`Vector2D(Vector2D pt)` Construct the Vector2D object.

Method Summary

Methods
Modifier and Type	Method and Description
`Vector2D`	`add(double x, double z)` Adds two points.
`Vector2D`	`add(int x, int z)` Adds two points.
`Vector2D`	`add(Vector2D... others)` Adds points.
`Vector2D`	`add(Vector2D other)` Adds two points.
`Vector2D`	`ceil()` Rounds all components up.
`boolean`	`containedWithin(Vector2D min, Vector2D max)` Checks to see if a vector is contained with another.
`boolean`	`containedWithinBlock(Vector2D min, Vector2D max)` Checks to see if a vector is contained with another.
`double`	`distance(Vector2D pt)` Get the distance away from a point.
`double`	`distanceSq(Vector2D pt)` Get the distance away from a point, squared.
`Vector2D`	`divide(double n)` Scalar division.
`Vector2D`	`divide(double x, double z)` Component-wise division
`Vector2D`	`divide(float n)` Scalar division.
`Vector2D`	`divide(int n)` Scalar division.
`Vector2D`	`divide(int x, int z)` Component-wise division
`Vector2D`	`divide(Vector2D other)` Component-wise division
`double`	`dot(Vector2D other)` Gets the dot product of this and another vector.
`boolean`	`equals(Object obj)` Checks if another object is equivalent.
`Vector2D`	`floor()` Rounds all components down.
`int`	`getBlockX()`
`int`	`getBlockZ()`
`static Vector2D`	`getMaximum(Vector2D v1, Vector2D v2)` Gets the maximum components of two vectors.
`static Vector2D`	`getMinimum(Vector2D v1, Vector2D v2)` Gets the minimum components of two vectors.
`double`	`getX()`
`double`	`getZ()`
`int`	`hashCode()` Gets the hash code.
`boolean`	`isCollinearWith(Vector2D other)`
`double`	`length()` Get the length of the vector.
`double`	`lengthSq()` Get the length^2 of the vector.
`Vector2D`	`multiply(double n)` Scalar multiplication.
`Vector2D`	`multiply(double x, double z)` Component-wise multiplication
`Vector2D`	`multiply(float n)` Scalar multiplication.
`Vector2D`	`multiply(int n)` Scalar multiplication.
`Vector2D`	`multiply(int x, int z)` Component-wise multiplication
`Vector2D`	`multiply(Vector2D... others)` Component-wise multiplication
`Vector2D`	`multiply(Vector2D other)` Component-wise multiplication
`Vector2D`	`normalize()` Get the normalized vector.
`Vector2D`	`positive()` Returns a vector with the absolute values of the components of this vector.
`Vector2D`	`round()` Rounds all components to the closest integer. Components < 0.5 are rounded down, otherwise up
`Vector2D`	`setX(double x)` Set X.
`Vector2D`	`setX(int x)` Set X.
`Vector2D`	`setZ(double z)` Set Z.
`Vector2D`	`setZ(int z)` Set Z.
`Vector2D`	`subtract(double x, double z)` Subtract two points.
`Vector2D`	`subtract(int x, int z)` Subtract two points.
`Vector2D`	`subtract(Vector2D... others)` Subtract points.
`Vector2D`	`subtract(Vector2D other)` Subtracts two points.
`BlockVector2D`	`toBlockVector2D()` Gets a BlockVector version.
`String`	`toString()` Returns string representation "(x, y, z)".
`Vector`	`toVector()` Creates a 3D vector by adding a zero Y component to this vector.
`Vector`	`toVector(double y)` Creates a 3D vector by adding the specified Y component to this vector.
`Vector2D`	`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 Vector2D ZERO
```
  - UNIT_X
```
public static final Vector2D UNIT_X
```
  - UNIT_Z
```
public static final Vector2D UNIT_Z
```
  - ONE
```
public static final Vector2D ONE
```
  - x
```
protected final double x
```
  - z
```
protected final double z
```
- Constructor Detail
  - Vector2D
```
public Vector2D(double x,
        double z)
```
    Construct the Vector2D object.
    
    Parameters:
    x -
    z -
  - Vector2D
```
public Vector2D(int x,
        int z)
```
    Construct the Vector2D object.
    
    Parameters:
    x -
    z -
  - Vector2D
```
public Vector2D(float x,
        float z)
```
    Construct the Vector2D object.
    
    Parameters:
    x -
    z -
  - Vector2D
```
public Vector2D(Vector2D pt)
```
    Construct the Vector2D object.
    
    Parameters:
    pt -
  - Vector2D
```
public Vector2D()
```
    Construct the Vector2D object.
- Method Detail
  - getX
```
public double getX()
```
    Returns:
    the x
  - getBlockX
```
public int getBlockX()
```
    Returns:
    the x
  - setX
```
public Vector2D setX(double x)
```
    Set X.
    
    Parameters:
    x -
    
    Returns:
    new vector
  - setX
```
public Vector2D setX(int x)
```
    Set X.
    
    Parameters:
    x -
    
    Returns:
    new vector
  - getZ
```
public double getZ()
```
    Returns:
    the z
  - getBlockZ
```
public int getBlockZ()
```
    Returns:
    the z
  - setZ
```
public Vector2D setZ(double z)
```
    Set Z.
    
    Parameters:
    z -
    
    Returns:
    new vector
  - setZ
```
public Vector2D setZ(int z)
```
    Set Z.
    
    Parameters:
    z -
    
    Returns:
    new vector
  - add
```
public Vector2D add(Vector2D other)
```
    Adds two points.
    
    Parameters:
    other -
    
    Returns:
    New point
  - add
```
public Vector2D add(double x,
           double z)
```
    Adds two points.
    
    Parameters:
    x -
    z -
    
    Returns:
    New point
  - add
```
public Vector2D add(int x,
           int z)
```
    Adds two points.
    
    Parameters:
    x -
    z -
    
    Returns:
    New point
  - add
```
public Vector2D add(Vector2D... others)
```
    Adds points.
    
    Parameters:
    others -
    
    Returns:
    New point
  - subtract
```
public Vector2D subtract(Vector2D other)
```
    Subtracts two points.
    
    Parameters:
    other -
    
    Returns:
    New point
  - subtract
```
public Vector2D subtract(double x,
                double z)
```
    Subtract two points.
    
    Parameters:
    x -
    z -
    
    Returns:
    New point
  - subtract
```
public Vector2D subtract(int x,
                int z)
```
    Subtract two points.
    
    Parameters:
    x -
    z -
    
    Returns:
    New point
  - subtract
```
public Vector2D subtract(Vector2D... others)
```
    Subtract points.
    
    Parameters:
    others -
    
    Returns:
    New point
  - multiply
```
public Vector2D multiply(Vector2D other)
```
    Component-wise multiplication
    
    Parameters:
    other -
    
    Returns:
    New point
  - multiply
```
public Vector2D multiply(double x,
                double z)
```
    Component-wise multiplication
    
    Parameters:
    x -
    z -
    
    Returns:
    New point
  - multiply
```
public Vector2D multiply(int x,
                int z)
```
    Component-wise multiplication
    
    Parameters:
    x -
    z -
    
    Returns:
    New point
  - multiply
```
public Vector2D multiply(Vector2D... others)
```
    Component-wise multiplication
    
    Parameters:
    others -
    
    Returns:
    New point
  - multiply
```
public Vector2D multiply(double n)
```
    Scalar multiplication.
    
    Parameters:
    n -
    
    Returns:
    New point
  - multiply
```
public Vector2D multiply(float n)
```
    Scalar multiplication.
    
    Parameters:
    n -
    
    Returns:
    New point
  - multiply
```
public Vector2D multiply(int n)
```
    Scalar multiplication.
    
    Parameters:
    n -
    
    Returns:
    New point
  - divide
```
public Vector2D divide(Vector2D other)
```
    Component-wise division
    
    Parameters:
    other -
    
    Returns:
    New point
  - divide
```
public Vector2D divide(double x,
              double z)
```
    Component-wise division
    
    Parameters:
    x -
    z -
    
    Returns:
    New point
  - divide
```
public Vector2D divide(int x,
              int z)
```
    Component-wise division
    
    Parameters:
    x -
    z -
    
    Returns:
    New point
  - divide
```
public Vector2D divide(int n)
```
    Scalar division.
    
    Parameters:
    n -
    
    Returns:
    new point
  - divide
```
public Vector2D divide(double n)
```
    Scalar division.
    
    Parameters:
    n -
    
    Returns:
    new point
  - divide
```
public Vector2D 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(Vector2D pt)
```
    Get the distance away from a point.
    
    Parameters:
    pt -
    
    Returns:
    distance
  - distanceSq
```
public double distanceSq(Vector2D pt)
```
    Get the distance away from a point, squared.
    
    Parameters:
    pt -
    
    Returns:
    distance
  - normalize
```
public Vector2D normalize()
```
    Get the normalized vector.
    
    Returns:
    vector
  - dot
```
public double dot(Vector2D other)
```
    Gets the dot product of this and another vector.
    
    Parameters:
    other -
    
    Returns:
    the dot product of this and the other vector
  - containedWithin
```
public boolean containedWithin(Vector2D min,
                      Vector2D max)
```
    Checks to see if a vector is contained with another.
    
    Parameters:
    min -
    max -
    
    Returns:
  - containedWithinBlock
```
public boolean containedWithinBlock(Vector2D min,
                           Vector2D max)
```
    Checks to see if a vector is contained with another.
    
    Parameters:
    min -
    max -
    
    Returns:
  - floor
```
public Vector2D floor()
```
    Rounds all components down.
    
    Returns:
  - ceil
```
public Vector2D ceil()
```
    Rounds all components up.
    
    Returns:
  - round
```
public Vector2D round()
```
    Rounds all components to the closest integer.
    
    Components < 0.5 are rounded down, otherwise up
    
    Returns:
  - positive
```
public Vector2D positive()
```
    Returns a vector with the absolute values of the components of this vector.
    
    Returns:
  - transform2D
```
public Vector2D 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(Vector2D other)
```
  - toBlockVector2D
```
public BlockVector2D toBlockVector2D()
```
    Gets a BlockVector version.
    
    Returns:
    BlockVector
  - 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
  - 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
  - toVector
```
public Vector toVector()
```
    Creates a 3D vector by adding a zero Y component to this vector.
    
    Returns:
    Vector
  - toVector
```
public Vector toVector(double y)
```
    Creates a 3D vector by adding the specified Y component to this vector.
    
    Returns:
    Vector
  - getMinimum
```
public static Vector2D getMinimum(Vector2D v1,
                  Vector2D v2)
```
    Gets the minimum components of two vectors.
    
    Parameters:
    v1 -
    v2 -
    
    Returns:
    minimum
  - getMaximum
```
public static Vector2D getMaximum(Vector2D v1,
                  Vector2D v2)
```
    Gets the maximum components of two vectors.
    
    Parameters:
    v1 -
    v2 -
    
    Returns:
    maximum

Class Vector2D

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ZERO

UNIT_X

UNIT_Z

ONE

x

z

Constructor Detail

Vector2D

Vector2D

Vector2D

Vector2D

Vector2D

Method Detail

getX

getBlockX

setX

setX

getZ

getBlockZ

setZ

setZ

add

add

add

add

subtract

subtract

subtract

subtract

multiply

multiply

multiply

multiply

multiply

multiply

multiply

divide

divide

divide

divide

divide

divide

length

lengthSq

distance

distanceSq

normalize

dot

containedWithin

containedWithinBlock

floor

ceil

round

positive

transform2D

isCollinearWith

toBlockVector2D

equals

hashCode

toString

toVector

toVector

getMinimum

getMaximum