com.badlogic.gdx.graphics.g2d

Class NinePatch

java.lang.Object

com.badlogic.gdx.graphics.g2d.NinePatch

public class NinePatch
extends Object

A 3x3 grid of texture regions. Any of the regions may be omitted. Padding may be set as a hint on how to inset content on top of the ninepatch (by default the eight "edge" textures of the nine-patch define the padding). When drawn the eight "edge" patches will not be scaled, only the interior patch will be scaled.

NOTE: This class expects a "post-processed" nine-patch, and not a raw ".9.png" texture. That is, the textures given to this class should not include the meta-data pixels from a ".9.png" that describe the layout of the ninepatch over the interior of the graphic. That information should be passed into the constructor either implicitly as the size of the individual patch textures, or via the left, right, top, bottom parameters to NinePatch(Texture, int, int, int, int) or NinePatch(TextureRegion, int, int, int, int).

A correctly created TextureAtlas is one way to generate a post-processed nine-patch from a ".9.png" file.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOTTOM_CENTER Indices for NinePatch(TextureRegion...) constructor
static int	BOTTOM_LEFT
static int	BOTTOM_RIGHT
static int	MIDDLE_CENTER
static int	MIDDLE_LEFT
static int	MIDDLE_RIGHT
static int	TOP_CENTER
static int	TOP_LEFT
static int	TOP_RIGHT

Constructor Summary

Constructors

Constructor and Description
NinePatch(NinePatch ninePatch)
NinePatch(NinePatch ninePatch, Color color)
NinePatch(Texture texture) Construct a degenerate "nine" patch with only a center component.
NinePatch(Texture texture, Color color) Construct a degenerate "nine" patch with only a center component.
NinePatch(Texture texture, int left, int right, int top, int bottom) Create a ninepatch by cutting up the given texture into nine patches.
NinePatch(TextureRegion... patches) Construct a nine patch from the given nine texture regions.
NinePatch(TextureRegion region) Construct a degenerate "nine" patch with only a center component.
NinePatch(TextureRegion region, Color color) Construct a degenerate "nine" patch with only a center component.
NinePatch(TextureRegion region, int left, int right, int top, int bottom) Create a ninepatch by cutting up the given texture region into nine patches.

Method Summary

Methods

Modifier and Type	Method and Description
void	draw(Batch batch, float x, float y, float width, float height)
float	getBottomHeight()
Color	getColor()
float	getLeftWidth()
float	getMiddleHeight()
float	getMiddleWidth()
float	getPadBottom() Returns the bottom padding if set, else returns getBottomHeight().
float	getPadLeft() Returns the left padding if set, else returns getLeftWidth().
float	getPadRight() Returns the right padding if set, else returns getRightWidth().
float	getPadTop() Returns the top padding if set, else returns getTopHeight().
float	getRightWidth()
Texture	getTexture()
float	getTopHeight()
float	getTotalHeight()
float	getTotalWidth()
void	scale(float scaleX, float scaleY) Multiplies the top/left/bottom/right sizes and padding by the specified amount.
void	setBottomHeight(float bottomHeight) Set the draw-time height of the three bottom edge patches
void	setColor(Color color) Copy given color.
void	setLeftWidth(float leftWidth) Set the draw-time width of the three left edge patches
void	setMiddleHeight(float middleHeight) Set the height of the middle row of the patch.
void	setMiddleWidth(float middleWidth) Set the width of the middle column of the patch.
void	setPadBottom(int bottom) See setPadding(int, int, int, int)
void	setPadding(int left, int right, int top, int bottom) Set the padding for content inside this ninepatch.
void	setPadLeft(int left) See setPadding(int, int, int, int)
void	setPadRight(int right) See setPadding(int, int, int, int)
void	setPadTop(int top) See setPadding(int, int, int, int)
void	setRightWidth(float rightWidth) Set the draw-time width of the three right edge patches
void	setTopHeight(float topHeight) Set the draw-time height of the three top edge patches

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TOP_LEFT

public static final int TOP_LEFT

See Also:

Constant Field Values

TOP_CENTER

public static final int TOP_CENTER

See Also:

Constant Field Values

TOP_RIGHT

public static final int TOP_RIGHT

See Also:

Constant Field Values

MIDDLE_LEFT

public static final int MIDDLE_LEFT

See Also:

Constant Field Values

MIDDLE_CENTER

public static final int MIDDLE_CENTER

See Also:

Constant Field Values

MIDDLE_RIGHT

public static final int MIDDLE_RIGHT

See Also:

Constant Field Values

BOTTOM_LEFT

public static final int BOTTOM_LEFT

See Also:

