BlockVector3 (worldedit-core 7.2.0 API)

java.lang.Object
- com.sk89q.worldedit.math.BlockVector3

public final class BlockVector3
extends java.lang.Object

An immutable 3-dimensional vector.

Field Summary

Fields
Modifier and Type	Field and Description
`static BlockVector3`	`ONE`
`static BlockVector3`	`UNIT_MINUS_X`
`static BlockVector3`	`UNIT_MINUS_Y`
`static BlockVector3`	`UNIT_MINUS_Z`
`static BlockVector3`	`UNIT_X`
`static BlockVector3`	`UNIT_Y`
`static BlockVector3`	`UNIT_Z`
`static BlockVector3`	`ZERO`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BlockVector3`	`abs()` Returns a vector with the absolute values of the components of this vector.
`BlockVector3`	`add(BlockVector3... others)` Add a list of vectors to this vector and return the result as a new vector.
`BlockVector3`	`add(BlockVector3 other)` Add another vector to this vector and return the result as a new vector.
`BlockVector3`	`add(int x, int y, int z)` Add another vector to this vector and return the result as a new vector.
`static BlockVector3`	`at(double x, double y, double z)`
`static BlockVector3`	`at(int x, int y, int z)`
`BlockVector3`	`ceil()` Rounds all components up.
`static void`	`checkLongPackable(BlockVector3 location)`
`BlockVector3`	`clampY(int min, int max)` Clamp the Y component.
`boolean`	`containedWithin(BlockVector3 min, BlockVector3 max)` Checks to see if a vector is contained with another.
`BlockVector3`	`cross(BlockVector3 other)` Gets the cross product of this and another vector.
`double`	`distance(BlockVector3 other)` Get the distance between this vector and another vector.
`int`	`distanceSq(BlockVector3 other)` Get the distance between this vector and another vector, squared.
`BlockVector3`	`divide(BlockVector3 other)` Divide this vector by another vector on each component.
`BlockVector3`	`divide(int n)` Perform scalar division and return a new vector.
`BlockVector3`	`divide(int x, int y, int z)` Divide this vector by another vector on each component.
`double`	`dot(BlockVector3 other)` Gets the dot product of this and another vector.
`boolean`	`equals(java.lang.Object obj)`
`BlockVector3`	`floor()` Floors the values of all components.
`static BlockVector3`	`fromLongPackedForm(long packed)`
`int`	`getBlockX()` Get the X coordinate.
`int`	`getBlockY()` Get the Y coordinate.
`int`	`getBlockZ()` Get the Z coordinate.
`BlockVector3`	`getMaximum(BlockVector3 v2)` Gets the maximum components of two vectors.
`BlockVector3`	`getMinimum(BlockVector3 v2)` Gets the minimum components of two vectors.
`int`	`getX()` Get the X coordinate.
`int`	`getY()` Get the Y coordinate.
`int`	`getZ()` Get the Z coordinate.
`int`	`hashCode()`
`static boolean`	`isLongPackable(BlockVector3 location)`
`double`	`length()` Get the length of the vector.
`int`	`lengthSq()` Get the length, squared, of the vector.
`BlockVector3`	`multiply(BlockVector3... others)` Multiply this vector by zero or more vectors on each component.
`BlockVector3`	`multiply(BlockVector3 other)` Multiply this vector by another vector on each component.
`BlockVector3`	`multiply(int n)` Perform scalar multiplication and return a new vector.
`BlockVector3`	`multiply(int x, int y, int z)` Multiply this vector by another vector on each component.
`BlockVector3`	`normalize()` Get the normalized vector, which is the vector divided by its length, as a new vector.
`BlockVector3`	`round()` Rounds all components to the closest integer.
`BlockVector3`	`shl(int n)` Shift all components left by `n`.
`BlockVector3`	`shl(int x, int y, int z)` Shift all components left.
`BlockVector3`	`shr(int n)` Shift all components right by `n`.
`BlockVector3`	`shr(int x, int y, int z)` Shift all components right.
`static java.util.Comparator<BlockVector3>`	`sortByCoordsYzx()` Returns a comparator that sorts vectors first by Y, then Z, then X.
`BlockVector3`	`subtract(BlockVector3... others)` Subtract a list of vectors from this vector and return the result as a new vector.
`BlockVector3`	`subtract(BlockVector3 other)` Subtract another vector from this vector and return the result as a new vector.
`BlockVector3`	`subtract(int x, int y, int z)` Subtract another vector from this vector and return the result as a new vector.
`BlockVector2`	`toBlockVector2()` Creates a 2D vector by dropping the Y component from this vector.
`long`	`toLongPackedForm()`
`java.lang.String`	`toParserString()` Returns a string representation that is supported by the parser.
`double`	`toPitch()` Get this vector's pitch as used within the game.
`java.lang.String`	`toString()`
`Vector3`	`toVector3()`
`double`	`toYaw()` Get this vector's yaw as used within the game.
`BlockVector3`	`transform2D(double angle, double aboutX, double aboutZ, double translateX, double translateZ)` Perform a 2D transformation on this vector and return a new one.
`BlockVector3`	`withX(int x)` Set the X coordinate.
`BlockVector3`	`withY(int y)` Set the Y coordinate.
`BlockVector3`	`withZ(int z)` Set the Z coordinate.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ZERO
```
public static final BlockVector3 ZERO
```
  - UNIT_X
```
public static final BlockVector3 UNIT_X
```
  - UNIT_Y
```
public static final BlockVector3 UNIT_Y
```
  - UNIT_Z
```
public static final BlockVector3 UNIT_Z
```
  - UNIT_MINUS_X
```
public static final BlockVector3 UNIT_MINUS_X
```
  - UNIT_MINUS_Y
```
public static final BlockVector3 UNIT_MINUS_Y
```
  - UNIT_MINUS_Z
```
public static final BlockVector3 UNIT_MINUS_Z
```
  - ONE
```
public static final BlockVector3 ONE
```
- Method Detail
  - at
```
public static BlockVector3 at(double x,
                              double y,
                              double z)
