Size3D

data class Size3D : Comparable<Size3D>

Represents the size of a 3D space. Extends org.hexworks.zircon.api.data.Size with a zLength (z axis) dimension. Explanation: ^ (zLength, z axis, positive direction)



O---------> (xLength, x axis, positive direction) / / / L (yLength, y axis, positive direction)

Types

Companion
Link copied to clipboard
common
object Companion

Functions

compareTo
Link copied to clipboard
common
open operator override fun compareTo(other: Size3D): Int
component1
Link copied to clipboard
common
operator fun component1(): Int
component2
Link copied to clipboard
common
operator fun component2(): Int
component3
Link copied to clipboard
common
operator fun component3(): Int
containsPosition
Link copied to clipboard
common
fun containsPosition(position: Position3D): Boolean
Tells whether this Size3D contains the given Position3D.
copy
Link copied to clipboard
common
fun copy(xLength: Int, yLength: Int, zLength: Int): Size3D
equals
Link copied to clipboard
common
open operator override fun equals(other: Any?): Boolean
fetchPositions
Link copied to clipboard
common
fun fetchPositions(): Sequence<Position3D>
Creates a collection of Position3Ds in the order in which they should be iterated when drawing:
  • from bottom to top (z axis),

  • from furthest to closest (y axis),

  • from left to right (x axis)

hashCode
Link copied to clipboard
common
open override fun hashCode(): Int
minus
Link copied to clipboard
common
operator fun minus(other: Size3D): Size3D
plus
Link copied to clipboard
common
operator fun plus(other: Size3D): Size3D
to2DSize
Link copied to clipboard
common
fun to2DSize(): Size
Transforms this Size3D to a Size.
toString
Link copied to clipboard
common
open override fun toString(): String

Properties

xLength
Link copied to clipboard
common
val xLength: Int
yLength
Link copied to clipboard
common
val yLength: Int
zLength
Link copied to clipboard
common
val zLength: Int

Sources

(source)
Link copied to clipboard