com.googlecode.leptonica.android

Class Box

com.googlecode.leptonica.android.Box

public class Box

Wrapper for Leptonica's native BOX.

Field Detail

INDEX_X

public static int INDEX_X

The index of the X coordinate within the geometry array.

See Also:

Constant Field Values

INDEX_Y

public static int INDEX_Y

The index of the Y coordinate within the geometry array.

See Also:

Constant Field Values

INDEX_W

public static int INDEX_W

The index of the width within the geometry array.

See Also:

Constant Field Values

INDEX_H

public static int INDEX_H

The index of the height within the geometry array.

See Also:

Constant Field Values

Constructor Detail

Box

public Box(int x,
           int y,
           int w,
           int h)

Creates a box with the specified geometry. All dimensions should be non-negative and specified in pixels.

Parameters:

x - X-coordinate of the top-left corner of the box.

y - Y-coordinate of the top-left corner of the box.

w - Width of the box.

h - Height of the box.

Method Detail

getNativeBox

public long getNativeBox()

Returns a pointer to the native Box object.

Returns:

org.jetbrains.dokka.NodeRenderContent@1ddb6b87: a pointer to the native Box object

getX

public int getX()

Returns the box's x-coordinate in pixels.

Returns:

org.jetbrains.dokka.NodeRenderContent@6db0ffbf: The box's x-coordinate in pixels.

getY

public int getY()

Returns the box's y-coordinate in pixels.

Returns:

org.jetbrains.dokka.NodeRenderContent@75ddaac0: The box's y-coordinate in pixels.

getWidth

public int getWidth()

Returns the box's width in pixels.

Returns:

org.jetbrains.dokka.NodeRenderContent@71706b1: The box's width in pixels.

getHeight

public int getHeight()

Returns the box's height in pixels.

Returns:

org.jetbrains.dokka.NodeRenderContent@41d6d287: The box's height in pixels.

getRect

public android.graphics.Rect getRect()

Returns an android.graphics.Rect containing the coordinates of this box.

Returns:

org.jetbrains.dokka.NodeRenderContent@2bf19005: a rect representing the box

getGeometry

public kotlin.Array[] getGeometry()

Returns an array containing the coordinates of this box. See INDEX_* constants for indices.

Returns:

org.jetbrains.dokka.NodeRenderContent@33e2b411: an array of box coordinates

getGeometry

public boolean getGeometry(@Size
                           kotlin.Array[] geometry)

Fills an array containing the coordinates of this box. See INDEX_* constants for indices.

Parameters:

geometry - A 4+ element integer array to fill with coordinates.

Returns:

org.jetbrains.dokka.NodeRenderContent@c7f0e52: true on success

recycle

public void recycle()

Releases resources and frees any memory associated with this Box.

finalize

protected void finalize()