NinePatch (gdx 1.11.0 API)

java.lang.Object
- com.badlogic.gdx.graphics.g2d.NinePatch

```
public class NinePatch
extends java.lang.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 ninepatch define the padding). When drawn, the four corner patches will not be scaled, the interior patch will be scaled in both directions, and the middle patch for each edge will be scaled in only one direction.
Note this class does not accept ".9.png" textures that include the metadata border pixels describing the splits (and padding) for the ninepatch. That information is either passed to a constructor or defined implicitly by the size of the individual patch textures. TextureAtlas is one way to generate a postprocessed ninepatch texture regions from ".9.png" files.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOTTOM_CENTER` Indices for the `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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`draw(Batch batch, float x, float y, float width, float height)`
`void`	`draw(Batch batch, float x, float y, float originX, float originY, float width, float height, float scaleX, float scaleY, float rotation)`
`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(float bottom)` See `setPadding(float, float, float, float)`
`void`	`setPadding(float left, float right, float top, float bottom)` Set the padding for content inside this ninepatch.
`void`	`setPadLeft(float left)` See `setPadding(float, float, float, float)`
`void`	`setPadRight(float right)` See `setPadding(float, float, float, float)`
`void`	`setPadTop(float top)` See `setPadding(float, float, float, float)`
`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
clone, equals, finalize, 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 the 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)
```
  - draw
```
public void draw(Batch batch,
                 float x,
                 float y,
                 float originX,
                 float originY,
                 float width,
                 float height,
                 float scaleX,
                 float scaleY,
                 float rotation)
```
  - 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(float left,
                       float right,
                       float top,
                       float 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(float left)
```
    See setPadding(float, float, float, float)
  - getPadRight
```
public float getPadRight()
```
    Returns the right padding if set, else returns getRightWidth().
  - setPadRight
```
public void setPadRight(float right)
```
    See setPadding(float, float, float, float)
  - getPadTop
```
public float getPadTop()
```
    Returns the top padding if set, else returns getTopHeight().
  - setPadTop
```
public void setPadTop(float top)
```
    See setPadding(float, float, float, float)
  - getPadBottom
```
public float getPadBottom()
```
    Returns the bottom padding if set, else returns getBottomHeight().
  - setPadBottom
```
public void setPadBottom(float bottom)
```
    See setPadding(float, float, float, float)
  - 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()
```

Class NinePatch

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TOP_LEFT

TOP_CENTER

TOP_RIGHT

MIDDLE_LEFT

MIDDLE_CENTER

MIDDLE_RIGHT

BOTTOM_LEFT

BOTTOM_CENTER

BOTTOM_RIGHT

Constructor Detail

NinePatch

NinePatch

NinePatch

NinePatch

NinePatch

NinePatch

NinePatch

NinePatch

NinePatch

Method Detail

draw

draw

setColor

getColor

getLeftWidth

setLeftWidth

getRightWidth

setRightWidth

getTopHeight

setTopHeight

getBottomHeight

setBottomHeight

getMiddleWidth

setMiddleWidth

getMiddleHeight

setMiddleHeight

getTotalWidth

getTotalHeight

setPadding

getPadLeft

setPadLeft

getPadRight

setPadRight

getPadTop

setPadTop

getPadBottom

setPadBottom

scale

getTexture