```
  - at
```
public static BlockVector3 at(int x,
                              int y,
                              int z)
```
  - isLongPackable
```
public static boolean isLongPackable(BlockVector3 location)
```
  - checkLongPackable
```
public static void checkLongPackable(BlockVector3 location)
```
  - fromLongPackedForm
```
public static BlockVector3 fromLongPackedForm(long packed)
```
  - sortByCoordsYzx
```
public static java.util.Comparator<BlockVector3> sortByCoordsYzx()
```
    Returns a comparator that sorts vectors first by Y, then Z, then X.
    Useful for sorting by chunk block storage order.
  - toLongPackedForm
```
public long toLongPackedForm()
```
  - getX
```
public int getX()
```
    Get the X coordinate.
    
    Returns:
    
    the x coordinate
  - getBlockX
```
public int getBlockX()
```
    Get the X coordinate.
    
    Returns:
    
    the x coordinate
  - withX
```
public BlockVector3 withX(int x)
```
    Set the X coordinate.
    
    Parameters:
    
    x - the new X
    
    Returns:
    
    a new vector
  - getY
```
public int getY()
```
    Get the Y coordinate.
    
    Returns:
    
    the y coordinate
  - getBlockY
```
public int getBlockY()
```
    Get the Y coordinate.
    
    Returns:
    
    the y coordinate
  - withY
```
public BlockVector3 withY(int y)
```
    Set the Y coordinate.
    
    Parameters:
    
    y - the new Y
    
    Returns:
    
    a new vector
  - getZ
```
public int getZ()
```
    Get the Z coordinate.
    
    Returns:
    
    the z coordinate
  - getBlockZ
```
public int getBlockZ()
```
    Get the Z coordinate.
    
    Returns:
    
    the z coordinate
  - withZ
```
public BlockVector3 withZ(int z)
```
    Set the Z coordinate.
    
    Parameters:
    
    z - the new Z
    
    Returns:
    
    a new vector
  - add
```
public BlockVector3 add(BlockVector3 other)
```
    Add another vector to this vector and return the result as a new vector.
    
    Parameters:
    
    other - the other vector
    
    Returns:
    
    a new vector
  - add
```
public BlockVector3 add(int x,
                        int y,
                        int z)
