AbstractGameObject

java.lang.Object
- gameobjects.AbstractGameObject

All Implemented Interfaces:

GameObject

Direct Known Subclasses:

AbstractShip, Bullet
```
public abstract class AbstractGameObject
extends java.lang.Object
implements GameObject
```
This class provides implmentation to the interface GameObject. It's the basis of all game objects

Field Summary

Fields
Modifier and Type Field and Description

static javax.swing.JPanel panel

Fields
Modifier and Type	Field and Description
`static javax.swing.JPanel`	`panel`

Constructor Summary

Constructors
Constructor and Description
`AbstractGameObject(int healthPoints, java.lang.String imageLocation)` This constructor creates a game object with given HP and sprite location

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`draw(java.awt.Graphics2D g2d)` This method draws the object.
`java.awt.geom.Point2D.Double`	`getCenter()` This method gets the center as a point.
`java.awt.geom.Point2D.Double`	`getDirection()` This method gets the direction as a point.
`int`	`getHealthPoints()` This method returns the number of HP.
`double`	`getHeight()` This method gets the height of the sprite.
`java.awt.image.BufferedImage`	`getImage()` This method gets the sprite (BufferedImage).
`java.awt.geom.Point2D.Double`	`getPosition()` This method get the position.
`double`	`getWidth()` This method gets the width of the sptie.
`double`	`getXCenter()` This method gets the center on x-axis.
`double`	`getXDirection()` This method get the directoin on x-axis.
`double`	`getXPosition()` This method get the position on x-axis.
`double`	`getXVelocity()` This method get the velocity on x-axis.
`double`	`getYCenter()` This method get the center on y-axis.
`double`	`getYDirection()` This method get the directoin on y-axis.
`double`	`getYPosition()` This method get the position on y-axis.
`double`	`getYVelocity()` This method get the velocity on y-axis.
`void`	`gotHit()` This method is called if the object got hit, decreasing it's HP by 1.
`abstract void`	`initializeLocation()` This method is called when a game object is created and is ready to be given a location on a panel.
`boolean`	`isDead()` This method checks if an object is dead.
`void`	`makeDead()` This method makes te object dead.
`void`	`move()` This method moves the object.
`abstract void`	`moveDirection()` This method moves the object only in terms of direction (rotation).
`abstract void`	`movePosition()` This method moves the object only in term of position.
`void`	`setDirection(java.awt.geom.Point2D location)` This method sets the direction from a point.
`void`	`setDirectionToward(java.awt.geom.Point2D location)` This method sets the directoin toward a point.
`void`	`setHealthPoints(int helathPoints)` This method sets the number of HP.
`void`	`setImage(java.awt.image.BufferedImage image)` This method sets the sprite (BufferedImage).
`void`	`setImageLocation(java.lang.String imageLocation)` This method sets the sprite given the location of the image.
`void`	`setPosition(java.awt.geom.Point2D.Double point)` This method sets the position.
`void`	`setXDirection(double xDirection)` This method sets the directoin on x-axis.
`void`	`setXPosition(double xPosition)` This method sets the position on x-axis.
`void`	`setXVelocity(double xVelocity)` This method sets the velocity on x-axis.
`void`	`setYDirection(double yDirection)` This method sets the directoin on y-axis.
`void`	`setYPosition(double yPosition)` This method sets the position on y-axis.
`void`	`setYVelocity(double yVelocity)` This method sets the velocity on y-axis.

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

- Field Detail
  - panel
```
public static javax.swing.JPanel panel
```
- Constructor Detail
  - AbstractGameObject
```
public AbstractGameObject(int healthPoints,
                          java.lang.String imageLocation)
```
    This constructor creates a game object with given HP and sprite location
    
    Parameters:
    
    healthPoints - the HP of the game object
    
    imageLocation - the location of the sprite
- Method Detail
  - draw
```
public void draw(java.awt.Graphics2D g2d)
```
    This method draws the object. It rotates it around the center according to direction and draws it on it's poisition.
    
    Specified by:
    
    draw in interface GameObject
    
    Parameters:
    
    g2d - the Graphics2D to do the drawing
  - move
```
public void move()
```
    This method moves the object. It moves both position and direction.
    
    Specified by:
    
    move in interface GameObject
  - movePosition
```
public abstract void movePosition()
```
    Description copied from interface: GameObject
    
    This method moves the object only in term of position.
    
    Specified by:
    
    movePosition in interface GameObject
  - moveDirection
