Vector3i (Rising World Plugin API)

java.lang.Object
- net.risingworld.api.utils.Vector3i

```
public class Vector3i
extends java.lang.Object
```
A Vector which holds three int values: X, Y and Z
It can be used to represent a three dimensional value, like an integer position (e.g. a block position or a chunk offset).

Field Summary

Fields
Modifier and Type	Field and Description
`static Vector3i`	`UNIT_X` A unit vector along the X axis
`static Vector3i`	`UNIT_Y` A unit vector along the Y axis
`static Vector3i`	`UNIT_Z` A unit vector along the Z axis
`int`	`x` The integer X value of this vector
`int`	`y` The integer Y value of this vector
`int`	`z` The integer Z value of this vector
`static Vector3i`	`ZERO` A vector with values 0, 0, 0

Constructor Summary

Constructors
Constructor and Description
`Vector3i()` Creates a new Vector3i with default values 0, 0, 0.
`Vector3i(int x, int y, int z)` Creates a new Vector3i with the provided int values.
`Vector3i(Vector3i copy)` Creates a new Vector3i and copies the X, Y and Z values from the provided vector.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Vector3i`	`addLocal(int addX, int addY, int addZ)` Adds the provided values to the values of this vector.
`Vector3i`	`addLocal(Vector3i other)` Adds the values of the provided vector to the values of this vector.
`float`	`angleBetween(Vector3i other)` Gets the angle between this vector and another vector.
`Vector3i`	`crossLocal(int v2x, int v2y, int v2z)` Calculates the cross product of this vector and the provided coordinates.
`Vector3i`	`crossLocal(Vector3i other)` Calculates the cross product of this vector and another vector.
`float`	`distance(int x, int y, int z)` Gets the distance between this vector and the provided coordinates.
`float`	`distance(Vector3i other)` Gets the distance between this vector and another vector.
`float`	`distanceSquared(int x, int y, int z)` Gets the squared distance between this vector and the provided coordinates.
`float`	`distanceSquared(Vector3i other)` Gets the squared distance between this vector and another Vector3i.
`Vector3i`	`divideLocal(int scalar)`
`Vector3i`	`divideLocal(Vector3i other)`
`float`	`dot(int x, int y, int z)` Gets the dot product of this vector with the provided coordinates.
`float`	`dot(Vector3i other)` Gets the dot product of this vector with the provided vector.
`boolean`	`equals(int x, int y, int z)`
`boolean`	`equals(java.lang.Object o)` Gets whether or not this vector is equal to another object.
`int`	`getX()` Returns the x value of this vector.
`int`	`getY()` Returns the y value of this vector.
`int`	`getZ()` Returns the z value of this vector.
`int`	`hashCode()` Gets a unique* hash code for this vector, based on its values.
`boolean`	`isOrthogonal(int x, int y, int z)` Checks if this vector is orthogonal to another vector (i.e. the angle between both vectors is ~ 90° degree).
`boolean`	`isOrthogonal(Vector3i other)` Checks if this vector is orthogonal to another vector (i.e. the angle between both vectors is ~ 90° degree).
`boolean`	`isUnitVector()` Checks if this vector is a unit vector.
`float`	`length()` Gets the length of this vector.
`float`	`lengthSquared()` Gets the squared length of this vector.
`Vector3i`	`multLocal(int scalar)` Multiplies the values of this vector with the provided scalar.
`Vector3i`	`multLocal(int multX, int multY, int multZ)` Multiplies the values of this vector with the provided values.
`Vector3i`	`multLocal(Vector3i other)` Multiplies the values of this vector with the values of the provided vector.
`Vector3i`	`negateLocal()` Negates all values of this vector.
`Vector3i`	`normalizeLocal()` Normalizes this vector (i.e. turn it into a unit vector).
`Vector3i`	`set(int x, int y, int z)` Sets the x, y and z values of this vector to the provided int values.
`Vector3i`	`set(Vector3i vector)` Sets the x, y and z values of this vector to the values of the provided vector.
`Vector3i`	`setX(int x)` Sets the x value of this vector.
`Vector3i`	`setY(int y)` Sets the y value of this vector.
`Vector3i`	`setZ(int z)` Sets the z value of this vector.
`Vector3i`	`subtractLocal(int subtractX, int subtractY, int subtractZ)` Subtracts the provided values from the values of this vector.
`Vector3i`	`subtractLocal(Vector3i other)` Subtracts the values of the provided vector from the values of this vector.
`java.lang.String`	`toString()` Gets a String representation of this vector, for example `(23, -5)`
`Vector3i`	`zero()` Sets all values to 0 (same set `set(0, 0, 0);`).

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

- Field Detail
  - ZERO
```
public static final Vector3i ZERO
```
    A vector with values 0, 0, 0
  - UNIT_X
```
public static final Vector3i UNIT_X
```
    A unit vector along the X axis
  - UNIT_Y
```
public static final Vector3i UNIT_Y
```
    A unit vector along the Y axis
  - UNIT_Z
```
public static final Vector3i UNIT_Z
```
    A unit vector along the Z axis
  - x
```
public int x
```
    The integer X value of this vector
  - y
```
public int y
```
    The integer Y value of this vector
  - z
```
public int z
```
    The integer Z value of this vector
- Constructor Detail
  - Vector3i
```
public Vector3i()
```
    Creates a new Vector3i with default values 0, 0, 0.
  - Vector3i
```
public Vector3i(int x,
                int y,
                int z)
