kiteqr/io.github.yuroyami.kiteqr.common/BitMatrix

BitMatrix

Represents a 2D matrix of bits. In function arguments below, and throughout the common module, x is the column position, and y is the row position. The ordering is always x, y. The origin is at the top-left.

Internally the bits are represented in a 1-D array of 32-bit ints. However, each row begins with a new int. This is done intentionally so that we can copy out a row into a BitArray very efficiently.

The ordering of bits is row-major. Within each int, the least significant bits are used first, meaning they represent lower x values. This is compatible with BitArray's implementation.

Constructors

BitMatrix

constructor(dimension: Int)

Creates an empty square BitMatrix.

constructor(width: Int, height: Int)

Creates an empty BitMatrix.

Types

Companion

object Companion

Functions

clear

fun clear()

Clears all bits (sets to false).

clone

fun clone(): BitMatrix

equals

open operator override fun equals(other: Any?): Boolean

flip

fun flip()

Flips every bit in the matrix.

fun flip(x: Int, y: Int)

Flips the given bit.

get

fun get(x: Int, y: Int): Boolean

Gets the requested bit, where true means black.

getBottomRightOnBit

fun getBottomRightOnBit(): IntArray?

getEnclosingRectangle

fun getEnclosingRectangle(): IntArray?

This is useful in detecting the enclosing rectangle of a 'pure' barcode.

getHeight

fun getHeight(): Int

getRow

fun getRow(y: Int, row: BitArray?): BitArray

A fast method to retrieve one row of data from the matrix as a BitArray.

getRowSize

fun getRowSize(): Int

getTopLeftOnBit

fun getTopLeftOnBit(): IntArray?

This is useful in detecting a corner of a 'pure' barcode.

getWidth

fun getWidth(): Int

hashCode

open override fun hashCode(): Int

rotate

fun rotate(degrees: Int)

Modifies this BitMatrix to represent the same but rotated the given degrees (0, 90, 180, 270)

rotate180

fun rotate180()

Modifies this BitMatrix to represent the same but rotated 180 degrees

rotate90

fun rotate90()

Modifies this BitMatrix to represent the same but rotated 90 degrees counterclockwise

set

fun set(x: Int, y: Int)

Sets the given bit to true.

setRegion

fun setRegion(left: Int, top: Int, width: Int, height: Int)

Sets a square region of the bit matrix to true.

setRow

fun setRow(y: Int, row: BitArray)

toPng

fun BitMatrix.toPng(scale: Int = 8, quietZone: Int = 4, dark: Int = 0, light: Int = 16777215): ByteArray

Renders a BitMatrix to PNG bytes via the dependency-free Png encoder.

toString

open override fun toString(): String

fun toString(setString: String, unsetString: String): String

fun ~~toString~~(setString: String, unsetString: String, lineSeparator: String): String

toSvg

fun BitMatrix.toSvg(moduleSize: Int = 10, quietZone: Int = 4, dark: String = "#000000", light: String? = "#FFFFFF"): String

Renders a BitMatrix to a standalone SVG string: true vector output, no rasteriser, no platform. Each dark module becomes a 1×1 path cell, so the whole symbol is a single <path>.

unset

fun unset(x: Int, y: Int)

xor

fun xor(mask: BitMatrix)

Exclusive-or (XOR): Flip the bit in this BitMatrix if the corresponding mask bit is set.