Class Graphic

java.lang.Object

Graphic

public class Graphic
extends java.lang.Object

Instances of the Graphic class are used to represent each graphic in a game. If an image for an object's type exists, that will be drawn instead of the default circles of varying colors and sizes. Graphics can be drawn to the screen in different positions and orientations using their draw() method.

Constructor Summary

Constructors

Constructor and Description
Graphic(java.lang.String type) This constructor creates a Graphic object at position 0,0 with a direction of 0 (facing the right), and the specified appearance.

Method Summary

Modifier and Type	Method and Description
void	draw() This method draws a Graphic to the screen at its current location, and facing in its current direction (orientation).
float	getDirection() This method retrieves the orientation of the current Graphic as an angle measured in radians, where 0: facing right, and PI/2: facing down, PI: facing left, and 3PI/2 (or the equivalent -PI/2): facing up.
float	getDirectionX() This method retrieves part of the orientation of the current graphic as a point that is one unit away, and in the direction this Graphic is facing.
float	getDirectionY() This method retrieves part of the orientation of the current graphic as a point that is one unit away, and in the direction this Graphic is facing.
java.lang.String	getType() This method retrieves the type of the current Graphic.
float	getX() This method retrieves the x-position in pixels of the current Graphic.
float	getY() This method retrieves the y position in pixels of the current Graphic.
boolean	isCollidingWith(Graphic other) Determines whether this Graphic is overlapping or colliding with another Graphic on the screen.
void	setDirection(float angle) This method allows you to update the direction that a Graphic is facing, by specifying an angle (in radians) of rotation, where 0: facing right, and pi/2: facing down, pi: facing left, and 3pi/2: facing up.
void	setDirection(float x, float y) This method allows you to update the direction that a Graphic is facing, by specifying any position on the screen that you would like it to face toward.
void	setPosition(float x, float y) This method allows you to update the position of a Graphic.
void	setType(java.lang.String type) Sets the type of graphic used to represent this object.
void	setX(float x) This method allows you to update the horizontal position of a Graphic.
void	setY(float y) This method allows you to update the vertical position of a Graphic.

Methods inherited from class java.lang.Object

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

Constructor Detail

Graphic

public Graphic(java.lang.String type)

This constructor creates a Graphic object at position 0,0 with a direction of 0 (facing the right), and the specified appearance.

Parameters:

type - - defines the appearance of the newly created object.

Method Detail

setType

public void setType(java.lang.String type)

Sets the type of graphic used to represent this object. If an image of this type cannot be found, then a default circle will be drawn in its place with a single line designating this object's direction. Some of the default types recognized by this method include: "HERO", "FIRE", "PANT", "WATER", and "FIREBALL".

Parameters:

type - The type of graphic used to represent this object.

getType

public java.lang.String getType()

This method retrieves the type of the current Graphic.

Returns:

The name of this Graphic's type.

getX

public float getX()

This method retrieves the x-position in pixels of the current Graphic.

Returns:

The Graphic's x-position in pixels (increasing left to right).

getY

public float getY()

This method retrieves the y position in pixels of the current Graphic.

Returns:

The Graphic's y-position in pixels (increasing top to bottom).

getDirection

public float getDirection()

This method retrieves the orientation of the current Graphic as an angle measured in radians, where 0: facing right, and PI/2: facing down, PI: facing left, and 3PI/2 (or the equivalent -PI/2): facing up.

Returns:

The Graphic's direction in radians.

getDirectionX

public float getDirectionX()

This method retrieves part of the orientation of the current graphic as a point that is one unit away, and in the direction this Graphic is facing. In other words, it returns the cosine of the Graphic's direction angle.

Returns:

The x-coordinate of a point that is one unit away, and in the direction that the Graphic is facing.

getDirectionY

public float getDirectionY()

This method retrieves part of the orientation of the current graphic as a point that is one unit away, and in the direction this Graphic is facing. In other words, it returns the sine of the Graphic's direction angle.

Returns:

The y-coordinate of a point that is one unit away, and in the direction that the Graphic is facing.

setX

public void setX(float x)

This method allows you to update the horizontal position of a Graphic.

Parameters:

x - - is the x-position that you would like to move this Graphic to.

setY

public void setY(float y)

This method allows you to update the vertical position of a Graphic.

Parameters:

y - - is the y-position that you would like to move this Graphic to.

setPosition

public void setPosition(float x,
                        float y)

This method allows you to update the position of a Graphic.

Parameters:

x - - is the x-position that you would like to move this Graphic to.

y - - is the y-position that you would like to move this Graphic to.

setDirection

public void setDirection(float angle)

This method allows you to update the direction that a Graphic is facing, by specifying an angle (in radians) of rotation, where 0: facing right, and pi/2: facing down, pi: facing left, and 3pi/2: facing up.

Parameters:

angle - The angular amount of rotation you would like to apply to this Graphic.

setDirection

public void setDirection(float x,
                         float y)

This method allows you to update the direction that a Graphic is facing, by specifying any position on the screen that you would like it to face toward.

Parameters:

x - - is the x-coordinate of the position for the Graphic to face.

y - - is the y-coordinate of the position for the Graphic to face.

isCollidingWith

public boolean isCollidingWith(Graphic other)

Determines whether this Graphic is overlapping or colliding with another Graphic on the screen.

Parameters:

other - - is the Graphic being checked against for collisions.

Returns:

true when the two objects overlap, and false otherwise.

draw

public void draw()

This method draws a Graphic to the screen at its current location, and facing in its current direction (orientation).