Constant Field Values

BOTTOM_CENTER

public static final int BOTTOM_CENTER

Indices for NinePatch(TextureRegion...) constructor

See Also:

Constant Field Values

BOTTOM_RIGHT

public static final int BOTTOM_RIGHT

See Also:

Constant Field Values

Constructor Detail

NinePatch

public NinePatch(Texture texture,
         int left,
         int right,
         int top,
         int bottom)

Create a ninepatch by cutting up the given texture into nine patches. The subsequent parameters define the 4 lines that will cut the texture region into 9 pieces.

Parameters:

left - Pixels from left edge.

right - Pixels from right edge.

top - Pixels from top edge.

bottom - Pixels from bottom edge.

NinePatch

public NinePatch(TextureRegion region,
         int left,
         int right,
         int top,
         int bottom)

Create a ninepatch by cutting up the given texture region into nine patches. The subsequent parameters define the 4 lines that will cut the texture region into 9 pieces.

Parameters:

left - Pixels from left edge.

right - Pixels from right edge.

top - Pixels from top edge.

bottom - Pixels from bottom edge.

NinePatch

public NinePatch(Texture texture,
         Color color)

Construct a degenerate "nine" patch with only a center component.

NinePatch

public NinePatch(Texture texture)

Construct a degenerate "nine" patch with only a center component.

NinePatch

public NinePatch(TextureRegion region,
         Color color)

Construct a degenerate "nine" patch with only a center component.

NinePatch

public NinePatch(TextureRegion region)

Construct a degenerate "nine" patch with only a center component.

NinePatch

public NinePatch(TextureRegion... patches)

Construct a nine patch from the given nine texture regions. The provided patches must be consistently sized (e.g., any left edge textures must have the same width, etc). Patches may be null. Patch indices are specified via the public members TOP_LEFT, TOP_CENTER, etc.

NinePatch

public NinePatch(NinePatch ninePatch)

NinePatch

public NinePatch(NinePatch ninePatch,
         Color color)

Method Detail

draw

public void draw(Batch batch,
        float x,
        float y,
        float width,
        float height)

setColor

public void setColor(Color color)

Copy given color. The color will be blended with the batch color, then combined with the texture colors at draw time. Default is Color.WHITE.

getColor

public Color getColor()

getLeftWidth

public float getLeftWidth()

setLeftWidth

public void setLeftWidth(float leftWidth)

Set the draw-time width of the three left edge patches

getRightWidth

public float getRightWidth()

setRightWidth

public void setRightWidth(float rightWidth)

Set the draw-time width of the three right edge patches

getTopHeight

public float getTopHeight()

setTopHeight

public void setTopHeight(float topHeight)

Set the draw-time height of the three top edge patches

getBottomHeight

public float getBottomHeight()

setBottomHeight

public void setBottomHeight(float bottomHeight)

Set the draw-time height of the three bottom edge patches

getMiddleWidth

public float getMiddleWidth()

setMiddleWidth

public void setMiddleWidth(float middleWidth)

Set the width of the middle column of the patch. At render time, this is implicitly the requested render-width of the entire nine patch, minus the left and right width. This value is only used for computing the default total width.

getMiddleHeight

public float getMiddleHeight()

setMiddleHeight

public void setMiddleHeight(float middleHeight)

Set the height of the middle row of the patch. At render time, this is implicitly the requested render-height of the entire nine patch, minus the top and bottom height. This value is only used for computing the default total height.

getTotalWidth

public float getTotalWidth()

getTotalHeight

public float getTotalHeight()

setPadding

public void setPadding(int left,
              int right,
              int top,
              int bottom)

Set the padding for content inside this ninepatch. By default the padding is set to match the exterior of the ninepatch, so the content should fit exactly within the middle patch.

getPadLeft

public float getPadLeft()

Returns the left padding if set, else returns getLeftWidth().

setPadLeft

public void setPadLeft(int left)

See setPadding(int, int, int, int)

getPadRight

public float getPadRight()

Returns the right padding if set, else returns getRightWidth().

setPadRight

public void setPadRight(int right)

See setPadding(int, int, int, int)

getPadTop

public float getPadTop()

Returns the top padding if set, else returns getTopHeight().

setPadTop

public void setPadTop(int top)

See setPadding(int, int, int, int)

getPadBottom

public float getPadBottom()

Returns the bottom padding if set, else returns getBottomHeight().

setPadBottom

public void setPadBottom(int bottom)

See setPadding(int, int, int, int)

scale

public void scale(float scaleX,
         float scaleY)

Multiplies the top/left/bottom/right sizes and padding by the specified amount.

getTexture

public Texture getTexture()