add core modules

Author: HSGamer

core/pom.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>io.github.projectunified</groupId>
+        <artifactId>block-util</artifactId>
+        <version>5.0.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>block-util-core</artifactId>
+    <name>BlockUtil Core</name>
+</project>

core/src/main/java/io/github/projectunified/blockutil/core/box/BlockBox.java

@@ -0,0 +1,197 @@
+package io.github.projectunified.blockutil.core.box;
+
+import java.util.Objects;
+
+/**
+ * A custom box to bound blocks
+ */
+public class BlockBox {
+    /**
+     * The minimum x coordinate
+     */
+    public final int minX;
+    /**
+     * The minimum y coordinate
+     */
+    public final int minY;
+    /**
+     * The minimum z coordinate
+     */
+    public final int minZ;
+    /**
+     * The maximum x coordinate
+     */
+    public final int maxX;
+    /**
+     * The maximum y coordinate
+     */
+    public final int maxY;
+    /**
+     * The maximum z coordinate
+     */
+    public final int maxZ;
+
+    /**
+     * Create a new block box
+     *
+     * @param x1 the first x
+     * @param y1 the first y
+     * @param z1 the first z
+     * @param x2 the second x
+     * @param y2 the second y
+     * @param z2 the second z
+     */
+    public BlockBox(int x1, int y1, int z1, int x2, int y2, int z2) {
+        minX = Math.min(x1, x2);
+        minY = Math.min(y1, y2);
+        minZ = Math.min(z1, z2);
+        maxX = Math.max(x1, x2);
+        maxY = Math.max(y1, y2);
+        maxZ = Math.max(z1, z2);
+    }
+
+    /**
+     * Create a new block box
+     *
+     * @param pos1 the first position
+     * @param pos2 the second position
+     */
+    public BlockBox(Position pos1, Position pos2) {
+        this((int) pos1.x, (int) pos1.y, (int) pos1.z, (int) pos2.x, (int) pos2.y, (int) pos2.z);
+    }
+
+    /**
+     * Create a new block box that increases the maximum position by the given offset
+     *
+     * @param x the x-axis offset
+     * @param y the y-axis offset
+     * @param z the z-axis offset
+     * @return the new box
+     */
+    public BlockBox expandMax(int x, int y, int z) {
+        return new BlockBox(min(), max().move(x, y, z));
+    }
+
+    /**
+     * Create a new block box that decreases the minimum position by the given offset
+     *
+     * @param x the x-axis offset
+     * @param y the y-axis offset
+     * @param z the z-axis offset
+     * @return the new box
+     */
+    public BlockBox expandMin(int x, int y, int z) {
+        return new BlockBox(min().move(-x, -y, -z), max());
+    }
+
+    /**
+     * Create a new block box that expands the minimum and maximum position by the given offset
+     *
+     * @param x the x-axis offset
+     * @param y the y-axis offset
+     * @param z the z-axis offset
+     * @return the new box
+     */
+    public BlockBox expand(int x, int y, int z) {
+        return expandMin(x, y, z).expandMax(x, y, z);
+    }
+
+    /**
+     * Create a new block box that increases the maximum position by one.
+     * Use this to include the block at the maximum position as a part of the box.
+     *
+     * @return the new box
+     */
+    public BlockBox maxInclusive() {
+        return expandMax(1, 1, 1);
+    }
+
+    /**
+     * Check if the location is in the box
+     *
+     * @param x the x
+     * @param y the y
+     * @param z the z
+     * @return true if it is in the box
+     */
+    public boolean contains(double x, double y, double z) {
+        return x >= minX && x <= maxX && y >= minY && y <= maxY && z >= minZ && z <= maxZ;
+    }
+
+    /**
+     * Check if the location is in the box
+     *
+     * @param pos the position
+     * @return true if it is in the box
+     */
+    public boolean contains(Position pos) {
+        return contains(pos.x, pos.y, pos.z);
+    }
+
+    /**
+     * Get the center of the box
+     *
+     * @return the center
+     */
+    public Position center() {
+        return new Position((minX + maxX) / 2.0, (minY + maxY) / 2.0, (minZ + maxZ) / 2.0);
+    }
+
+    /**
+     * Get the minimum position
+     *
+     * @return the minimum position
+     */
+    public Position min() {
+        return new Position(minX, minY, minZ);
+    }
+
+    /**
+     * Get the maximum position
+     *
+     * @return the maximum position
+     */
+    public Position max() {
+        return new Position(maxX, maxY, maxZ);
+    }
+
+    /**
+     * Get the X-size of the box
+     *
+     * @return the size
+     */
+    public double sizeX() {
+        return maxX - minX;
+    }
+
+    /**
+     * Get the Y-size of the box
+     *
+     * @return the size
+     */
+    public double sizeY() {
+        return maxY - minY;
+    }
+
+    /**
+     * Get the Z-size of the box
+     *
+     * @return the size
+     */
+    public double sizeZ() {
+        return maxZ - minZ;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        BlockBox blockBox = (BlockBox) o;
+        return minX == blockBox.minX && minY == blockBox.minY && minZ == blockBox.minZ && maxX == blockBox.maxX && maxY == blockBox.maxY && maxZ == blockBox.maxZ;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(minX, minY, minZ, maxX, maxY, maxZ);
+    }
+}

