Sprite (JSFML API)

java.lang.Object
- org.jsfml.internal.SFMLNativeObject
- - org.jsfml.graphics.Sprite

All Implemented Interfaces:

Drawable, Transformable
```
public class Sprite
extends SFMLNativeObject
implements Drawable
```
Represents a drawable instance of a texture or texture portion.

Constructor Summary

Constructors
Constructor and Description
`Sprite()` Constructs a new sprite without a texture.
`Sprite(ConstTexture texture)` Constructs a new sprite with the specified texture.
`Sprite(ConstTexture texture, IntRect rect)` Constructs a new sprite with the specified texture and texture portion.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`draw(RenderTarget target, RenderStates states)` Draws the object to a render target.
`Color`	`getColor()` Gets the sprite's current color mask.
`FloatRect`	`getGlobalBounds()` Gets the sprite's global bounding rectangle in the scene, taking the sprite's transformation into account.
`Transform`	`getInverseTransform()` Gets the inverse of the current transformation matrix.
`FloatRect`	`getLocalBounds()` Gets the sprite's local bounding rectangle, not taking the sprite's transformation into account.
`Vector2f`	`getOrigin()` Gets the origin of this object.
`Vector2f`	`getPosition()` Gets the position of this object.
`float`	`getRotation()` Gets the rotation angle of this object.
`Vector2f`	`getScale()` Gets the scaling of this object.
`ConstTexture`	`getTexture()` Gets the sprite's current texture.
`IntRect`	`getTextureRect()` Gets the sprite's current texture rectangle.
`Transform`	`getTransform()` Gets the current transformation matrix.
`void`	`move(float x, float y)` Moves this object.
`void`	`move(Vector2f v)` Moves the object.
`protected long`	`nativeCreate()` Deprecated.
`protected void`	`nativeDelete()` Deprecated.
`protected void`	`nativeSetExPtr()` Deprecated.
`void`	`rotate(float angle)` Rotates this object around its origin.
`void`	`scale(float x, float y)` Scales the object, using its origin as the scaling center.
`void`	`scale(Vector2f factors)` Scales the object, using its origin as the scaling center.
`void`	`setColor(Color color)` Sets the color mask of the sprite.
`void`	`setOrigin(float x, float y)` Sets the rotation, scaling and drawing origin of this object.
`void`	`setOrigin(Vector2f v)` Sets the rotation, scaling and drawing origin of this object.
`void`	`setPosition(float x, float y)` Sets the position of this object in the scene so that its origin will be exactly on it.
`void`	`setPosition(Vector2f v)` Sets the position of this object in the scene so that its origin will be exactly on it.
`void`	`setRotation(float angle)` Sets the rotation of this object around its origin.
`void`	`setScale(float x, float y)` Sets the scaling of this object, using its origin as the scaling center.
`void`	`setScale(Vector2f v)` Sets the scaling of this object, using its origin as the scaling center.
`void`	`setTexture(ConstTexture texture)` Sets the texture of this sprite without affecting the texture rectangle.
`void`	`setTexture(ConstTexture texture, boolean resetRect)` Sets the texture of this sprite.
`void`	`setTextureRect(IntRect rect)` Sets the portion of the texture that will be used for drawing.

Methods inherited from class org.jsfml.internal.SFMLNativeObject
finalize

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

- Constructor Detail
  - Sprite
```
public Sprite()
```
    Constructs a new sprite without a texture.
  - Sprite
```
public Sprite(ConstTexture texture)
```
    Constructs a new sprite with the specified texture.
    
    Parameters:
    texture - the texture.
  - Sprite
```
public Sprite(ConstTexture texture,
      IntRect rect)
```
    Constructs a new sprite with the specified texture and texture portion.
    
    Parameters:
    texture - the texture.
    rect - the portion of the texture to use.
- Method Detail
  - nativeCreate
```
@Deprecated
protected long nativeCreate()
```
    Deprecated.
    
    Description copied from class: SFMLNativeObject
    
    Creates a new native SFML object of the represented SFML class in the JVM memory heap.
    
    Specified by:
    
    nativeCreate in class SFMLNativeObject
    
    Returns:
    the pointer to the newly created native SFML object.
  - nativeSetExPtr