```
    Add another vector to this vector and return the result as a new vector.
    
    Parameters:
    
    x - the value to add
    
    y - the value to add
    
    z - the value to add
    
    Returns:
    
    a new vector
  - add
```
public BlockVector3 add(BlockVector3... others)
```
    Add a list of vectors to this vector and return the result as a new vector.
    
    Parameters:
    
    others - an array of vectors
    
    Returns:
    
    a new vector
  - subtract
```
public BlockVector3 subtract(BlockVector3 other)
```
    Subtract another vector from this vector and return the result as a new vector.
    
    Parameters:
    
    other - the other vector
    
    Returns:
    
    a new vector
  - subtract
```
public BlockVector3 subtract(int x,
                             int y,
                             int z)
```
    Subtract another vector from this vector and return the result as a new vector.
    
    Parameters:
    
    x - the value to subtract
    
    y - the value to subtract
    
    z - the value to subtract
    
    Returns:
    
    a new vector
  - subtract
```
public BlockVector3 subtract(BlockVector3... others)
```
    Subtract a list of vectors from this vector and return the result as a new vector.
    
    Parameters:
    
    others - an array of vectors
    
    Returns:
    
    a new vector
  - multiply
```
public BlockVector3 multiply(BlockVector3 other)
```
    Multiply this vector by another vector on each component.
    
    Parameters:
    
    other - the other vector
    
    Returns:
    
    a new vector
  - multiply
```
public BlockVector3 multiply(int x,
                             int y,
                             int z)
```
    Multiply this vector by another vector on each component.
    
    Parameters:
    
    x - the value to multiply
    
    y - the value to multiply
    
    z - the value to multiply
    
    Returns:
    
    a new vector
  - multiply
```
public BlockVector3 multiply(BlockVector3... others)
```
    Multiply this vector by zero or more vectors on each component.
    
    Parameters:
    
    others - an array of vectors
    
    Returns:
    
    a new vector
  - multiply
```
public BlockVector3 multiply(int n)
```
    Perform scalar multiplication and return a new vector.
    
    Parameters:
    
    n - the value to multiply
    
    Returns:
    
    a new vector
  - divide
```
public BlockVector3 divide(BlockVector3 other)
```
    Divide this vector by another vector on each component.
    
    Parameters:
    
    other - the other vector
    
    Returns:
    
    a new vector
  - divide
```
public BlockVector3 divide(int x,
                           int y,
                           int z)
```
    Divide this vector by another vector on each component.
    
    Parameters:
    
    x - the value to divide by
    
    y - the value to divide by
    
    z - the value to divide by
    
    Returns:
    
    a new vector
  - divide
```
public BlockVector3 divide(int n)
```
    Perform scalar division and return a new vector.
    
    Parameters:
    
    n - the value to divide by
    
    Returns:
    
    a new vector
  - shr
```
public BlockVector3 shr(int x,
                        int y,
                        int z)
```
    Shift all components right.
    
    Parameters:
    
    x - the value to shift x by
    
    y - the value to shift y by
    
    z - the value to shift z by
    
    Returns:
    
    a new vector
  - shr
```
public BlockVector3 shr(int n)
```
    Shift all components right by n.
    
    Parameters:
    
    n - the value to shift by
    
    Returns:
    
    a new vector
  - shl
```
public BlockVector3 shl(int x,
                        int y,
                        int z)