```
public abstract void moveDirection()
```
    Description copied from interface: GameObject
    
    This method moves the object only in terms of direction (rotation).
    
    Specified by:
    
    moveDirection in interface GameObject
  - initializeLocation
```
public abstract void initializeLocation()
```
    Description copied from interface: GameObject
    
    This method is called when a game object is created and is ready to be given a location on a panel.
    
    Specified by:
    
    initializeLocation in interface GameObject
  - getXPosition
```
public double getXPosition()
```
    Description copied from interface: GameObject
    
    This method get the position on x-axis.
    
    Specified by:
    
    getXPosition in interface GameObject
    
    Returns:
    
    returns the position on x-axis
  - setXPosition
```
public void setXPosition(double xPosition)
```
    Description copied from interface: GameObject
    
    This method sets the position on x-axis.
    
    Specified by:
    
    setXPosition in interface GameObject
    
    Parameters:
    
    xPosition - the position on x-axis
  - getYPosition
```
public double getYPosition()
```
    Description copied from interface: GameObject
    
    This method get the position on y-axis.
    
    Specified by:
    
    getYPosition in interface GameObject
    
    Returns:
    
    returns the position on y-axis
  - setYPosition
```
public void setYPosition(double yPosition)
```
    Description copied from interface: GameObject
    
    This method sets the position on y-axis.
    
    Specified by:
    
    setYPosition in interface GameObject
    
    Parameters:
    
    yPosition - the position on y-axis
  - getPosition
```
public java.awt.geom.Point2D.Double getPosition()
```
    Description copied from interface: GameObject
    
    This method get the position.
    
    Specified by:
    
    getPosition in interface GameObject
    
    Returns:
    
    returns the position
  - setPosition
```
public void setPosition(java.awt.geom.Point2D.Double point)
```
    Description copied from interface: GameObject
    
    This method sets the position.
    
    Specified by:
    
    setPosition in interface GameObject
    
    Parameters:
    
    point - the position
  - getXVelocity
```
public double getXVelocity()
```
    Description copied from interface: GameObject
    
    This method get the velocity on x-axis.
    
    Specified by:
    
    getXVelocity in interface GameObject
    
    Returns:
    
    returns the velocity on x-axis
  - setXVelocity
```
public void setXVelocity(double xVelocity)
```
    Description copied from interface: GameObject
    
    This method sets the velocity on x-axis.
    
    Specified by:
    
    setXVelocity in interface GameObject
    
    Parameters:
    
    xVelocity - the velocity on x-axis
  - getYVelocity
```
public double getYVelocity()
```
    Description copied from interface: GameObject
    
    This method get the velocity on y-axis.
    
    Specified by:
    
    getYVelocity in interface GameObject
    
    Returns:
    
    returns the velocity on y-axis
  - setYVelocity
```
public void setYVelocity(double yVelocity)
```
    Description copied from interface: GameObject
    
    This method sets the velocity on y-axis.
    
    Specified by:
    
    setYVelocity in interface GameObject
    
    Parameters:
    
    yVelocity - the velocity on y-axis
  - getXDirection
```
public double getXDirection()
```
    Description copied from interface: GameObject
    
    This method get the directoin on x-axis.
    
    Specified by:
    
    getXDirection in interface GameObject
    
    Returns:
    
    returns the direction on x-axis
  - setXDirection
```
public void setXDirection(double xDirection)
```
    Description copied from interface: GameObject
    
    This method sets the directoin on x-axis.
    
    Specified by:
    
    setXDirection in interface GameObject
    
    Parameters:
    
    xDirection - the direction on x-axis
  - getYDirection
```
public double getYDirection()
```
    Description copied from interface: GameObject
    
    This method get the directoin on y-axis.
    
    Specified by:
    
    getYDirection in interface GameObject
    
    Returns:
    
    returns the direction on y-axis
  - setYDirection
```
public void setYDirection(double yDirection)
```
    Description copied from interface: GameObject
    
    This method sets the directoin on y-axis.
    
    Specified by:
    
    setYDirection in interface GameObject
    
    Parameters:
    
    yDirection - the direction on y-axis
  - setDirection
```
public void setDirection(java.awt.geom.Point2D location)
```
    Description copied from interface: GameObject
    
    This method sets the direction from a point.
    
    Specified by:
    
    setDirection in interface GameObject
    
    Parameters:
    
    location - a point containing the direction
  - getDirection