```
@Deprecated
protected void nativeSetExPtr()
```
    Deprecated.
    
    Description copied from class: SFMLNativeObject
    
    This method is expected to fill the extra pointers array, if any.
    It is called after the object has been created or wrapped around an already existing pointer.
    
    Specified by:
    
    nativeSetExPtr in class SFMLNativeObject
  - nativeDelete
```
@Deprecated
protected void nativeDelete()
```
    Deprecated.
    
    Description copied from class: SFMLNativeObject
    
    Deletes the underlying SFML object.
    
    Specified by:
    
    nativeDelete in class SFMLNativeObject
  - setTexture
```
public void setTexture(ConstTexture texture,
              boolean resetRect)
```
    Sets the texture of this sprite.
    
    Parameters:
    texture - the new texture.
    resetRect - true to reset the texture rectangle, false otherwise.
  - setTexture
```
public final void setTexture(ConstTexture texture)
```
    Sets the texture of this sprite without affecting the texture rectangle.
    
    Parameters:
    texture - the new texture.
  - setTextureRect
```
public void setTextureRect(IntRect rect)
```
    Sets the portion of the texture that will be used for drawing.
    An empty rectangle can be passed to indicate that the whole texture shall be used.
    The width and / or height of the rectangle may be negative to indicate that the respective axis should be flipped. For example, a width of -32 will result in a sprite that is 32 pixels wide and flipped horizontally.
    
    Parameters:
    rect - the texture portion.
  - setColor
```
public void setColor(Color color)
```
    Sets the color mask of the sprite.
    
    Parameters:
    color - the new color.
  - getTexture
```
public ConstTexture getTexture()
```
    Gets the sprite's current texture.
    
    Returns:
    the sprite's current texture.
  - getTextureRect
```
public IntRect getTextureRect()
```
    Gets the sprite's current texture rectangle.
    
    Returns:
    the sprite's current texture rectangle.
  - getColor
```
public Color getColor()
```
    Gets the sprite's current color mask.
    
    Returns:
    the sprite's current color mask.
  - getLocalBounds
```
public FloatRect getLocalBounds()
```
    Gets the sprite's local bounding rectangle, not taking the sprite's transformation into account.
    
    Returns:
    the sprite's local bounding rectangle.
    See Also:
    getGlobalBounds()
  - getGlobalBounds
```
public FloatRect getGlobalBounds()
```
    Gets the sprite's global bounding rectangle in the scene, taking the sprite's transformation into account.
    
    Returns:
    the sprite's global bounding rectangle.
    See Also:
    getLocalBounds()
  - setPosition
```
public void setPosition(Vector2f v)
```
    Description copied from interface: Transformable
    
    Sets the position of this object in the scene so that its origin will be exactly on it.
    
    Specified by:
    
    setPosition in interface Transformable
    
    Parameters:
    v - the new position.
  - setRotation
```
public void setRotation(float angle)
```
    Description copied from interface: Transformable
    
    Sets the rotation of this object around its origin.
    
    Specified by:
    
    setRotation in interface Transformable
    
    Parameters:
    angle - the new rotation angle in degrees.
  - setScale
```
public void setScale(Vector2f v)
```
    Description copied from interface: Transformable
    
    Sets the scaling of this object, using its origin as the scaling center.
    
    Specified by:
    
    setScale in interface Transformable
    
    Parameters:
    v - the new scaling factors.
  - setOrigin
```
public void setOrigin(Vector2f v)
```
    Description copied from interface: Transformable
    
    Sets the rotation, scaling and drawing origin of this object.
    
    Specified by:
    
    setOrigin in interface Transformable
    
    Parameters:
    v - the new origin.
  - draw
```
public void draw(RenderTarget target,
        RenderStates states)
```
    Description copied from interface: Drawable
    
    Draws the object to a render target.
    
    Specified by:
    
    draw in interface Drawable
    
    Parameters:
    target - the target to draw this object on.
    states - the current render states.
  - setPosition
```
public final void setPosition(float x,
               float y)
```
    Description copied from interface: Transformable
    
    Sets the position of this object in the scene so that its origin will be exactly on it.
    
    Specified by:
    
    setPosition in interface Transformable
    
    Parameters:
    x - the new X coordinate.
    y - the new Y coordinate.
  - setScale
