ktbyte.sprite

Class Sprite

java.lang.Object

ktbyte.sprite.Sprite

public class Sprite
extends Object

The Sprite class keeps track of a Sprite (image) and its size, direction, position and hitbox. Through its methods, a Sprite can easily resize, rotate, move and detect collision (with other Sprites or points on the canvas). Coordinates for Sprites always use imageMode(CENTER) and angles are always measured in degrees.

By default, a Sprite's direction faces directly right, and it assumes that its image is also right-ward facing. This can be adjusted using the frontAngle() function.

Here is a simple demo of a Sprite in action:

 Sprite s = new Sprite("https://content.ktbyte.com/images/tank.png", 250, 200, 50, 50);

 void setup() {
   size(500, 400);
 }

 void draw() {
   background(0, 0, 0);
   s.display();
   s.forward(1);
 }
 

Constructor Summary

Constructors

Constructor and Description
Sprite(float x, float y, float w, float h) Initializes the Sprite with the given coordinates and size to a rectangle with a solid black color.
Sprite(Sprite s) Makes a copy of the input Sprite, with identical image, coordinates and size.
Sprite(String url, float x, float y, float w, float h) Initializes the Sprite with the given image URL, coordinates and size.

Method Summary

Modifier and Type	Method and Description
void	display() Draws the Sprite.
void	displayHitbox() Draws the Sprite's hitbox.
float	distTo(Sprite s) Calculates the distance from this Sprite to Sprite s
float	distToPoint(float x, float y) Calculates the distance from this Sprite to the specified point
void	flip() Flips Sprite image across its X axis
void	flipX() Changes the direction of the Sprite by flipping the x component of its direction
void	flipY() Changes the direction of the Sprite by flipping the y component of its direction
void	forward(float steps) Moves the Sprite forward in the direction it is facing.
void	frontAngle(float degrees) Adjust the direction of the PImage of the Sprite without changing its orientation
float	getDir() Gets the direction of the Sprite
float	getH() Gets the height of the Sprite
def.processing.core.PImage	getImage() Gets the image of the Sprite
float	getW() Gets the width of the Sprite
float	getX() Gets the x coordinate of the Sprite
float	getY() Gets the y coordinate of the Sprite
static void	init(def.processing.core.PApplet pa)
boolean	insideSprite(Sprite s) Checks to see if this Sprite is fully inside another sprite.
boolean	isInsideScreen() Checks whether this Sprite's hitbox is at least partially inside the canvas
void	moveToPoint(float x, float y) Moves the Sprite to the specified coordinate.
void	moveToSprite(Sprite s) Moves the Sprite to the specified Sprite s
void	moveX(float x) Moves the Sprite in the x axis by the specified amount.
void	moveXY(float dx, float dy) Moves the Sprite in the x and y axes by the specified amounts.
void	moveY(float y) Moves the Sprite in the y axis by the specified amount.
void	resetHitboxCenter() Recenter the Sprite's hitbox to its center
void	resetRectHitbox() Resets the Sprite's hitbox to its own width and height
void	resetRoundHitbox() Sets the Sprite's hitbox to a circle with radius equals to (sum of its width and height) / 4.
void	setColor(float r, float g, float b) Changes the color of a Sprite.
void	setCoor(float x, float y) Moves the Sprite to the specified coordinate.
void	setHitboxCenter(float x, float y) Recenter the Sprite's hitbox relative to its center
void	setHitboxPoints(def.processing.core.PVector[] array) Set the Sprite's hitbox to a polygon defined by a list of PVectors (points) relative to its center
void	setImage(def.processing.core.PImage img) Changes the image of the Sprite
void	setRectHitbox(float w, float h) Adjusts the Sprite's hitbox, which is set to the Sprite's width and height by default.
void	setRoundHitbox(float r) Sets the Sprite's hitbox to a circle.
void	setSize(float w, float h) Sets the size of the Sprite.
void	setX(float x)
void	setY(float y)
void	sideStep(float steps) Moves the Sprite in the direction 90 degrees clockwise from its forward direction.
boolean	touchingPoint(float x, float y) Checks whether this Sprite is touching the specified point.
boolean	touchingSprite(Sprite s) Checks to see if this Sprite is touching Sprite s.
void	turn(float degrees) Rotates the Sprite by a specified number of degrees
void	turnToDir(float angle) Rotates the Sprite to specified (absolute) angle.
void	turnToPoint(float x, float y) Rotates the Sprite to face the specified (x, y) location
void	turnToSprite(Sprite s) Rotates the Sprite to the specified Sprite s

