de.smits_net.games.framework.sprite

Class Sprite

java.lang.Object

de.smits_net.games.framework.sprite.Sprite

All Implemented Interfaces:

java.awt.event.KeyListener, java.awt.event.MouseListener, java.util.EventListener

Direct Known Subclasses:

AnimatedSprite

public class Sprite
extends java.lang.Object
implements java.awt.event.KeyListener, java.awt.event.MouseListener

Class representing a sprite, i.e. an moveable object in the game.

Author:

Thomas Smits

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Sprite.BoundaryPolicy How to handle sprites that reach the boundaries of the board.

Field Summary

Fields

Modifier and Type	Field and Description
protected Board	board the game board.
protected java.awt.Rectangle	bounds The bounds of the sprite movement.
protected java.awt.Dimension	dimension Dimensions of the sprite.
protected ImageBase	image the image that is displayed.
protected Sprite.BoundaryPolicy	policy what happens when the sprite hits the boundaries.
protected java.awt.geom.Point2D.Double	position Position of the sprite.
protected Velocity	velocity velocity of the sprite.
protected boolean	visible indicates whether the sprite is visible.

Constructor Summary

Constructors

Constructor and Description
Sprite(Board board, java.awt.Point position, Sprite.BoundaryPolicy policy, ImagePack image) Creates a new sprite.
Sprite(Board board, java.awt.Point position, Sprite.BoundaryPolicy policy, SimpleImage image) Creates a new sprite.

Method Summary

Modifier and Type	Method and Description
protected java.awt.Polygon	absoluteBorder() Calculate the border in relation to the current position.
void	draw(java.awt.Graphics g) Draw the sprite using the given graphics context.
void	draw(java.awt.Graphics g, java.awt.image.ImageObserver observer) Draw the sprite.
protected void	ensureBoundaryPolicy() Ensure that the boundary policy of the sprite is obeyed.
java.awt.Dimension	getDimension() Get the dimension (width, height) of the sprite.
int	getHeight() Width of the sprite.
java.awt.Point	getPosition() Get the current position.
Velocity	getVelocity() Get the velocity of the sprite.
int	getWidth() Width of the sprite.
<T extends Sprite> boolean	intersects(java.util.List<T> others) Checks the given other objects regarding an intersection with this object.
boolean	intersects(java.awt.Point p) Checks whether the given point is inside the sprite or not.
boolean	intersects(java.awt.Polygon p2) Checks whether this sprite intersects with the given polygon.
boolean	intersects(java.awt.Rectangle other) Checks whether this sprite intersects with the given rectangle.
boolean	intersects(Sprite other) Checks whether this sprite intersects with the given sprite.
boolean	isActive() Is the sprite active, i.e. takes part in the collision detection.
boolean	isVisible() Is the sprite visible.
void	keyPressed(java.awt.event.KeyEvent e)
void	keyReleased(java.awt.event.KeyEvent e)
void	keyTyped(java.awt.event.KeyEvent e)
static java.awt.Polygon	loadPolygonFromFile(java.lang.String path, java.lang.String fileName) Load a polygon definition from a file.
protected void	mouseClicked() Called when the mouse was clicked inside the sprite.
void	mouseClicked(java.awt.event.MouseEvent e)
void	mouseEntered(java.awt.event.MouseEvent e)
void	mouseExited(java.awt.event.MouseEvent e)
protected void	mousePressed() Called when the mouse was pressed inside the sprite.
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
void	move() Move the sprite according to the defined speed.
void	move(Velocity deltaV) Moves the sprite.
void	setActive(boolean active) Sets activity state of the sprite, i.e. if the sprite should take part in collision detection.
void	setBorder(java.awt.Polygon border) Sets the border of the sprite (for collision detection).
void	setBounds(java.awt.Rectangle bounds) Overwrite the bounds automatically determined from the board.
void	setPosition(java.awt.Point position) Sets the position.
void	setVelocity(Velocity velocity) Set the velocity of the sprite.
void	setVisible(java.lang.Boolean visible) Sets the visibility.
void	stop() Stop the movement of the sprite.

Methods inherited from class java.lang.Object

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

Field Detail

board

protected Board board

the game board.

bounds

protected java.awt.Rectangle bounds

The bounds of the sprite movement.

dimension

protected java.awt.Dimension dimension

Dimensions of the sprite.

image

protected ImageBase image

the image that is displayed.

policy

protected Sprite.BoundaryPolicy policy

what happens when the sprite hits the boundaries.

position

protected java.awt.geom.Point2D.Double position

Position of the sprite.

velocity

protected Velocity velocity

velocity of the sprite.

visible

protected boolean visible

indicates whether the sprite is visible.

Constructor Detail

Sprite

public Sprite(Board board,
              java.awt.Point position,
              Sprite.BoundaryPolicy policy,
              ImagePack image)

Creates a new sprite.

Parameters:

board - the board the sprite is displayed on

position - position of the upper left corner of the sprite

policy - the policy when the sprite reaches the boundaries of the board

image - the images

Sprite

public Sprite(Board board,
              java.awt.Point position,
              Sprite.BoundaryPolicy policy,
              SimpleImage image)

Creates a new sprite.

Parameters:

board - the board the sprite is displayed on

position - position of the upper left corner of the sprite