```
public java.awt.geom.Point2D.Double getDirection()
```
    Description copied from interface: GameObject
    
    This method gets the direction as a point.
    
    Specified by:
    
    getDirection in interface GameObject
    
    Returns:
    
    returns the direction as a point
  - setDirectionToward
```
public void setDirectionToward(java.awt.geom.Point2D location)
```
    This method sets the directoin toward a point. A vector is defined by the given location and the game object's center, that vector is normalized because it's used in velocity calculations.
    
    Specified by:
    
    setDirectionToward in interface GameObject
    
    Parameters:
    
    location - a point containing the location of a point to set direction to
  - getWidth
```
public double getWidth()
```
    Description copied from interface: GameObject
    
    This method gets the width of the sptie.
    
    Specified by:
    
    getWidth in interface GameObject
    
    Returns:
    
    returns the width of the sprite
  - getHeight
```
public double getHeight()
```
    Description copied from interface: GameObject
    
    This method gets the height of the sprite.
    
    Specified by:
    
    getHeight in interface GameObject
    
    Returns:
    
    returns the height of the sprite
  - getXCenter
```
public double getXCenter()
```
    Description copied from interface: GameObject
    
    This method gets the center on x-axis.
    
    Specified by:
    
    getXCenter in interface GameObject
    
    Returns:
    
    returns the center on x-axis
  - getYCenter
```
public double getYCenter()
```
    Description copied from interface: GameObject
    
    This method get the center on y-axis.
    
    Specified by:
    
    getYCenter in interface GameObject
    
    Returns:
    
    returns the center on y-axis
  - getCenter
```
public java.awt.geom.Point2D.Double getCenter()
```
    Description copied from interface: GameObject
    
    This method gets the center as a point.
    
    Specified by:
    
    getCenter in interface GameObject
    
    Returns:
    
    returns the center as a point
  - gotHit
```
public void gotHit()
```
    This method is called if the object got hit, decreasing it's HP by 1. It then checks if it's dead. And if it is, informs the game engine.
    
    Specified by:
    
    gotHit in interface GameObject
  - isDead
```
public boolean isDead()
```
    This method checks if an object is dead.
    
    Specified by:
    
    isDead in interface GameObject
    
    Returns:
    
    returns true if HP is less than or equals 0. False otherwise.
  - makeDead
```
public void makeDead()
```
    This method makes te object dead. It sets HP to -1 and calls gotHit()
    
    Specified by:
    
    makeDead in interface GameObject
  - getImage
```
public java.awt.image.BufferedImage getImage()
```
    Description copied from interface: GameObject
    
    This method gets the sprite (BufferedImage).
    
    Specified by:
    
    getImage in interface GameObject
    
    Returns:
    
    returns the sprite
  - setImage
```
public void setImage(java.awt.image.BufferedImage image)
```
    Description copied from interface: GameObject
    
    This method sets the sprite (BufferedImage).
    
    Specified by:
    
    setImage in interface GameObject
    
    Parameters:
    
    image - the BufferedImage to be set as sprite
  - setImageLocation
```
public void setImageLocation(java.lang.String imageLocation)
```
    Description copied from interface: GameObject
    
    This method sets the sprite given the location of the image.
    
    Specified by:
    
    setImageLocation in interface GameObject
    
    Parameters:
    
    imageLocation - the path to the image
  - getHealthPoints
```
public int getHealthPoints()
```
    Description copied from interface: GameObject
    
    This method returns the number of HP.
    
    Specified by:
    
    getHealthPoints in interface GameObject
    
    Returns:
    
    returns number of HP
  - setHealthPoints
```
public void setHealthPoints(int helathPoints)
```
    Description copied from interface: GameObject
    
    This method sets the number of HP.
    
    Specified by:
    
    setHealthPoints in interface GameObject
    
    Parameters:
    
    helathPoints - the number to set the HP as

Class AbstractGameObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

panel

Constructor Detail

AbstractGameObject

Method Detail

draw

move

movePosition

moveDirection

initializeLocation

getXPosition

setXPosition

getYPosition

setYPosition

getPosition

setPosition

getXVelocity

setXVelocity

getYVelocity

setYVelocity

getXDirection

setXDirection

getYDirection

setYDirection

setDirection

getDirection

setDirectionToward

getWidth

getHeight

getXCenter

getYCenter

getCenter

gotHit

isDead

makeDead

getImage

setImage

setImageLocation

getHealthPoints

setHealthPoints