\Zxing\CommonBitMatrix

Summary

Methods
Properties
Constants
__construct()
parse()
set()
_unset()
flip()
_xor()
clear()
setRegion()
rotate180()
getWidth()
getRow()
setRow()
getEnclosingRectangle()
getTopLeftOnBit()
getBottomRightOnBit()
getHeight()
getRowSize()
equals()
hashCode()
toString()
toString_()
get()
_clone()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$width
$height
$rowSize
$bits
N/A

Properties

$width

$width

$height

$height

$rowSize

$rowSize

$bits

$bits

Methods

__construct()

__construct(mixed  $width, mixed  $height = false, mixed  $rowSize = false, mixed  $bits = false) : mixed

Parameters

mixed $width
mixed $height
mixed $rowSize
mixed $bits

Returns

mixed —

parse()

parse(mixed  $stringRepresentation, mixed  $setString, mixed  $unsetString) : mixed

Parameters

mixed $stringRepresentation
mixed $setString
mixed $unsetString

Returns

mixed —

set()

set( $x,  $y) : mixed

<p>Sets the given bit to true.</p>

Parameters

$x

; The horizontal component (i.e. which column)

$y

; The vertical component (i.e. which row)

Returns

mixed —

_unset()

_unset(mixed  $x, mixed  $y) : mixed

Parameters

mixed $x
mixed $y

Returns

mixed —

flip()

flip(mixed  $x, mixed  $y) : mixed

Parameters

mixed $x
mixed $y

Returns

mixed —

_xor()

_xor( $mask) : mixed

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

Parameters

$mask

; XOR mask

Returns

mixed —

clear()

clear() : mixed

Clears all bits (sets to false).

Returns

mixed —

setRegion()

setRegion( $left,  $top,  $width,  $height) : mixed

<p>Sets a square region of the bit matrix to true.</p>

Parameters

$left

; The horizontal position to begin at (inclusive)

$top

; The vertical position to begin at (inclusive)

$width

; The width of the region

$height

; The height of the region

Returns

mixed —

rotate180()

rotate180() : mixed

Modifies this {@code BitMatrix} to represent the same but rotated 180 degrees

Returns

mixed —

getWidth()

getWidth() : \Zxing\Common\The

Returns

\Zxing\Common\The —

width of the matrix

getRow()

getRow( $y,  $row) : \Zxing\Common\The

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

Parameters

$y

; The row to retrieve

$row

; An optional caller-allocated BitArray, will be allocated if null or too small

Returns

\Zxing\Common\The —

resulting BitArray - this reference should always be used even when passing your own row

setRow()

setRow( $y,  $row) : mixed

Parameters

$y

; row to set

$row

; {@link BitArray} to copy from

Returns

mixed —

getEnclosingRectangle()

getEnclosingRectangle() : mixed

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

Returns

mixed —

getTopLeftOnBit()

getTopLeftOnBit() : mixed

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

Returns

mixed —

getBottomRightOnBit()

getBottomRightOnBit() : mixed

Returns

mixed —

getHeight()

getHeight() : \Zxing\Common\The

Returns

\Zxing\Common\The —

height of the matrix

getRowSize()

getRowSize() : \Zxing\Common\The

Returns

\Zxing\Common\The —

row size of the matrix

equals()

equals(mixed  $o) : mixed

Parameters

mixed $o

Returns

mixed —

hashCode()

hashCode() : mixed

Returns

mixed —

toString()

toString(mixed  $setString = '', mixed  $unsetString = '', mixed  $lineSeparator = '') : mixed

Parameters

mixed $setString
mixed $unsetString
mixed $lineSeparator

Returns

mixed —

toString_()

toString_(mixed  $setString, mixed  $unsetString, mixed  $lineSeparator) : mixed

Parameters

mixed $setString
mixed $unsetString
mixed $lineSeparator

Returns

mixed —

get()

get( $x,  $y) : \Zxing\Common\value

<p>Gets the requested bit, where true means black.</p>

Parameters

$x

; The horizontal component (i.e. which column)

$y

; The vertical component (i.e. which row)

Returns

\Zxing\Common\value —

of given bit in matrix

_clone()

_clone() : mixed

Returns

mixed —