```
    Creates a new Vector3i with the provided int values.
    
    Parameters:
    
    x - the x value of the vector.
    
    y - the y value of the vector.
    
    z - the z value of the vector.
  - Vector3i
```
public Vector3i(Vector3i copy)
```
    Creates a new Vector3i and copies the X, Y and Z values from the provided vector.
    
    Parameters:
    
    copy - the Vector3i to copy.
- Method Detail
  - set
```
public Vector3i set(Vector3i vector)
```
    Sets the x, y and z values of this vector to the values of the provided vector.
    
    Parameters:
    
    vector - the Vector3i to copy.
    
    Returns:
    
    this vector.
  - set
```
public Vector3i set(int x,
                    int y,
                    int z)
```
    Sets the x, y and z values of this vector to the provided int values.
    
    Parameters:
    
    x - the x value.
    
    y - the y value.
    
    z - the z value.
    
    Returns:
    
    this vector.
  - setX
```
public Vector3i setX(int x)
```
    Sets the x value of this vector.
    
    Parameters:
    
    x - the new x value.
    
    Returns:
    
    this vector.
  - setY
```
public Vector3i setY(int y)
```
    Sets the y value of this vector.
    
    Parameters:
    
    y - the new y value.
    
    Returns:
    
    this vector.
  - setZ
```
public Vector3i setZ(int z)
```
    Sets the z value of this vector.
    
    Parameters:
    
    z - the new z value.
    
    Returns:
    
    this vector.
  - getX
```
public int getX()
```
    Returns the x value of this vector.
    
    Returns:
    
    the current x value.
  - getY
```
public int getY()
```
    Returns the y value of this vector.
    
    Returns:
    
    the current y value.
  - getZ
```
public int getZ()
```
    Returns the z value of this vector.
    
    Returns:
    
    the current z value.
  - dot
```
public float dot(Vector3i other)
```
    Gets the dot product of this vector with the provided vector.
    
    Parameters:
    
    other - the vector to calculate the dot product with.
    
    Returns:
    
    the resulting dot product.
  - dot
```
public float dot(int x,
                 int y,
                 int z)
