LibgdxSprite (mini2Dx)

java.lang.Object
- org.mini2Dx.libgdx.graphics.LibgdxSprite

All Implemented Interfaces:: Sprite, TextureRegion

public class LibgdxSprite
extends java.lang.Object
implements Sprite

Field Summary

Fields
Modifier and Type Field and Description

com.badlogic.gdx.graphics.g2d.Sprite sprite

Fields
Modifier and Type	Field and Description
`com.badlogic.gdx.graphics.g2d.Sprite`	`sprite`

Constructor Summary

Constructors
Constructor and Description
`LibgdxSprite()` Creates an uninitialized sprite.
`LibgdxSprite(Sprite sprite)` Creates a sprite that is a copy in every way of the specified sprite.
`LibgdxSprite(Texture texture)` Creates a sprite with width, height, and texture region equal to the size of the texture.
`LibgdxSprite(Texture texture, int srcWidth, int srcHeight)` Creates a sprite with width, height, and texture region equal to the specified size.
`LibgdxSprite(Texture texture, int srcX, int srcY, int srcWidth, int srcHeight)` Creates a sprite with width, height, and texture region equal to the specified size.
`LibgdxSprite(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
`LibgdxSprite(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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`flip(boolean x, boolean y)`
`float`	`getAlpha()`
`Rectangle`	`getBoundingRectangle()` Returns the bounding axis aligned `Rectangle` that bounds this sprite.
`float`	`getHeight()`
`float`	`getOriginX()` The origin influences `Sprite.setPosition(float, float)`, `Sprite.setRotation(float)` and the expansion direction of scaling `Sprite.setScale(float, float)`
`float`	`getOriginY()` The origin influences `Sprite.setPosition(float, float)`, `Sprite.setRotation(float)` and the expansion direction of scaling `Sprite.setScale(float, float)`
`int`	`getRegionHeight()` Returns the region's height.
`int`	`getRegionWidth()` Returns the region's width.
`int`	`getRegionX()`
`int`	`getRegionY()`
`float`	`getRotation()`
`float`	`getScaleX()` X scale of the sprite, independent of size set by `Sprite.setSize(float, float)`
`float`	`getScaleY()` Y scale of the sprite, independent of size set by `Sprite.setSize(float, float)`
`Texture`	`getTexture()`
`Color`	`getTint()` Returns the color of this sprite.
`float`	`getU()`
`float`	`getU2()`
`float`	`getV()`
`float`	`getV2()`
`float[]`	`getVertices()` Returns the packed vertices, colors, and texture coordinates for this sprite.
`float`	`getWidth()`
`float`	`getX()`
`float`	`getY()`
`boolean`	`isFlipX()`
`boolean`	`isFlipY()`
`void`	`rotate(float degrees)` Sets the sprite's rotation in degrees relative to the current rotation.
`void`	`rotate90(boolean clockwise)` Rotates this sprite 90 degrees in-place by rotating the texture coordinates.
`void`	`scale(float amount)` Sets the sprite's scale relative to the current scale.
`void`	`scroll(float xAmount, float yAmount)` Offsets the region relative to the current region.
`void`	`set(Sprite sprite)`
`void`	`setAlpha(float a)` Sets the alpha portion of the color used to tint this sprite.
`void`	`setBounds(float x, float y, float width, float height)` Sets the position and size of the sprite when drawn, before scaling and rotation are applied.
`void`	`setCenter(float x, float y)` Sets the position so that the sprite is centered on (x, y)
`void`	`setCenterX(float x)` Sets the x position so that it is centered on the given x parameter
`void`	`setCenterY(float y)` Sets the y position so that it is centered on the given y parameter
`void`	`setFlip(boolean x, boolean y)` Set the sprite's flip state regardless of current condition
`void`	`setFlipX(boolean flipX)`
`void`	`setFlipY(boolean flipY)`
`void`	`setOrigin(float originX, float originY)` Sets the origin in relation to the sprite's position for scaling and rotation.
`void`	`setOriginBasedPosition(float x, float y)` Sets the position where the sprite will be drawn, relative to its current origin.
`void`	`setOriginCenter()` Place origin in the center of the sprite
`void`	`setPosition(float x, float y)` Sets the position where the sprite will be drawn.
`void`	`setRegion(float u, float v, float u2, float v2)`
`void`	`setRegion(int x, int y, int width, int height)`
`void`	`setRegion(Texture texture)`
`void`	`setRegion(TextureRegion region)` Sets the texture and coordinates to the specified region.
`void`	`setRegion(TextureRegion region, int x, int y, int width, int height)` Sets the texture to that of the specified region and sets the coordinates relative to the specified region.
`void`	`setRegionHeight(int height)`
`void`	`setRegionWidth(int width)`
`void`	`setRegionX(int x)`
`void`	`setRegionY(int y)`
`void`	`setRotation(float degrees)` Sets the rotation of the sprite in degrees.
`void`	`setScale(float scaleXY)` Sets the sprite's scale for both X and Y uniformly.
`void`	`setScale(float scaleX, float scaleY)` Sets the sprite's scale for both X and Y.
`void`	`setSize(float width, float height)` Sets the size of the sprite when drawn, before scaling and rotation are applied.
`void`	`setTexture(Texture texture)`
`void`	`setTint(Color tint)` Sets the color used to tint this sprite.
`void`	`setU(float u)`
`void`	`setU2(float u2)`
`void`	`setV(float v)`
`void`	`setV2(float v2)`
`void`	`setX(float x)` Sets the x position where the sprite will be drawn.
`void`	`setY(float y)` Sets the y position where the sprite will be drawn.
`TextureRegion[][]`	`split(int tileWidth, int tileHeight)` Helper function to create tiles out of this TextureRegion starting from the top left corner going to the right and ending at the bottom right corner.
`Pixmap`	`toPixmap()` Converts this `TextureRegion` to a `Pixmap`
`void`	`translate(float xAmount, float yAmount)` Sets the position relative to the current position where the sprite will be drawn.
`void`	`translateX(float xAmount)` Sets the x position relative to the current position where the sprite will be drawn.
`void`	`translateY(float yAmount)` Sets the y position relative to the current position where the sprite will be drawn.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sprite
```
public final com.badlogic.gdx.graphics.g2d.Sprite sprite
```
- Constructor Detail
  - LibgdxSprite
```
public LibgdxSprite()
```
    Creates an uninitialized sprite. The sprite will need a texture region and bounds set before it can be drawn.
  - LibgdxSprite
```
public LibgdxSprite(Texture texture)
```
    Creates a sprite with width, height, and texture region equal to the size of the texture.
  - LibgdxSprite
```
public LibgdxSprite(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.
  - LibgdxSprite
```
public LibgdxSprite(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.
  - LibgdxSprite
```
public LibgdxSprite(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
  - LibgdxSprite
```
public LibgdxSprite(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.
  - LibgdxSprite
```
public LibgdxSprite(Sprite sprite)
```
    Creates a sprite that is a copy in every way of the specified sprite.
- Method Detail
  - set
```
public void set(Sprite sprite)
```
    Specified by:
    
    set in interface Sprite
  - setBounds
```
public void setBounds(float x,
                      float y,
                      float width,
                      float height)
```
    Description copied from interface: Sprite
    
    Sets the position and size of the sprite when drawn, before scaling and rotation are applied. If origin, rotation, or scale are changed, it is slightly more efficient to set the bounds after those operations.
    
    Specified by:
    
    setBounds in interface Sprite
  - setSize
```
public void setSize(float width,
                    float height)
```
    Description copied from interface: Sprite
    
    Sets the size of the sprite when drawn, before scaling and rotation are applied. If origin, rotation, or scale are changed, it is slightly more efficient to set the size after those operations. If both position and size are to be changed, it is better to use Sprite.setBounds(float, float, float, float).
    
    Specified by:
    
    setSize in interface Sprite
  - setPosition
```
public void setPosition(float x,
                        float y)
```
    Description copied from interface: Sprite
    
    Sets the position where the sprite will be drawn. If origin, rotation, or scale are changed, it is slightly more efficient to set the position after those operations. If both position and size are to be changed, it is better to use Sprite.setBounds(float, float, float, float).
    
    Specified by:
    
    setPosition in interface Sprite
  - setOriginBasedPosition
```
public void setOriginBasedPosition(float x,
                                   float y)
```
    Description copied from interface: Sprite
    
    Sets the position where the sprite will be drawn, relative to its current origin.
    
    Specified by:
    
    setOriginBasedPosition in interface Sprite
  - setCenterX
```
public void setCenterX(float x)
```
    Description copied from interface: Sprite
    
    Sets the x position so that it is centered on the given x parameter
    
    Specified by:
    
    setCenterX in interface Sprite
  - setCenterY
```
public void setCenterY(float y)
```
    Description copied from interface: Sprite
    
    Sets the y position so that it is centered on the given y parameter
    
    Specified by:
    
    setCenterY in interface Sprite
  - setCenter
```
public void setCenter(float x,
                      float y)
```
    Description copied from interface: Sprite
    
    Sets the position so that the sprite is centered on (x, y)
    
    Specified by:
    
    setCenter in interface Sprite
  - translateX
```
public void translateX(float xAmount)
```
    Description copied from interface: Sprite
    
    Sets the x position relative to the current position where the sprite will be drawn. If origin, rotation, or scale are changed, it is slightly more efficient to translate after those operations.
    
    Specified by:
    
    translateX in interface Sprite
  - translateY
```
public void translateY(float yAmount)
```
    Description copied from interface: Sprite
    
    Sets the y position relative to the current position where the sprite will be drawn. If origin, rotation, or scale are changed, it is slightly more efficient to translate after those operations.
    
    Specified by:
    
    translateY in interface Sprite
  - translate
```
public void translate(float xAmount,
                      float yAmount)
```
    Description copied from interface: Sprite
    
    Sets the position relative to the current position where the sprite will be drawn. If origin, rotation, or scale are changed, it is slightly more efficient to translate after those operations.
    
    Specified by:
    
    translate in interface Sprite
  - setOrigin
```
public void setOrigin(float originX,
                      float originY)
```
    Description copied from interface: Sprite
    
    Sets the origin in relation to the sprite's position for scaling and rotation.
    
    Specified by:
    
    setOrigin in interface Sprite
  - setOriginCenter
```
public void setOriginCenter()
```
    Description copied from interface: Sprite
    
    Place origin in the center of the sprite
    
    Specified by:
    
    setOriginCenter in interface Sprite
  - getRotation
```
public float getRotation()
```
    Specified by:
    
    getRotation in interface Sprite
    
    Returns:
    
    the rotation of the sprite in degrees
  - setRotation
```
public void setRotation(float degrees)
```
    Description copied from interface: Sprite
    
    Sets the rotation of the sprite in degrees. Rotation is centered on the origin set in Sprite.setOrigin(float, float)
    
    Specified by:
    
    setRotation in interface Sprite
  - rotate
```
public void rotate(float degrees)
```
    Description copied from interface: Sprite
    
    Sets the sprite's rotation in degrees relative to the current rotation. Rotation is centered on the origin set in Sprite.setOrigin(float, float)
    
    Specified by:
    
    rotate in interface Sprite
  - rotate90
```
public void rotate90(boolean clockwise)
```
    Description copied from interface: Sprite
    
    Rotates this sprite 90 degrees in-place by rotating the texture coordinates. This rotation is unaffected by Sprite.setRotation(float) and Sprite.rotate(float).
    
    Specified by:
    
    rotate90 in interface Sprite
  - setScale
```
public void setScale(float scaleXY)
```
    Description copied from interface: Sprite
    
    Sets the sprite's scale for both X and Y uniformly. The sprite scales out from the origin. This will not affect the values returned by Sprite.getWidth() and Sprite.getHeight()
    
    Specified by:
    
    setScale in interface Sprite
  - setScale
```
public void setScale(float scaleX,
                     float scaleY)
```
    Description copied from interface: Sprite
    
    Sets the sprite's scale for both X and Y. The sprite scales out from the origin. This will not affect the values returned by Sprite.getWidth() and Sprite.getHeight()
    
    Specified by:
    
    setScale in interface Sprite
  - scale
```
public void scale(float amount)
```
    Description copied from interface: Sprite
    
    Sets the sprite's scale relative to the current scale. for example: original scale 2 -> sprite.scale(4) -> final scale 6. The sprite scales out from the origin. This will not affect the values returned by Sprite.getWidth() and Sprite.getHeight()
    
    Specified by:
    
    scale in interface Sprite
  - getVertices
```
public float[] getVertices()
```
    Description copied from interface: Sprite
    
    Returns the packed vertices, colors, and texture coordinates for this sprite.
    
    Specified by:
    
    getVertices in interface Sprite
  - getBoundingRectangle
```
public Rectangle getBoundingRectangle()
```
    Description copied from interface: Sprite
    
    Returns the bounding axis aligned Rectangle that bounds this sprite. The rectangles x and y coordinates describe its bottom left corner. If you change the position or size of the sprite, you have to fetch the triangle again for it to be recomputed.
    
    Specified by:
    
    getBoundingRectangle in interface Sprite
    
    Returns:
    
    the bounding Rectangle
  - getX
```
public float getX()
```
    Specified by:
    
    getX in interface Sprite
  - setX
```
public void setX(float x)
```
    Description copied from interface: Sprite
    
    Sets the x position where the sprite will be drawn. If origin, rotation, or scale are changed, it is slightly more efficient to set the position after those operations. If both position and size are to be changed, it is better to use Sprite.setBounds(float, float, float, float).
    
    Specified by:
    
    setX in interface Sprite
  - getY
```
public float getY()
```
    Specified by:
    
    getY in interface Sprite
  - setY
```
public void setY(float y)
```
    Description copied from interface: Sprite
    
    Sets the y position where the sprite will be drawn. If origin, rotation, or scale are changed, it is slightly more efficient to set the position after those operations. If both position and size are to be changed, it is better to use Sprite.setBounds(float, float, float, float).
    
    Specified by:
    
    setY in interface Sprite
  - getWidth
```
public float getWidth()
```
    Specified by:
    
    getWidth in interface Sprite
    
    Returns:
    
    the width of the sprite, not accounting for scale.
  - getHeight
```
public float getHeight()
```
    Specified by:
    
    getHeight in interface Sprite
    
    Returns:
    
    the height of the sprite, not accounting for scale.
  - getOriginX
```
public float getOriginX()
```
    Description copied from interface: Sprite
    
    The origin influences Sprite.setPosition(float, float), Sprite.setRotation(float) and the expansion direction of scaling Sprite.setScale(float, float)
    
    Specified by:
    
    getOriginX in interface Sprite
  - getOriginY
```
public float getOriginY()
```
    Description copied from interface: Sprite
    
    The origin influences Sprite.setPosition(float, float), Sprite.setRotation(float) and the expansion direction of scaling Sprite.setScale(float, float)
    
    Specified by:
    
    getOriginY in interface Sprite
  - getScaleX
```
public float getScaleX()
```
    Description copied from interface: Sprite
    
    X scale of the sprite, independent of size set by Sprite.setSize(float, float)
    
    Specified by:
    
    getScaleX in interface Sprite
  - getScaleY
```
public float getScaleY()
```
    Description copied from interface: Sprite
    
    Y scale of the sprite, independent of size set by Sprite.setSize(float, float)
    
    Specified by:
    
    getScaleY in interface Sprite
  - getTint
```
public Color getTint()
```
    Description copied from interface: Sprite
    
    Returns the color of this sprite. Changing the returned color will have no affect.
    
    Specified by:
    
    getTint in interface Sprite
  - setTint
```
public void setTint(Color tint)
```
    Description copied from interface: Sprite
    
    Sets the color used to tint this sprite. Default is White.
    
    Specified by:
    
    setTint in interface Sprite
  - setRegion
```
public void setRegion(Texture texture)
```
    Specified by:
    
    setRegion in interface TextureRegion
  - setRegion
```
public void setRegion(int x,
                      int y,
                      int width,
                      int height)
```
    Specified by:
    
    setRegion in interface TextureRegion
    
    width - The width of the texture region. May be negative to flip the sprite when drawn.
    
    height - The height of the texture region. May be negative to flip the sprite when drawn.
  - setRegion
```
public void setRegion(float u,
                      float v,
                      float u2,
                      float v2)
```
    Specified by:
    
    setRegion in interface TextureRegion
  - setRegion
```
public void setRegion(TextureRegion region)
```
    Description copied from interface: TextureRegion
    
    Sets the texture and coordinates to the specified region.
    
    Specified by:
    
    setRegion in interface TextureRegion
  - setRegion
```
public void setRegion(TextureRegion region,
                      int x,
                      int y,
                      int width,
                      int height)
```
    Description copied from interface: TextureRegion
    
    Sets the texture to that of the specified region and sets the coordinates relative to the specified region.
    
    Specified by:
    
    setRegion in interface TextureRegion
  - getTexture
```
public Texture getTexture()
```
    Specified by:
    
    getTexture in interface TextureRegion
  - setTexture
```
public void setTexture(Texture texture)
```
    Specified by:
    
    setTexture in interface TextureRegion
  - getU
```
public float getU()
```
    Specified by:
    
    getU in interface TextureRegion
  - setU
```
public void setU(float u)
```
    Specified by:
    
    setU in interface TextureRegion
  - getV
```
public float getV()
```
    Specified by:
    
    getV in interface TextureRegion
  - setV
```
public void setV(float v)
```
    Specified by:
    
    setV in interface TextureRegion
  - getU2
```
public float getU2()
```
    Specified by:
    
    getU2 in interface TextureRegion
  - setU2
```
public void setU2(float u2)
```
    Specified by:
    
    setU2 in interface TextureRegion
  - getV2
```
public float getV2()
```
    Specified by:
    
    getV2 in interface TextureRegion
  - setV2
```
public void setV2(float v2)
```
    Specified by:
    
    setV2 in interface TextureRegion
  - getRegionX
```
public int getRegionX()
```
    Specified by:
    
    getRegionX in interface TextureRegion
  - setRegionX
```
public void setRegionX(int x)
```
    Specified by:
    
    setRegionX in interface TextureRegion
  - getRegionY
```
public int getRegionY()
```
    Specified by:
    
    getRegionY in interface TextureRegion
  - setRegionY
```
public void setRegionY(int y)
```
    Specified by:
    
    setRegionY in interface TextureRegion
  - getRegionWidth
```
public int getRegionWidth()
```
    Description copied from interface: TextureRegion
    
    Returns the region's width.
    
    Specified by:
    
    getRegionWidth in interface TextureRegion
  - setRegionWidth
```
public void setRegionWidth(int width)
```
    Specified by:
    
    setRegionWidth in interface TextureRegion
  - getRegionHeight
```
public int getRegionHeight()
```
    Description copied from interface: TextureRegion
    
    Returns the region's height.
    
    Specified by:
    
    getRegionHeight in interface TextureRegion
  - setRegionHeight
```
public void setRegionHeight(int height)
```
    Specified by:
    
    setRegionHeight in interface TextureRegion
  - flip
```
public void flip(boolean x,
                 boolean y)
```
    Specified by:
    
    flip in interface TextureRegion
  - setFlip
```
public void setFlip(boolean x,
                    boolean y)
```
    Description copied from interface: Sprite
    
    Set the sprite's flip state regardless of current condition
    
    Specified by:
    
    setFlip in interface Sprite
    
    Specified by:
    
    setFlip in interface TextureRegion
    
    Parameters:
    
    x - the desired horizontal flip state
    
    y - the desired vertical flip state
  - isFlipX
```
public boolean isFlipX()
```
    Specified by:
    
    isFlipX in interface TextureRegion
  - getAlpha
```
public float getAlpha()
```
    Specified by:
    
    getAlpha in interface Sprite
  - setAlpha
```
public void setAlpha(float a)
```
    Description copied from interface: Sprite
    
    Sets the alpha portion of the color used to tint this sprite.
    
    Specified by:
    
    setAlpha in interface Sprite
  - setFlipX
```
public void setFlipX(boolean flipX)
```
    Specified by:
    
    setFlipX in interface Sprite
    
    Specified by:
    
    setFlipX in interface TextureRegion
  - isFlipY
```
public boolean isFlipY()
```
    Specified by:
    
    isFlipY in interface TextureRegion
  - setFlipY
```
public void setFlipY(boolean flipY)
```
    Specified by:
    
    setFlipY in interface Sprite
    
    Specified by:
    
    setFlipY in interface TextureRegion
  - scroll
```
public void scroll(float xAmount,
                   float yAmount)
```
    Description copied from interface: TextureRegion
    
    Offsets the region relative to the current region. Generally the region's size should be the entire size of the texture in the direction(s) it is scrolled.
    
    Specified by:
    
    scroll in interface TextureRegion
    
    Parameters:
    
    xAmount - The percentage to offset horizontally.
    
    yAmount - The percentage to offset vertically. This is done in texture space, so up is negative.
  - toPixmap
```
public Pixmap toPixmap()
```
    Description copied from interface: TextureRegion
    
    Converts this TextureRegion to a Pixmap
    
    Specified by:
    
    toPixmap in interface TextureRegion
    
    Returns:
    
    A new Pixmap instance containing the pixel data
  - split
```
public TextureRegion[][] split(int tileWidth,
                               int tileHeight)
```
    Description copied from interface: TextureRegion
    
    Helper function to create tiles out of this TextureRegion starting from the top left corner going to the right and ending at the bottom right corner. Only complete tiles will be returned so if the region's width or height are not a multiple of the tile width and height not all of the region will be used. This will not work on texture regions returned form a TextureAtlas that either have whitespace removed or where flipped before the region is split.
    
    Specified by:
    
    split in interface TextureRegion
    
    Parameters:
    
    tileWidth - a tile's width in pixels
    
    tileHeight - a tile's height in pixels
    
    Returns:
    
    a 2D array of TextureRegions indexed by [row][column].

Class LibgdxSprite

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sprite

Constructor Detail

LibgdxSprite

LibgdxSprite

LibgdxSprite

LibgdxSprite

LibgdxSprite

LibgdxSprite

LibgdxSprite

Method Detail

set

setBounds

setSize

setPosition

setOriginBasedPosition

setCenterX

setCenterY

setCenter

translateX

translateY

translate

setOrigin

setOriginCenter

getRotation

setRotation

rotate

rotate90

setScale

setScale

scale

getVertices

getBoundingRectangle

getX

setX

getY

setY

getWidth

getHeight

getOriginX

getOriginY

getScaleX

getScaleY

getTint

setTint

setRegion

setRegion

setRegion

setRegion

setRegion

getTexture

setTexture

getU

setU

getV

setV

getU2

setU2

getV2

setV2

getRegionX

setRegionX

getRegionY

setRegionY

getRegionWidth

setRegionWidth

getRegionHeight

setRegionHeight

flip

setFlip

isFlipX

getAlpha

setAlpha

setFlipX

isFlipY