io.github.opencubicchunks.cubicchunks.api.util

Class CubePos

java.lang.Object

io.github.opencubicchunks.cubicchunks.api.util.CubePos

@ParametersAreNonnullByDefault
 @MethodsReturnNonnullByDefault
public class CubePos
extends java.lang.Object

Position of a cube.

Tall Worlds uses a column coordinate system (which is really just a cube coordinate system without the y-coordinate), a cube coordinate system, and two block coordinate systems, a cube-relative system, and a world absolute system.

It is important that the systems are kept separate. This class should be used whenever a cube coordinate is passed along, so that it is clear that cube coordinates are being used, and not block coordinates.

Additionally, I (Nick) like to use xRel, yRel, and zRel for the relative position of a block inside of a cube. In world space, I (Nick) refer to the coordinates as xAbs, yAbs, and zAbs.

This class also contains some helper methods to switch from/to block coordinates.

Field Summary

Fields

Modifier and Type	Field and Description
static CubePos	ZERO

Constructor Summary

Constructors

Constructor and Description
CubePos(int cubeX, int cubeY, int cubeZ)
CubePos(XYZAddressable addressable)

Method Summary

Modifier and Type	Method and Description
CubePos	above()
CubePos	add(int dx, int dy, int dz)
CubePos	below()
net.minecraft.util.math.ChunkPos	chunkPos()
boolean	containsBlock(net.minecraft.util.math.BlockPos pos)
int	distSquared(CubePos coords)
boolean	equals(java.lang.Object obj) Compares the CubeCoordinate against the given object.
void	forEachWithinRange(int range, java.util.function.Consumer<CubePos> action)
static CubePos	fromBlockCoords(net.minecraft.util.math.BlockPos pos)
static CubePos	fromBlockCoords(int blockX, int blockY, int blockZ)
static CubePos	fromEntity(net.minecraft.entity.Entity entity)
static CubePos	fromEntityCoords(double blockX, double blockY, double blockZ)
net.minecraft.util.math.BlockPos	getCenterBlockPos()
net.minecraft.util.math.BlockPos	getMaxBlockPos()
int	getMaxBlockX()
int	getMaxBlockY()
int	getMaxBlockZ()
net.minecraft.util.math.BlockPos	getMinBlockPos()
int	getMinBlockX()
int	getMinBlockY()
int	getMinBlockZ()
int	getX() Gets the x position of the cube in the world.
int	getXCenter() Gets the absolute position of the cube's center on the x axis.
int	getY() Gets the y position of the cube in the world.
int	getYCenter() Gets the absolute position of the cube's center on the y axis.
int	getZ() Gets the z position of the cube in the world.
int	getZCenter() Gets the absolute position of the cube's center on the z axis.
int	hashCode() Returns a specification compliant hashCode for this object.
net.minecraft.util.math.BlockPos	localToBlock(int localX, int localY, int localZ)
net.minecraft.util.math.BlockPos	randomPopulationPos(java.util.Random rand)
CubePos	sub(int dx, int dy, int dz)
java.lang.String	toString() Gets the coordinates of the cube as a string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZERO

public static final CubePos ZERO

Constructor Detail

CubePos

public CubePos(int cubeX,
               int cubeY,
               int cubeZ)

CubePos

public CubePos(XYZAddressable addressable)

Method Detail

getX

public int getX()

Gets the x position of the cube in the world.

Returns:

The x position.

getY

public int getY()

Gets the y position of the cube in the world.

Returns:

The y position.

getZ

public int getZ()

Gets the z position of the cube in the world.

Returns:

The z position.

toString

public java.lang.String toString()

Gets the coordinates of the cube as a string.

Overrides:

toString in class java.lang.Object

Returns:

The coordinates, formatted as a string.

equals

public boolean equals(@Nullable
                      java.lang.Object obj)

Compares the CubeCoordinate against the given object.

Overrides:

equals in class java.lang.Object

Returns:

True if the cube matches the given object, but false if it doesn't match, or is null, or not a CubeCoordinate object.

hashCode

public int hashCode()

Returns a specification compliant hashCode for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

A 32bit hashCode for this instance of CubePos.

getXCenter

public int getXCenter()

Gets the absolute position of the cube's center on the x axis.

Returns:

The x center of the cube.

getYCenter

public int getYCenter()

Gets the absolute position of the cube's center on the y axis.

Returns:

The y center of the cube.

getZCenter

public int getZCenter()

Gets the absolute position of the cube's center on the z axis.

Returns:

The z center of the cube.

getMinBlockX

public int getMinBlockX()

getMinBlockY

public int getMinBlockY()

getMinBlockZ

public int getMinBlockZ()

getMaxBlockX

public int getMaxBlockX()

getMaxBlockY

public int getMaxBlockY()

getMaxBlockZ

public int getMaxBlockZ()

getCenterBlockPos

public net.minecraft.util.math.BlockPos getCenterBlockPos()

getMinBlockPos

public net.minecraft.util.math.BlockPos getMinBlockPos()

getMaxBlockPos

public net.minecraft.util.math.BlockPos getMaxBlockPos()

localToBlock

public net.minecraft.util.math.BlockPos localToBlock(int localX,
                                                     int localY,
                                                     int localZ)

sub

public CubePos sub(int dx,
                   int dy,
                   int dz)

add

public CubePos add(int dx,
                   int dy,
                   int dz)

chunkPos

public net.minecraft.util.math.ChunkPos chunkPos()

distSquared

public int distSquared(CubePos coords)

forEachWithinRange

public void forEachWithinRange(int range,
                               java.util.function.Consumer<CubePos> action)

randomPopulationPos

public net.minecraft.util.math.BlockPos randomPopulationPos(java.util.Random rand)

above

public CubePos above()

below

public CubePos below()

fromBlockCoords

public static CubePos fromBlockCoords(int blockX,
                                      int blockY,
                                      int blockZ)

fromEntityCoords

public static CubePos fromEntityCoords(double blockX,
                                       double blockY,
                                       double blockZ)

fromEntity

public static CubePos fromEntity(net.minecraft.entity.Entity entity)

fromBlockCoords

public static CubePos fromBlockCoords(net.minecraft.util.math.BlockPos pos)

containsBlock

public boolean containsBlock(net.minecraft.util.math.BlockPos pos)