Sprite (mini2Dx)

All Superinterfaces:

TextureRegion

All Known Implementing Classes:

LibgdxSprite
```
public interface Sprite
extends TextureRegion
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`float`	`getAlpha()`
`Rectangle`	`getBoundingRectangle()` Returns the bounding axis aligned `Rectangle` that bounds this sprite.
`float`	`getHeight()`
`float`	`getOriginX()` The origin influences `setPosition(float, float)`, `setRotation(float)` and the expansion direction of scaling `setScale(float, float)`
`float`	`getOriginY()` The origin influences `setPosition(float, float)`, `setRotation(float)` and the expansion direction of scaling `setScale(float, float)`
`float`	`getRotation()`
`float`	`getScaleX()` X scale of the sprite, independent of size set by `setSize(float, float)`
`float`	`getScaleY()` Y scale of the sprite, independent of size set by `setSize(float, float)`
`Color`	`getTint()` Returns the color of this sprite.
`float[]`	`getVertices()` Returns the packed vertices, colors, and texture coordinates for this sprite.
`float`	`getWidth()`
`float`	`getX()`
`float`	`getY()`
`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`	`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`	`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`	`setTint(Color tint)` Sets the color used to tint this sprite.
`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.
`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 interface org.mini2Dx.core.graphics.TextureRegion
flip, 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, toPixmap

- Method Detail
  - set
```
void set(Sprite sprite)
```
  - setBounds
```
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. If origin, rotation, or scale are changed, it is slightly more efficient to set the bounds after those operations.
  - setSize
```
void setSize(float width,
             float height)
```
    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 setBounds(float, float, float, float).
  - setPosition
```
void setPosition(float x,
                 float y)
```
    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 setBounds(float, float, float, float).
  - setOriginBasedPosition
```
void setOriginBasedPosition(float x,
                            float y)
```
    Sets the position where the sprite will be drawn, relative to its current origin.
  - setCenterX
```
void setCenterX(float x)
```
    Sets the x position so that it is centered on the given x parameter
  - setCenterY
```
void setCenterY(float y)
```
    Sets the y position so that it is centered on the given y parameter
  - setCenter
```
void setCenter(float x,
               float y)
```
    Sets the position so that the sprite is centered on (x, y)
  - translateX
```
void translateX(float xAmount)
```
    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.
  - translateY
```
void translateY(float yAmount)
```
    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.
  - translate
```
void translate(float xAmount,
               float yAmount)
```
    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.
  - setOrigin
```
void setOrigin(float originX,
               float originY)
```
    Sets the origin in relation to the sprite's position for scaling and rotation.
  - setOriginCenter
```
void setOriginCenter()
```
    Place origin in the center of the sprite
  - getRotation
```
float getRotation()
```
    Returns:
    
    the rotation of the sprite in degrees
  - setRotation
```
void setRotation(float degrees)
```
    Sets the rotation of the sprite in degrees. Rotation is centered on the origin set in setOrigin(float, float)
  - rotate
```
void rotate(float degrees)
```
    Sets the sprite's rotation in degrees relative to the current rotation. Rotation is centered on the origin set in setOrigin(float, float)
  - rotate90
```
void rotate90(boolean clockwise)
```
    Rotates this sprite 90 degrees in-place by rotating the texture coordinates. This rotation is unaffected by setRotation(float) and rotate(float).
  - setScale
```
void setScale(float scaleXY)
```
    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 getWidth() and getHeight()
  - setScale
```
void setScale(float scaleX,
              float scaleY)
```
    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 getWidth() and getHeight()
  - scale
```
void scale(float amount)
```
    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 getWidth() and getHeight()
  - getVertices
```
float[] getVertices()
```
    Returns the packed vertices, colors, and texture coordinates for this sprite.
  - getBoundingRectangle
```
Rectangle getBoundingRectangle()
```
    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.
    
    Returns:
    
    the bounding Rectangle
  - getX
```
float getX()
```
  - setX
```
void setX(float x)
```
    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 setBounds(float, float, float, float).
  - getY
```
float getY()
```
  - setY
```
void setY(float y)
```
    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 setBounds(float, float, float, float).
  - getWidth
```
float getWidth()
```
    Returns:
    
    the width of the sprite, not accounting for scale.
  - getHeight
```
float getHeight()
```
    Returns:
    
    the height of the sprite, not accounting for scale.
  - getOriginX
```
float getOriginX()
```
    The origin influences setPosition(float, float), setRotation(float) and the expansion direction of scaling setScale(float, float)
  - getOriginY
```
float getOriginY()
```
    The origin influences setPosition(float, float), setRotation(float) and the expansion direction of scaling setScale(float, float)
  - getScaleX
```
float getScaleX()
```
    X scale of the sprite, independent of size set by setSize(float, float)
  - getScaleY
```
float getScaleY()
```
    Y scale of the sprite, independent of size set by setSize(float, float)
  - getTint
```
Color getTint()
```
    Returns the color of this sprite. Changing the returned color will have no affect.
  - setTint
```
void setTint(Color tint)
```
    Sets the color used to tint this sprite. Default is White.
  - setFlip
```
void setFlip(boolean x,
             boolean y)
```
    Set the sprite's flip state regardless of current condition
    
    Specified by:
    
    setFlip in interface TextureRegion
    
    Parameters:
    
    x - the desired horizontal flip state
    
    y - the desired vertical flip state
  - getAlpha
```
float getAlpha()
```
  - setAlpha
```
void setAlpha(float a)
```
    Sets the alpha portion of the color used to tint this sprite.
  - setFlipX
```
void setFlipX(boolean flipX)
```
    Specified by:
    
    setFlipX in interface TextureRegion
  - setFlipY
```
void setFlipY(boolean flipY)
```
    Specified by:
    
    setFlipY in interface TextureRegion

Interface Sprite

Method Summary

Methods inherited from interface org.mini2Dx.core.graphics.TextureRegion

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

setFlip

getAlpha

setAlpha

setFlipX

setFlipY