Methods inherited from class java.lang.Object

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

Constructor Detail

Sprite

public Sprite(String url,
              float x,
              float y,
              float w,
              float h)

Initializes the Sprite with the given image URL, coordinates and size.

Parameters:

url - The URL of the image for the Sprite to use.

x - The initial x coordinate of the Sprite

y - The initial y coordinate of the Sprite

w - The initial width of the Sprite

h - The initial height of the Sprite

Sprite

public Sprite(float x,
              float y,
              float w,
              float h)

Initializes the Sprite with the given coordinates and size to a rectangle with a solid black color. The color of this Sprite can be changed using the setColor() function

Parameters:

x - The initial x coordinate of the Sprite

y - The initial y coordinate of the Sprite

w - The initial width of the Sprite

h - The initial height of the Sprite

Sprite

public Sprite(Sprite s)

Makes a copy of the input Sprite, with identical image, coordinates and size.

Parameters:

s - The Sprite to copy from.

Method Detail

init

public static void init(def.processing.core.PApplet pa)

frontAngle

public void frontAngle(float degrees)

Adjust the direction of the PImage of the Sprite without changing its orientation

Parameters:

degrees - The degrees of turn to adjust the PImage

setRectHitbox

public void setRectHitbox(float w,
                          float h)

Adjusts the Sprite's hitbox, which is set to the Sprite's width and height by default.

Parameters:

w - The width of the hitbox

h - The height of the hitbox

resetRectHitbox

public void resetRectHitbox()

Resets the Sprite's hitbox to its own width and height

setRoundHitbox

public void setRoundHitbox(float r)

Sets the Sprite's hitbox to a circle.

Parameters:

r - The radius of the circle

resetRoundHitbox

public void resetRoundHitbox()

Sets the Sprite's hitbox to a circle with radius equals to (sum of its width and height) / 4.

setHitboxCenter

public void setHitboxCenter(float x,
                            float y)

Recenter the Sprite's hitbox relative to its center

Parameters:

x - the offset in the x direction, in pixels

y - the offset in the y direction, in pixels

resetHitboxCenter

public void resetHitboxCenter()

Recenter the Sprite's hitbox to its center

setHitboxPoints

public void setHitboxPoints(def.processing.core.PVector[] array)

Set the Sprite's hitbox to a polygon defined by a list of PVectors (points) relative to its center

Parameters:

array - An array of points definig the hitbox polygon

setColor

public void setColor(float r,
                     float g,
                     float b)

Changes the color of a Sprite. This function is only supported for Sprites created without an image.

Parameters:

r - The first parameter defining the color. In default RGB mode, this is the red value.

g - The second parameter defining the color. In default RGB mode, this is the green value.

b - The third parameter defining the color. In default RGB mode, this is the blue value.

flip

public void flip()

Flips Sprite image across its X axis

turn

public void turn(float degrees)

Rotates the Sprite by a specified number of degrees

Parameters:

degrees - The number of degrees to turn

turnToPoint

public void turnToPoint(float x,
                        float y)

Rotates the Sprite to face the specified (x, y) location

Parameters:

x - The x coordinate of the point to face

y - The y coordinate of the point to face

turnToDir

public void turnToDir(float angle)

Rotates the Sprite to specified (absolute) angle.

Parameters:

angle - The direction to turn to

turnToSprite

public void turnToSprite(Sprite s)

Rotates the Sprite to the specified Sprite s

Parameters:

s - The Sprite to turn to

moveToPoint

public void moveToPoint(float x,
                        float y)

