net.stemkoski.bagel

Class Sprite

java.lang.Object

net.stemkoski.bagel.Entity

net.stemkoski.bagel.Sprite

public class Sprite
extends Entity

Sprites represent game world entities: characters, environment, items, obstacles, etc.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.ArrayList<Action>	actionList
double	angle angle of rotation of the texture
Animation	animation
(package private) Rectangle	boundary shape used for collision
boolean	flipped determines whether texture is reversed along the y direction
(package private) double	height height of sprite
boolean	mirrored determines whether texture is reversed along the x direction
double	opacity amount of transparency; value from 0.0 (fully transparent) to 1.0 (fully opaque)
Physics	physics
(package private) Texture	texture image displayed when rendering this sprite
boolean	visible determines if sprite will be visible
(package private) double	width width of sprite
double	x x-coordinate of center of sprite
double	y y-coordinate of center of sprite

Fields inherited from class net.stemkoski.bagel.Entity

container

Constructor Summary

Constructors

Constructor and Description
Sprite() initialize default values of sprite properties

Method Summary

Modifier and Type	Method and Description
void	act(double deltaTime) Run any Action objects added to this Sprite.
void	addAction(Action a) Add an Action to this Sprite.
void	bounceAgainst(Sprite other) Simulate this sprite bouncing off other sprite.
void	boundToScreen(double screenWidth, double screenHeight) Keep sprite completely within screen bounds by adjusting position if necessary.
(package private) void	draw(javafx.scene.canvas.GraphicsContext context) Render this sprite to a canvas using specified parameters
(package private) Rectangle	getBoundary() Get boundary shape for this sprite, adjusted according to current position.
boolean	isOnScreen(double screenWidth, double screenHeight) Check if sprite (boundary rectangle) remains on screen
boolean	isOverlapping(Sprite other) Check if this sprite is overlapping another sprite.
void	moveAtAngle(double distance, double angleDegrees) Move sprite by the specified distance at the specified angle.
void	moveBy(double deltaX, double deltaY) Move this sprite by the specified amounts.
void	moveForward(double distance) Move sprite forward by the specified distance at current angle.
void	preventOverlap(Sprite other) Prevent this sprite from overlapping another sprite.
void	rotateBy(double deltaAngle) Rotate sprite by the specified angle.
void	setAnimation(Animation anim) Set the animation to be used by this Sprite.
void	setPhysics(double accValue, double maxSpeed, double decValue) Initialize physics object and corresponding values.
void	setPosition(double x, double y) Set the coordinates of the center of this sprite.
void	setSize(double width, double height) Set size to use when for boundary and when drawing this sprite
void	setTexture(Texture tex) Set the texture to be displayed when rendering this sprite.
void	wrapToScreen(double screenWidth, double screenHeight) If sprite moves completely beyond one edge of the screen, adjust position so that it reappears by opposite edge of the screen.

Methods inherited from class net.stemkoski.bagel.Entity

remove

Methods inherited from class java.lang.Object

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

Field Detail

x

public double x

x-coordinate of center of sprite

y

public double y

y-coordinate of center of sprite

texture

Texture texture

image displayed when rendering this sprite

width

double width

width of sprite

height

double height

height of sprite

visible

public boolean visible

determines if sprite will be visible

boundary

Rectangle boundary

shape used for collision

angle

public double angle

angle of rotation of the texture

opacity

public double opacity

amount of transparency; value from 0.0 (fully transparent) to 1.0 (fully opaque)

mirrored

public boolean mirrored

determines whether texture is reversed along the x direction

flipped

public boolean flipped

determines whether texture is reversed along the y direction

physics

public Physics physics

actionList

public java.util.ArrayList<Action> actionList

animation

public Animation animation

Constructor Detail

Sprite

public Sprite()

initialize default values of sprite properties

Method Detail

setPosition

public void setPosition(double x,
                        double y)