```
    Shift all components left.
    
    Parameters:
    
    x - the value to shift x by
    
    y - the value to shift y by
    
    z - the value to shift z by
    
    Returns:
    
    a new vector
  - shl
```
public BlockVector3 shl(int n)
```
    Shift all components left by n.
    
    Parameters:
    
    n - the value to shift by
    
    Returns:
    
    a new vector
  - length
```
public double length()
```
    Get the length of the vector.
    
    Returns:
    
    length
  - lengthSq
```
public int lengthSq()
```
    Get the length, squared, of the vector.
    
    Returns:
    
    length, squared
  - distance
```
public double distance(BlockVector3 other)
```
    Get the distance between this vector and another vector.
    
    Parameters:
    
    other - the other vector
    
    Returns:
    
    distance
  - distanceSq
```
public int distanceSq(BlockVector3 other)
```
    Get the distance between this vector and another vector, squared.
    
    Parameters:
    
    other - the other vector
    
    Returns:
    
    distance
  - normalize
```
public BlockVector3 normalize()
```
    Get the normalized vector, which is the vector divided by its length, as a new vector.
    
    Returns:
    
    a new vector
  - dot
```
public double dot(BlockVector3 other)
```
    Gets the dot product of this and another vector.
    
    Parameters:
    
    other - the other vector
    
    Returns:
    
    the dot product of this and the other vector
  - cross
```
public BlockVector3 cross(BlockVector3 other)
```
    Gets the cross product of this and another vector.
    
    Parameters:
    
    other - the other vector
    
    Returns:
    
    the cross product of this and the other vector
  - containedWithin
```
public boolean containedWithin(BlockVector3 min,
                               BlockVector3 max)
```
    Checks to see if a vector is contained with another.
    
    Parameters:
    
    min - the minimum point (X, Y, and Z are the lowest)
    
    max - the maximum point (X, Y, and Z are the lowest)
    
    Returns:
    
    true if the vector is contained
  - clampY
```
public BlockVector3 clampY(int min,
                           int max)
```
    Clamp the Y component.
    
    Parameters:
    
    min - the minimum value
    
    max - the maximum value
    
    Returns:
    
    a new vector
  - floor
```
public BlockVector3 floor()
```
    Floors the values of all components.
    
    Returns:
    
    a new vector
  - ceil
```
public BlockVector3 ceil()
```
    Rounds all components up.
    
    Returns:
    
    a new vector
  - round
```
public BlockVector3 round()
```
    Rounds all components to the closest integer.
    Components < 0.5 are rounded down, otherwise up.
    
    Returns:
    
    a new vector
  - abs
```
public BlockVector3 abs()
```
    Returns a vector with the absolute values of the components of this vector.
    
    Returns:
    
    a new vector
  - transform2D
```
public BlockVector3 transform2D(double angle,
                                double aboutX,
                                double aboutZ,
                                double translateX,
                                double translateZ)
```
    Perform a 2D transformation on this vector and return a new one.
    
    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:
    
    a new vector
    
    See Also:
    
    another method to transform vectors
  - toPitch
```
public double toPitch()
```
    Get this vector's pitch as used within the game.
    
    Returns:
    
    pitch in radians
  - toYaw
```
public double toYaw()
```
    Get this vector's yaw as used within the game.
    
    Returns:
    
    yaw in radians
  - getMinimum
```
public BlockVector3 getMinimum(BlockVector3 v2)
```
    Gets the minimum components of two vectors.
    
    Parameters:
    
    v2 - the second vector
    
    Returns:
    
    minimum
  - getMaximum
```
public BlockVector3 getMaximum(BlockVector3 v2)
```
    Gets the maximum components of two vectors.
    
    Parameters:
    
    v2 - the second vector
    
    Returns:
    
    maximum
  - toBlockVector2
```
public BlockVector2 toBlockVector2()
```
    Creates a 2D vector by dropping the Y component from this vector.
    
    Returns:
    
    a new BlockVector2
  - toVector3
```
public Vector3 toVector3()
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toParserString
```
public java.lang.String toParserString()
```
    Returns a string representation that is supported by the parser.
    
    Returns:
    
    string

Class BlockVector3

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ZERO

UNIT_X

UNIT_Y

UNIT_Z

UNIT_MINUS_X

UNIT_MINUS_Y

UNIT_MINUS_Z

ONE

Method Detail

at

at

isLongPackable

checkLongPackable

fromLongPackedForm

sortByCoordsYzx

toLongPackedForm

getX

getBlockX

withX

getY

getBlockY

withY

getZ

getBlockZ

withZ

add

add

add

subtract

subtract

subtract

multiply

multiply

multiply

multiply

divide

divide

divide

shr

shr

shl

shl

length

lengthSq

distance

distanceSq

normalize

dot

cross

containedWithin

clampY

floor

ceil

round

abs

transform2D

toPitch

toYaw

getMinimum

getMaximum

toBlockVector2

toVector3

equals

hashCode

toString

toParserString