Moves the Sprite to the specified coordinate.

Parameters:

x - The x coordinate of the point to move to

y - The y coordinate of the point to move to

moveToSprite

public void moveToSprite(Sprite s)

Moves the Sprite to the specified Sprite s

Parameters:

s - The Sprite to move to

moveX

public void moveX(float x)

Moves the Sprite in the x axis by the specified amount.

Parameters:

x - The amount to move in pixels

moveY

public void moveY(float y)

Moves the Sprite in the y axis by the specified amount.

Parameters:

y - The amount to move in pixels

moveXY

public void moveXY(float dx,
                   float dy)

Moves the Sprite in the x and y axes by the specified amounts.

Parameters:

x - The amount to move in pixels in the x axis

y - The amount to move in pixels in the y axis

forward

public void forward(float steps)

Moves the Sprite forward in the direction it is facing.

Parameters:

steps - The amount to move in pixels.

sideStep

public void sideStep(float steps)

Moves the Sprite in the direction 90 degrees clockwise from its forward direction.

Parameters:

steps - The amount to move in pixels.

display

public void display()

Draws the Sprite. This function should be called in the void draw() function.

displayHitbox

public void displayHitbox()

Draws the Sprite's hitbox. This function should be called in the void draw() function.

flipX

public void flipX()

Changes the direction of the Sprite by flipping the x component of its direction

flipY

public void flipY()

Changes the direction of the Sprite by flipping the y component of its direction

setSize

public void setSize(float w,
                    float h)

Sets the size of the Sprite. The Sprite's hitbox is automatically reset to be rectangular with the same size as the Sprite's new size.

Parameters:

w - The width of the Sprite

h - The height of the Sprite

setCoor

public void setCoor(float x,
                    float y)

Moves the Sprite to the specified coordinate.

Parameters:

x - The x coordinate of the point to move to

y - The y coordinate of the point to move to

setX

public void setX(float x)

setY

public void setY(float y)

setImage

public void setImage(def.processing.core.PImage img)

Changes the image of the Sprite

Parameters:

img - The image to set the Sprite to

getX

public float getX()

Gets the x coordinate of the Sprite

Returns:

the x coordinate of the sprite

getY

public float getY()

Gets the y coordinate of the Sprite

Returns:

the y coordinate of the sprite

getW

public float getW()

Gets the width of the Sprite

Returns:

the width of the sprite

getH

public float getH()

Gets the height of the Sprite

Returns:

the height of the sprite

getImage

public def.processing.core.PImage getImage()

Gets the image of the Sprite

Returns:

the image of the sprite

getDir

public float getDir()

Gets the direction of the Sprite

Returns:

the direction (in degrees) the Sprite in facing

distTo

public float distTo(Sprite s)

Calculates the distance from this Sprite to Sprite s

Parameters:

s - The Sprite to measure distance to

Returns:

the distance from this Sprite to Sprite s

distToPoint

public float distToPoint(float x,
                         float y)

Calculates the distance from this Sprite to the specified point

Parameters:

x - The x coordinate of the point

y - The y coordinate of the point

Returns:

the distance from this Sprite to the specified point

touchingSprite

public boolean touchingSprite(Sprite s)

Checks to see if this Sprite is touching Sprite s.

Parameters:

s - The Sprite to detect whethet this Sprite is touching

Returns:

true if this Sprite is touching Sprite s, false otherwise

insideSprite

public boolean insideSprite(Sprite s)

Checks to see if this Sprite is fully inside another sprite.

Parameters:

s - The Sprite to detect whethet this Sprite is touching

Returns:

true if this Sprite is touching Sprite s, false otherwise

touchingPoint

public boolean touchingPoint(float x,
                             float y)

Checks whether this Sprite is touching the specified point.

Parameters:

x - The x coordinate of the point

y - The y coordinate of the point

Returns:

true if this Sprite is touching the point, false otherwise

isInsideScreen

public boolean isInsideScreen()

Checks whether this Sprite's hitbox is at least partially inside the canvas

Returns:

true if this Sprite is at least partially inside the canvas, false otherwise