Class TextureAtlas.AtlasRegion

java.lang.Object

gaiasky.util.gdx.g2d.TextureRegion

gaiasky.util.gdx.g2d.TextureAtlas.AtlasRegion

Enclosing class:

TextureAtlas

public static class TextureAtlas.AtlasRegion
extends TextureRegion

Describes the region of a packed image and provides information about the original image before it was packed.

Field Summary

Fields

Modifier and Type	Field	Description
int	index	The number at the end of the original image file name, or -1 if none. When sprites are packed, if the original file name ends with a number, it is stored as the index and is not considered as part of the sprite's name.
String	name	The name of the original image file, up to the first underscore.
float	offsetX	The offset from the left of the original image to the left of the packed image, after whitespace was removed for packing.
float	offsetY	The offset from the bottom of the original image to the bottom of the packed image, after whitespace was removed for packing.
int	originalHeight	The height of the image, before whitespace was removed for packing.
int	originalWidth	The width of the image, before whitespace was removed and rotation was applied for packing.
int	packedHeight	The height of the image, after whitespace was removed for packing.
int	packedWidth	The width of the image, after whitespace was removed for packing.
int[]	pads	The nine-patch pads, or null if not a nine-patch or the has no padding.
boolean	rotate	If true, the region has been rotated 90 degrees counter-clockwise.
int[]	splits	The nine-patch splits, or null if not a nine-patch.

Constructor Summary

Constructors

Constructor	Description
AtlasRegion(com.badlogic.gdx.graphics.Texture texture, int x, int y, int width, int height)
AtlasRegion(TextureAtlas.AtlasRegion region)

Method Summary

Modifier and Type	Method	Description
void	flip(boolean x, boolean y)	Flips the region, adjusting the offset so the image appears to be flip as if no whitespace has been removed for packing.
float	getRotatedPackedHeight()	Returns the packed height considering the rotate value, if it is true then it returns the packedWidth, otherwise it returns the packedHeight.
float	getRotatedPackedWidth()	Returns the packed width considering the rotate value, if it is true then it returns the packedHeight, otherwise it returns the packedWidth.
String	toString()

Methods inherited from class TextureRegion

getRegionHeight, getRegionWidth, getRegionX, getRegionY, getTexture, getU, getU2, getV, getV2, isFlipX, isFlipY, scroll, setRegion, setRegion, setRegion, setRegion, setRegion, setRegionHeight, setRegionWidth, setRegionX, setRegionY, setTexture, setU, setU2, setV, setV2, split, split

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

index

public int index

The number at the end of the original image file name, or -1 if none.

When sprites are packed, if the original file name ends with a number, it is stored as the index and is not considered as part of the sprite's name. This is useful for keeping animation frames in order.

See Also:

• TextureAtlas.findRegions(String)

name

public String name

The name of the original image file, up to the first underscore. Underscores denote special instructions to the texture packer.

offsetX

public float offsetX

The offset from the left of the original image to the left of the packed image, after whitespace was removed for packing.

offsetY

public float offsetY

The offset from the bottom of the original image to the bottom of the packed image, after whitespace was removed for packing.

packedWidth

public int packedWidth

The width of the image, after whitespace was removed for packing.

packedHeight

public int packedHeight

The height of the image, after whitespace was removed for packing.

originalWidth

public int originalWidth

The width of the image, before whitespace was removed and rotation was applied for packing.

originalHeight

public int originalHeight

The height of the image, before whitespace was removed for packing.

rotate

public boolean rotate

If true, the region has been rotated 90 degrees counter-clockwise.

splits

public int[] splits

The nine-patch splits, or null if not a nine-patch. Has 4 elements: left, right, top, bottom.

pads

public int[] pads

The nine-patch pads, or null if not a nine-patch or the has no padding. Has 4 elements: left, right, top, bottom.

Constructor Details

AtlasRegion

public AtlasRegion(com.badlogic.gdx.graphics.Texture texture,
 int x,
 int y,
 int width,
 int height)

AtlasRegion

public AtlasRegion(TextureAtlas.AtlasRegion region)

Method Details

flip

public void flip(boolean x,
 boolean y)

Flips the region, adjusting the offset so the image appears to be flip as if no whitespace has been removed for packing.

Overrides:

flip in class TextureRegion

getRotatedPackedWidth

public float getRotatedPackedWidth()

Returns the packed width considering the rotate value, if it is true then it returns the packedHeight, otherwise it returns the packedWidth.

getRotatedPackedHeight

public float getRotatedPackedHeight()

Returns the packed height considering the rotate value, if it is true then it returns the packedWidth, otherwise it returns the packedHeight.

toString

public String toString()

Overrides:

toString in class Object