policy - the policy when the sprite reaches the boundaries of the board

image - the single image

Method Detail

absoluteBorder

protected java.awt.Polygon absoluteBorder()

Calculate the border in relation to the current position. This is required to detect intersections between sprites.

Returns:

the border's absolute position

draw

public void draw(java.awt.Graphics g)

Draw the sprite using the given graphics context. This method does not use an ImageObserver and just sets it to null.

Parameters:

g - graphics context

draw

public void draw(java.awt.Graphics g,
                 java.awt.image.ImageObserver observer)

Draw the sprite.

Parameters:

g - graphics context

observer - image observer

ensureBoundaryPolicy

protected void ensureBoundaryPolicy()

Ensure that the boundary policy of the sprite is obeyed.

getDimension

public final java.awt.Dimension getDimension()

Get the dimension (width, height) of the sprite.

Returns:

the dimension

getHeight

public final int getHeight()

Width of the sprite. Convenience method for getDimension().getHeight().

Returns:

the width in pixel

getPosition

public java.awt.Point getPosition()

Get the current position.

Returns:

the current position.

getVelocity

public final Velocity getVelocity()

Get the velocity of the sprite.

Returns:

velocity.

getWidth

public final int getWidth()

Width of the sprite. Convenience method for getDimension().getWidth().

Returns:

the width in pixel

intersects

public <T extends Sprite> boolean intersects(java.util.List<T> others)

Checks the given other objects regarding an intersection with this object.

Type Parameters:

T - Type of the objects

Parameters:

others - the others

Returns:

true if there is an intersection, otherwise false

intersects

public boolean intersects(java.awt.Point p)

Checks whether the given point is inside the sprite or not.

Parameters:

p - the point to test for intersection with the sprite

Returns:

true if there is an intersection, otherwise false

intersects

public boolean intersects(java.awt.Polygon p2)

Checks whether this sprite intersects with the given polygon.

Parameters:

p2 - the polygon.

Returns:

true if there is an intersection, otherwise false

intersects

public boolean intersects(java.awt.Rectangle other)

Checks whether this sprite intersects with the given rectangle.

Parameters:

other - the rectangle.

Returns:

true if there is an intersection, otherwise false

intersects

public boolean intersects(Sprite other)

Checks whether this sprite intersects with the given sprite.

Parameters:

other - the other sprite.

Returns:

true if there is an intersection, otherwise false

isActive

public final boolean isActive()

Is the sprite active, i.e. takes part in the collision detection.

Returns:

true if active

isVisible

public final boolean isVisible()

Is the sprite visible.

Returns:

true if visible

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Specified by:

keyPressed in interface java.awt.event.KeyListener

See Also:

KeyListener.keyPressed(java.awt.event.KeyEvent)

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Specified by:

keyReleased in interface java.awt.event.KeyListener

See Also:

KeyListener.keyReleased(java.awt.event.KeyEvent)

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Specified by:

keyTyped in interface java.awt.event.KeyListener

See Also:

KeyListener.keyTyped(java.awt.event.KeyEvent)

loadPolygonFromFile

public static java.awt.Polygon loadPolygonFromFile(java.lang.String path,
                                                   java.lang.String fileName)

Load a polygon definition from a file.

Parameters:

path - directory

fileName - name of the file

Returns:

the loaded polygon

mouseClicked

protected void mouseClicked()

Called when the mouse was clicked inside the sprite.

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Specified by:

mouseClicked in interface java.awt.event.MouseListener

See Also:

MouseListener.mouseClicked(java.awt.event.MouseEvent)

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

See Also:

MouseListener.mouseEntered(java.awt.event.MouseEvent)

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Specified by:

mouseExited in interface java.awt.event.MouseListener

See Also:

MouseListener.mouseExited(java.awt.event.MouseEvent)

mousePressed

protected void mousePressed()

Called when the mouse was pressed inside the sprite.

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Specified by:

mousePressed in interface java.awt.event.MouseListener

See Also:

MouseListener.mousePressed(java.awt.event.MouseEvent)

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

See Also:

MouseListener.mouseReleased(java.awt.event.MouseEvent)

move

public void move()

Move the sprite according to the defined speed.

move

public void move(Velocity deltaV)

Moves the sprite.

Parameters:

deltaV - delta velocity to add to the current velocity of the sprite

setActive

public final void setActive(boolean active)

Sets activity state of the sprite, i.e. if the sprite should take part in collision detection. This method does not turn off the collision detected of the intersects methods but is just there to provide a flag for the user of the sprite to tag it as active/inactive.

Parameters:

active - state to be set

setBorder

public final void setBorder(java.awt.Polygon border)

Sets the border of the sprite (for collision detection).

Parameters:

border - the border to set

setBounds

public void setBounds(java.awt.Rectangle bounds)

Overwrite the bounds automatically determined from the board.

Parameters:

bounds - the new bounds

setPosition

public void setPosition(java.awt.Point position)

Sets the position.

Parameters:

position - The new Position to be set.

setVelocity

public final void setVelocity(Velocity velocity)

Set the velocity of the sprite.

Parameters:

velocity - velocity

setVisible

public final void setVisible(java.lang.Boolean visible)

Sets the visibility.

Parameters:

visible - visibility state

stop

public void stop()

Stop the movement of the sprite.