Package xyz.calcugames.levelz.coord

Class CoordinateMatrix3D

java.lang.Object

xyz.calcugames.levelz.coord.CoordinateMatrix

xyz.calcugames.levelz.coord.CoordinateMatrix3D

All Implemented Interfaces:

Iterable<Coordinate>

public final class CoordinateMatrix3D
extends CoordinateMatrix

Represents a 3D matrix of coordinates.

Constructor Summary

Constructors

Constructor	Description
CoordinateMatrix3D(int minX, int maxX, int minY, int maxY, int minZ, int maxZ, Coordinate3D start)	Creates a new 3D matrix of coordinates.
CoordinateMatrix3D(int x, int y, int z, Coordinate3D start)	Creates a new 3D matrix of coordinates with minimum values of 0.

Method Summary

Modifier and Type	Method	Description
static @NotNull CoordinateMatrix3D	fromString(@NotNull String string)	Parses a string into a 3D matrix of coordinates.
Set<Coordinate3D>	getCoordinates()	Gets the coordinates in the matrix.
Coordinate3D	getStart()	Gets the starting coordinate of the matrix.
String	toString()	Gets the string version of this coordinate matrix.

Methods inherited from class xyz.calcugames.levelz.coord.CoordinateMatrix

equals, getDimension, hashCode, iterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

CoordinateMatrix3D

public CoordinateMatrix3D(int x,
 int y,
 int z,
 Coordinate3D start)

Creates a new 3D matrix of coordinates with minimum values of 0.

Parameters:

x - The x value.

y - The y value.

z - The z value.

start - The starting coordinate.

CoordinateMatrix3D

public CoordinateMatrix3D(int minX,
 int maxX,
 int minY,
 int maxY,
 int minZ,
 int maxZ,
 Coordinate3D start)

Creates a new 3D matrix of coordinates.

Parameters:

minX - The minimum x value.

maxX - The maximum x value.

minY - The minimum y value.

maxY - The maximum y value.

minZ - The minimum z value.

maxZ - The maximum z value.

start - The starting coordinate.

Method Details

getCoordinates

public Set<Coordinate3D> getCoordinates()

Description copied from class: CoordinateMatrix

Gets the coordinates in the matrix.

Specified by:

getCoordinates in class CoordinateMatrix

Returns:

The coordinates in the matrix.

getStart

public Coordinate3D getStart()

Description copied from class: CoordinateMatrix

Gets the starting coordinate of the matrix.

Specified by:

getStart in class CoordinateMatrix

Returns:

The starting coordinate of the matrix.

toString

public String toString()

Description copied from class: CoordinateMatrix

Gets the string version of this coordinate matrix.

Specified by:

toString in class CoordinateMatrix

Returns:

This Coordinate Matrix as a string, represented in LevelZ format.

fromString

@NotNull
public static @NotNull CoordinateMatrix3D fromString(@NotNull
 @NotNull String string)
                                              throws IllegalArgumentException

Parses a string into a 3D matrix of coordinates.

Parameters:

string - The string to parse.

Returns:

The parsed 3D matrix of coordinates.

Throws:

IllegalArgumentException - if the string is invalid