```
    Gets the dot product of this vector with the provided coordinates.
    
    Parameters:
    
    x - the x coordinate.
    
    y - the y coordinate.
    
    z - the z coordinate.
    
    Returns:
    
    the resulting dot product.
  - length
```
public float length()
```
    Gets the length of this vector.
    
    Returns:
    
    the length of this vector.
    
    See Also:
    
    lengthSquared()
  - lengthSquared
```
public float lengthSquared()
```
    Gets the squared length of this vector. Use this function to avoid calculating the squareroot.
    
    Returns:
    
    the squared length of this vector.
    
    See Also:
    
    length()
  - distance
```
public float distance(Vector3i other)
```
    Gets the distance between this vector and another vector.
    
    Parameters:
    
    other - the other vector.
    
    Returns:
    
    the distance between this vector and another vector.
    
    See Also:
    
    distanceSquared(Vector3i)
  - distance
```
public float distance(int x,
                      int y,
                      int z)
```
    Gets the distance between this vector and the provided coordinates.
    
    Parameters:
    
    x - the other x coordinate.
    
    y - the other y coordinate.
    
    z - the other z coordinate.
    
    Returns:
    
    the distance between this vector and the provided coordinates.
    
    See Also:
    
    distanceSquared(int, int, int)
  - distanceSquared
```
public float distanceSquared(Vector3i other)
```
    Gets the squared distance between this vector and another Vector3i. Use this function to avoid calculating the squareroot.
    
    Parameters:
    
    other - the other Vector3i.
    
    Returns:
    
    the squared distance between this vector and the provided Vector3i.
  - distanceSquared
```
public float distanceSquared(int x,
                             int y,
                             int z)
```
    Gets the squared distance between this vector and the provided coordinates. Use this function to avoid calculating the squareroot.
    
    Parameters:
    
    x - the other x coordinate.
    
    y - the other y coordinate.
    
    z - the other z coordinate.
    
    Returns:
    
    the squared distance between this vector and the provided coordinates.
  - addLocal
```
public Vector3i addLocal(Vector3i other)
```
    Adds the values of the provided vector to the values of this vector.
    
    Parameters:
    
    other - the vector to add.
    
    Returns:
    
    this vector.
  - addLocal
```
public Vector3i addLocal(int addX,
                         int addY,
                         int addZ)
```
    Adds the provided values to the values of this vector.
    
    Parameters:
    
    addX - the x value to add.
    
    addY - the y value to add.
    
    addZ - the z value to add.
    
    Returns:
    
    this vector.
  - subtractLocal
```
public Vector3i subtractLocal(Vector3i other)
```
    Subtracts the values of the provided vector from the values of this vector.
    
    Parameters:
    
    other - the vector to subtract.
    
    Returns:
    
    this vector.
  - subtractLocal
```
public Vector3i subtractLocal(int subtractX,
                              int subtractY,
                              int subtractZ)
```
    Subtracts the provided values from the values of this vector.
    
    Parameters:
    
    subtractX - the x value to subtract.
    
    subtractY - the y value to subtract.
    
    subtractZ - the z value to subtract.
    
    Returns:
    
    this vector.
  - multLocal
```
public Vector3i multLocal(int scalar)
```
    Multiplies the values of this vector with the provided scalar.
    
    Parameters:
    
    scalar - the value to multiply this vector by.
    
    Returns:
    
    this vector.
  - multLocal
```
public Vector3i multLocal(Vector3i other)
```
    Multiplies the values of this vector with the values of the provided vector.
    
    Parameters:
    
    other - the vector to multiply.
    
    Returns:
    
    this vector.
  - multLocal
```
public Vector3i multLocal(int multX,
                          int multY,
                          int multZ)