```
public final void setScale(float x,
            float y)
```
    Description copied from interface: Transformable
    
    Sets the scaling of this object, using its origin as the scaling center.
    
    Specified by:
    
    setScale in interface Transformable
    
    Parameters:
    x - the new X scaling factor.
    y - the new Y scaling factor.
  - setOrigin
```
public final void setOrigin(float x,
             float y)
```
    Description copied from interface: Transformable
    
    Sets the rotation, scaling and drawing origin of this object.
    
    Specified by:
    
    setOrigin in interface Transformable
    
    Parameters:
    x - the new X coordinate of the origin.
    y - the new Y coordinate of the origin.
  - getPosition
```
public Vector2f getPosition()
```
    Description copied from interface: Transformable
    
    Gets the position of this object.
    
    Specified by:
    
    getPosition in interface Transformable
    
    Returns:
    the current position.
  - getRotation
```
public float getRotation()
```
    Description copied from interface: Transformable
    
    Gets the rotation angle of this object.
    
    Specified by:
    
    getRotation in interface Transformable
    
    Returns:
    the current rotation angle in degrees.
  - getScale
```
public Vector2f getScale()
```
    Description copied from interface: Transformable
    
    Gets the scaling of this object.
    
    Specified by:
    
    getScale in interface Transformable
    
    Returns:
    the current scaling factors.
  - getOrigin
```
public Vector2f getOrigin()
```
    Description copied from interface: Transformable
    
    Gets the origin of this object.
    
    Specified by:
    
    getOrigin in interface Transformable
    
    Returns:
    the current origin.
  - move
```
public final void move(float x,
        float y)
```
    Description copied from interface: Transformable
    
    Moves this object.
    
    Specified by:
    
    move in interface Transformable
    
    Parameters:
    x - the X offset added to the current position.
    y - the Y offset added to the current position.
  - move
```
public final void move(Vector2f v)
```
    Description copied from interface: Transformable
    
    Moves the object.
    
    Specified by:
    
    move in interface Transformable
    
    Parameters:
    v - the offset vector added to the current position.
  - rotate
```
public final void rotate(float angle)
```
    Description copied from interface: Transformable
    
    Rotates this object around its origin.
    
    Specified by:
    
    rotate in interface Transformable
    
    Parameters:
    angle - the rotation angle in degrees.
  - scale
```
public final void scale(float x,
         float y)
```
    Description copied from interface: Transformable
    
    Scales the object, using its origin as the scaling center.
    
    Specified by:
    
    scale in interface Transformable
    
    Parameters:
    x - the X scaling factor.
    y - the Y scaling factor.
  - scale
```
public final void scale(Vector2f factors)
```
    Description copied from interface: Transformable
    
    Scales the object, using its origin as the scaling center.
    
    Specified by:
    
    scale in interface Transformable
    
    Parameters:
    factors - the scaling factors.
  - getTransform
```
public Transform getTransform()
```
    Description copied from interface: Transformable
    
    Gets the current transformation matrix.
    
    Specified by:
    
    getTransform in interface Transformable
    
    Returns:
    the current transformation.
  - getInverseTransform
```
public Transform getInverseTransform()
```
    Description copied from interface: Transformable
    
    Gets the inverse of the current transformation matrix.
    
    Specified by:
    
    getInverseTransform in interface Transformable
    
    Returns:
    the inverse of the current transform.

Class Sprite

Constructor Summary

Method Summary

Methods inherited from class org.jsfml.internal.SFMLNativeObject

Methods inherited from class java.lang.Object

Constructor Detail

Sprite

Sprite

Sprite

Method Detail

nativeCreate

nativeSetExPtr

nativeDelete

setTexture

setTexture

setTextureRect

setColor

getTexture

getTextureRect

getColor

getLocalBounds

getGlobalBounds

setPosition

setRotation

setScale

setOrigin

draw

setPosition

setScale

setOrigin

getPosition

getRotation

getScale

getOrigin

move

move

rotate

scale

scale

getTransform

getInverseTransform