org.mini2Dx.core.graphics

Class Sprite

java.lang.Object

com.badlogic.gdx.graphics.g2d.TextureRegion

com.badlogic.gdx.graphics.g2d.Sprite

org.mini2Dx.core.graphics.Sprite

public class Sprite
extends com.badlogic.gdx.graphics.g2d.Sprite

Wraps Sprite to auto-flip Textures due to mini2Dx placing its origin in the top-left corner rather than the bottom-left corner like LibGDX

Constructor Summary

Constructors

Constructor and Description
Sprite() Creates an uninitialized sprite.
Sprite(Sprite sprite) Creates a sprite that is a copy in every way of the specified sprite.
Sprite(com.badlogic.gdx.graphics.Texture texture) Creates a sprite with width, height, and texture region equal to the size of the texture.
Sprite(com.badlogic.gdx.graphics.Texture texture, int srcWidth, int srcHeight) Creates a sprite with width, height, and texture region equal to the specified size.
Sprite(com.badlogic.gdx.graphics.Texture texture, int srcX, int srcY, int srcWidth, int srcHeight) Creates a sprite with width, height, and texture region equal to the specified size.
Sprite(TextureRegion region) Creates a sprite based on a specific TextureRegion, the new sprite's region is a copy of the parameter region - altering one does not affect the other
Sprite(TextureRegion region, int srcX, int srcY, int srcWidth, int srcHeight) Creates a sprite with width, height, and texture region equal to the specified size, relative to specified sprite's texture region.

Method Summary

Modifier and Type	Method and Description
float	getAlpha() Returns the current alpha value of this Sprite
int	getRegionY()
boolean	isFlipY()
void	setFlip(boolean x, boolean y)
void	setFlipX(boolean flipX) Sets if the Sprite is flipped horizontally
void	setFlipY(boolean flipY) Sets if the Sprite is flipped vertically

Methods inherited from class com.badlogic.gdx.graphics.g2d.Sprite

draw, draw, flip, getBoundingRectangle, getColor, getHeight, getOriginX, getOriginY, getRotation, getScaleX, getScaleY, getVertices, getWidth, getX, getY, rotate, rotate90, scale, scroll, set, setAlpha, setBounds, setCenter, setCenterX, setCenterY, setColor, setColor, setColor, setOrigin, setOriginBasedPosition, setOriginCenter, setPosition, setRegion, setRotation, setScale, setScale, setSize, setU, setU2, setV, setV2, setX, setY, translate, translateX, translateY

Methods inherited from class com.badlogic.gdx.graphics.g2d.TextureRegion

getRegionHeight, getRegionWidth, getRegionX, getTexture, getU, getU2, getV, getV2, isFlipX, setRegion, setRegion, setRegion, setRegion, setRegionHeight, setRegionWidth, setRegionX, setRegionY, setTexture, split, split

Methods inherited from class java.lang.Object

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

Constructor Detail

Sprite

public Sprite()

Creates an uninitialized sprite. The sprite will need a texture region and bounds set before it can be drawn.

Sprite

public Sprite(com.badlogic.gdx.graphics.Texture texture)

Creates a sprite with width, height, and texture region equal to the size of the texture.

Sprite

public Sprite(com.badlogic.gdx.graphics.Texture texture,
              int srcWidth,
              int srcHeight)

Creates a sprite with width, height, and texture region equal to the specified size. The texture region's upper left corner will be 0,0.

Parameters:

srcWidth - The width of the texture region. May be negative to flip the sprite when drawn.

srcHeight - The height of the texture region. May be negative to flip the sprite when drawn.

Sprite

public Sprite(com.badlogic.gdx.graphics.Texture texture,
              int srcX,
              int srcY,
              int srcWidth,
              int srcHeight)

Creates a sprite with width, height, and texture region equal to the specified size.

Parameters:

srcX - The x coordinate of the region to draw

srcY - The y coordinate of the region to draw

srcWidth - The width of the texture region. May be negative to flip the sprite when drawn.

srcHeight - The height of the texture region. May be negative to flip the sprite when drawn.

Sprite

public Sprite(TextureRegion region)

Creates a sprite based on a specific TextureRegion, the new sprite's region is a copy of the parameter region - altering one does not affect the other

Sprite

public Sprite(TextureRegion region,
              int srcX,
              int srcY,
              int srcWidth,
              int srcHeight)

Creates a sprite with width, height, and texture region equal to the specified size, relative to specified sprite's texture region.

Parameters:

srcX - The x coordinate of the region to draw

srcY - The y coordinate of the region to draw

srcWidth - The width of the texture region. May be negative to flip the sprite when drawn.

srcHeight - The height of the texture region. May be negative to flip the sprite when drawn.

Sprite

public Sprite(Sprite sprite)

Creates a sprite that is a copy in every way of the specified sprite.

Method Detail

getAlpha

public float getAlpha()

Returns the current alpha value of this Sprite

Returns:

isFlipY

public boolean isFlipY()

Overrides:

isFlipY in class com.badlogic.gdx.graphics.g2d.TextureRegion

getRegionY

public int getRegionY()

Overrides:

getRegionY in class com.badlogic.gdx.graphics.g2d.TextureRegion

setFlip

public void setFlip(boolean x,
                    boolean y)

Overrides:

setFlip in class com.badlogic.gdx.graphics.g2d.Sprite

setFlipX

public void setFlipX(boolean flipX)

Sets if the Sprite is flipped horizontally

Parameters:

flipX - True if the region is flipped horizontally

setFlipY

public void setFlipY(boolean flipY)

Sets if the Sprite is flipped vertically

Parameters:

flipY - True if the region is flipped vertically