```
    Multiplies the values of this vector with the provided values.
    
    Parameters:
    
    multX - the x value to multiply the x coordinate of this vector by.
    
    multY - the y value to multiply the y coordinate of this vector by.
    
    multZ - the z value to multiply the z coordinate of this vector by.
    
    Returns:
    
    this vector.
  - divideLocal
```
public Vector3i divideLocal(int scalar)
```
  - divideLocal
```
public Vector3i divideLocal(Vector3i other)
```
  - negateLocal
```
public Vector3i negateLocal()
```
    Negates all values of this vector.
    
    Returns:
    
    this vector.
  - crossLocal
```
public Vector3i crossLocal(Vector3i other)
```
    Calculates the cross product of this vector and another vector.
    
    Parameters:
    
    other - the other vector.
    
    Returns:
    
    this vector.
  - crossLocal
```
public Vector3i crossLocal(int v2x,
                           int v2y,
                           int v2z)
```
    Calculates the cross product of this vector and the provided coordinates.
    
    Parameters:
    
    v2x - the other x coordinate.
    
    v2y - the other y coordinate.
    
    v2z - the other z coordinate.
    
    Returns:
    
    this vector.
  - normalizeLocal
```
public Vector3i normalizeLocal()
```
    Normalizes this vector (i.e. turn it into a unit vector).
    
    Returns:
    
    this vector (normalized).
  - angleBetween
```
public float angleBetween(Vector3i other)
```
    Gets the angle between this vector and another vector.
    Please note: Both vectors need to be unit vectors (normalized).
    
    Parameters:
    
    other - the other vector (unit vector).
    
    Returns:
    
    the angle in radians.
  - zero
```
public Vector3i zero()
```
    Sets all values to 0 (same set set(0, 0, 0);).
    
    Returns:
    
    this vector.
  - isUnitVector
```
public boolean isUnitVector()
```
    Checks if this vector is a unit vector.
    
    Returns:
    
    true if this is a unit vector, false if not.
  - isOrthogonal
```
public boolean isOrthogonal(Vector3i other)
```
    Checks if this vector is orthogonal to another vector (i.e. the angle between both vectors is ~ 90° degree).
    
    Parameters:
    
    other - the other vector.
    
    Returns:
    
    true if this vector is orthogonal to the other vector, false if not.
  - isOrthogonal
```
public boolean isOrthogonal(int x,
                            int y,
                            int z)
```
    Checks if this vector is orthogonal to another vector (i.e. the angle between both vectors is ~ 90° degree).
    
    Parameters:
    
    x - the x coordinate of the other vector.
    
    y - the y coordinate of the other vector.
    
    z - the z coordinate of the other vector.
    
    Returns:
    
    true if this vector is orthogonal to the other vector, false if not.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Gets whether or not this vector is equal to another object. This function returns true, if the other object is a Vector3i and if it has exactly the same x, y and z values.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - the object to compare to equality.
    
    Returns:
    
    true if the other object is a Vector3i and has the same values as this vector, false if not.
  - equals
```
public boolean equals(int x,
                      int y,
                      int z)
```
  - hashCode
```
public int hashCode()
```
    Gets a unique* hash code for this vector, based on its values. If two vectors have the same x, y and z values, they will return the same hash code.
    
    * Please keep in mind that the uniqueness is not fully reliable. There is always a small chance that collisions occur (i.e. two completely different vectors return the same hash code). But usually the reliability is sufficient.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hash code for this vector.
  - toString
```
public java.lang.String toString()
```
    Gets a String representation of this vector, for example (23, -5)
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representing the values of this vector.

Class Vector3i

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ZERO

UNIT_X

UNIT_Y

UNIT_Z

x

y

z

Constructor Detail

Vector3i

Vector3i

Vector3i

Method Detail

set

set

setX

setY

setZ

getX

getY

getZ

dot

dot

length

lengthSquared

distance

distance

distanceSquared

distanceSquared

addLocal

addLocal

subtractLocal

subtractLocal

multLocal

multLocal

multLocal

divideLocal

divideLocal

negateLocal

crossLocal

crossLocal

normalizeLocal

angleBetween

zero

isUnitVector

isOrthogonal

isOrthogonal

equals

equals

hashCode

toString