Set the coordinates of the center of this sprite.

Parameters:

x - x-coordinate of center of sprite

y - y-coordinate of center of sprite

moveBy

public void moveBy(double deltaX,
                   double deltaY)

Move this sprite by the specified amounts.

Parameters:

deltaX - amount to move sprite along x direction

deltaY - amount to move sprite along y direction

setTexture

public void setTexture(Texture tex)

Set the texture to be displayed when rendering this sprite. Also sets width and height of this sprite.

Parameters:

tex - texture to use for this sprite

setSize

public void setSize(double width,
                    double height)

Set size to use when for boundary and when drawing this sprite

Parameters:

width - width of sprite

height - height of sprite

draw

void draw(javafx.scene.canvas.GraphicsContext context)

Render this sprite to a canvas using specified parameters

Overrides:

draw in class Entity

Parameters:

context - GraphicsContext object that handles drawing to the canvas

getBoundary

Rectangle getBoundary()

Get boundary shape for this sprite, adjusted according to current position. Angle of rotation has no effect on the boundary.

Returns:

boundary shape for this sprite

isOverlapping

public boolean isOverlapping(Sprite other)

Check if this sprite is overlapping another sprite.

Parameters:

other - sprite to check for overlap with

Returns:

true if this sprite overlaps other sprite

preventOverlap

public void preventOverlap(Sprite other)

Prevent this sprite from overlapping another sprite.

Parameters:

other - sprite to prevent overlap with

rotateBy

public void rotateBy(double deltaAngle)

Rotate sprite by the specified angle.

Parameters:

deltaAngle - the angle (in degrees) to rotate this sprite

moveAtAngle

public void moveAtAngle(double distance,
                        double angleDegrees)

Move sprite by the specified distance at the specified angle.

Parameters:

distance - the distance to move this sprite

angleDegrees - the angle (in degrees) along which to move this sprite

moveForward

public void moveForward(double distance)

Move sprite forward by the specified distance at current angle.

Parameters:

distance - the distance to move this sprite

boundToScreen

public void boundToScreen(double screenWidth,
                          double screenHeight)

Keep sprite completely within screen bounds by adjusting position if necessary.

Parameters:

screenWidth - width of screen

screenHeight - height of screen

wrapToScreen

public void wrapToScreen(double screenWidth,
                         double screenHeight)

If sprite moves completely beyond one edge of the screen, adjust position so that it reappears by opposite edge of the screen.

Parameters:

screenWidth - width of screen

screenHeight - height of screen

isOnScreen

public boolean isOnScreen(double screenWidth,
                          double screenHeight)

Check if sprite (boundary rectangle) remains on screen

Parameters:

screenWidth - width of screen

screenHeight - height of screen

Returns:

true, if part of sprite (boundary rectangle) remains on screen

setPhysics

public void setPhysics(double accValue,
                       double maxSpeed,
                       double decValue)

Initialize physics object and corresponding values.

Parameters:

accValue - acceleration value

maxSpeed - maximum speed

decValue - deceleration value

bounceAgainst

public void bounceAgainst(Sprite other)

Simulate this sprite bouncing off other sprite. Only use after checking isOverlapping(Sprite). Requires physics object to be initialized.

Parameters:

other - Sprite acting as solid surface to bounce against

setAnimation

public void setAnimation(Animation anim)

Set the animation to be used by this Sprite. Also sets texture, width, and height.

Parameters:

anim - Animation to be used by this Sprite

addAction

public void addAction(Action a)

Add an Action to this Sprite. Actions are automatically run.

Parameters:

a - action to add to this sprite

act

public void act(double deltaTime)

Run any Action objects added to this Sprite. Actions are run in parallel (except for those created with ActionFactory.sequence(Action...) and removed from the Sprite when they are finished.

Overrides:

act in class Entity

Parameters:

deltaTime - amount of time that has passed since the last iteration of the game loop