core/src/main/java/io/github/projectunified/blockutil/core/box/Position.java

@@ -0,0 +1,59 @@
+package io.github.projectunified.blockutil.core.box;
+
+import java.util.Objects;
+
+/**
+ * The immutable 3D position / location / vector
+ */
+public class Position {
+    /**
+     * The x-axis
+     */
+    public final double x;
+    /**
+     * The y-axis
+     */
+    public final double y;
+    /**
+     * The z-axis
+     */
+    public final double z;
+
+    /**
+     * Create a new {@link Position}
+     *
+     * @param x the x-axis
+     * @param y the y-axis
+     * @param z the z-axis
+     */
+    public Position(double x, double y, double z) {
+        this.x = x;
+        this.y = y;
+        this.z = z;
+    }
+
+    /**
+     * Create a new {@link Position} that offset from this position
+     *
+     * @param x the x-axis offset
+     * @param y the y-axis offset
+     * @param z the z-axis offset
+     * @return the new position
+     */
+    public Position move(double x, double y, double z) {
+        return new Position(this.x + x, this.y + y, this.z + z);
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        Position position = (Position) o;
+        return Double.compare(position.x, x) == 0 && Double.compare(position.y, y) == 0 && Double.compare(position.z, z) == 0;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(x, y, z);
+    }
+}

core/src/main/java/io/github/projectunified/blockutil/core/iterator/AbstractPositionIterator.java

@@ -0,0 +1,22 @@
+package io.github.projectunified.blockutil.core.iterator;
+
+import io.github.projectunified.blockutil.core.box.BlockBox;
+
+/**
+ * The abstract {@link PositionIterator} for {@link BlockBox}
+ */
+public abstract class AbstractPositionIterator implements PositionIterator {
+    /**
+     * The box
+     */
+    public final BlockBox box;
+
+    /**
+     * Create a new {@link AbstractPositionIterator}
+     *
+     * @param box the box
+     */
+    protected AbstractPositionIterator(BlockBox box) {
+        this.box = box;
+    }
+}

core/src/main/java/io/github/projectunified/blockutil/core/iterator/BasePositionIterator.java

@@ -0,0 +1,80 @@
+package io.github.projectunified.blockutil.core.iterator;
+
+import io.github.projectunified.blockutil.core.box.BlockBox;
+import io.github.projectunified.blockutil.core.box.Position;
+
+import java.util.NoSuchElementException;
+import java.util.concurrent.atomic.AtomicReference;
+
+/**
+ * The base {@link PositionIterator} for {@link BlockBox}
+ */
+public abstract class BasePositionIterator extends AbstractPositionIterator {
+    private final AtomicReference<Position> current;
+
+    /**
+     * Create a new {@link BasePositionIterator}
+     *
+     * @param box the box
+     */
+    protected BasePositionIterator(BlockBox box) {
+        super(box);
+        this.current = new AtomicReference<>();
+    }
+
+    /**
+     * Get the current {@link Position}
+     *
+     * @return the current position
+     */
+    public Position getCurrent() {
+        return this.current.get();
+    }
+
+    /**
+     * Get the initial {@link Position}
+     *
+     * @return the initial position
+     */
+    public abstract Position initial();
+
+    /**
+     * Get the next {@link Position}
+     *
+     * @param current the current position
+     * @return the next position
+     * @throws NoSuchElementException if there is no next position
+     */
+    public abstract Position getContinue(Position current) throws NoSuchElementException;
+
+    /**
+     * Check if there is a next {@link Position}
+     *
+     * @param current the current position
+     * @return true if there is a next position
+     */
+    public abstract boolean hasContinue(Position current);
+
+    @Override
+    public void reset() {
+        this.current.set(null);
+    }
+
+    @Override
+    public boolean hasNext() {
+        Position position = this.current.get();
+        return position == null || hasContinue(position);
+    }
+
+    @Override
+    public Position next() {
+        Position position = getCurrent();
+        if (position == null) {
+            position = initial();
+        } else {
+            position = getContinue(position);
+        }
+        this.current.set(position);
+        return position;
+    }
+}

core/src/main/java/io/github/projectunified/blockutil/core/iterator/PositionIterator.java

@@ -0,0 +1,15 @@
+package io.github.projectunified.blockutil.core.iterator;
+
+import io.github.projectunified.blockutil.core.box.Position;
+
+import java.util.Iterator;
+
+/**
+ * The {@link Iterator} for {@link Position}
+ */
+public interface PositionIterator extends Iterator<Position> {
+    /**
+     * Reset the iterator
+     */
+    void reset();
+}