org.bukkit.util.BlockVector Maven / Gradle / Ivy

Go to download
package org.bukkit.util;

import org.bukkit.configuration.serialization.SerializableAs;

import java.util.Map;

/**
 * A vector with a hash function that floors the X, Y, Z components, a la
 * BlockVector in WorldEdit. BlockVectors can be used in hash sets and
 * hash maps. Be aware that BlockVectors are mutable, but it is important
 * that BlockVectors are never changed once put into a hash set or hash map.
 */
@SerializableAs("BlockVector")
public class BlockVector extends Vector {

  /**
   * Construct the vector with all components as 0.
   */
  public BlockVector() {
    this.x = 0;
    this.y = 0;
    this.z = 0;
  }

  /**
   * Construct the vector with another vector.
   *
   * @param vec The other vector.
   */
  public BlockVector(Vector vec) {
    this.x = vec.getX();
    this.y = vec.getY();
    this.z = vec.getZ();
  }

  /**
   * Construct the vector with provided integer components.
   *
   * @param x X component
   * @param y Y component
   * @param z Z component
   */
  public BlockVector(int x, int y, int z) {
    this.x = x;
    this.y = y;
    this.z = z;
  }

  /**
   * Construct the vector with provided double components.
   *
   * @param x X component
   * @param y Y component
   * @param z Z component
   */
  public BlockVector(double x, double y, double z) {
    this.x = x;
    this.y = y;
    this.z = z;
  }

  /**
   * Construct the vector with provided float components.
   *
   * @param x X component
   * @param y Y component
   * @param z Z component
   */
  public BlockVector(float x, float y, float z) {
    this.x = x;
    this.y = y;
    this.z = z;
  }

  public static BlockVector deserialize(Map args) {
    double x = 0;
    double y = 0;
    double z = 0;

    if (args.containsKey("x")) {
      x = (Double) args.get("x");
    }
    if (args.containsKey("y")) {
      y = (Double) args.get("y");
    }
    if (args.containsKey("z")) {
      z = (Double) args.get("z");
    }

    return new BlockVector(x, y, z);
  }

  /**
   * Checks if another object is equivalent.
   *
   * @param obj The other object
   * @return whether the other object is equivalent
   */
  @Override
  public boolean equals(Object obj) {
    if (!(obj instanceof BlockVector)) {
      return false;
    }
    BlockVector other = (BlockVector) obj;

    return (int) other.getX() == (int) this.x && (int) other.getY() == (int) this.y && (int) other.getZ() == (int) this.z;

  }

  /**
   * Returns a hash code for this vector.
   *
   * @return hash code
   */
  @Override
  public int hashCode() {
    return (Integer.valueOf((int) x).hashCode() >> 13) ^ (Integer.valueOf((int) y).hashCode() >> 7) ^ Integer.valueOf((int) z).hashCode();
  }

  /**
   * Get a new block vector.
   *
   * @return vector
   */
  @Override
  public BlockVector clone() {
    return (BlockVector) super.clone();
  }
}