common.Drawable Class Reference

This is the abstract class to represent the basic components (X and Y) for drawing on the game board. More...

Inheritance diagram for common.Drawable:

Collaboration diagram for common.Drawable:

List of all members.

Public Member Functions
	Drawable (int x, int y)
	Instantiates a new drawable.
abstract void	draw (Graphics g)
	This draws the shape.
abstract Shape	getShape ()
	This returns an AWT shape which represents the Drawable.
String	getName ()
	Gets the name.
void	setName (String name)
	Sets the name.
int	getX ()
	Gets the x.
void	setX (int x)
	Sets the x.
int	getY ()
	Gets the y.
void	setY (int y)
	Sets the y.
boolean	isVisible ()
	Checks if is visible.
void	setVisible (boolean isVisible)
	Sets the visible.
int	hashCode ()
boolean	equals (Object obj)
Protected Attributes
String	name
	The name.
int	x
	The x.
int	y
	The y.
boolean	isVisible
	The is visible.

---

Detailed Description

This is the abstract class to represent the basic components (X and Y) for drawing on the game board.

It also forces implementation of a draw method.

Author:

snandi

---

Constructor & Destructor Documentation

common.Drawable.Drawable	(	int	x,
		int	y
	)		[inline]

Instantiates a new drawable.

Parameters:

x	the x
y	the y

References common.Drawable.isVisible(), common.Drawable.x, and common.Drawable.y.

Referenced by common.Drawable.equals().

---

Member Function Documentation

abstract void common.Drawable.draw

(

Graphics

g

)

[pure virtual]

This draws the shape.

Parameters:

g

the g

Implemented in ui.draw.TriangleShip, and ui.draw.SquareShot.

Referenced by ui.GraphicsPanel.paintComponent().

boolean common.Drawable.equals

(

Object

obj

)

[inline]

Reimplemented in common.Ship, and common.Shot.

References common.Drawable.Drawable(), common.Drawable.x, and common.Drawable.y.

String common.Drawable.getName

(

)

[inline]

Gets the name.

Returns:

the name

References common.Drawable.name.

abstract Shape common.Drawable.getShape

(

)

[pure virtual]

This returns an AWT shape which represents the Drawable.

Returns:

the shape

Implemented in ui.draw.TriangleShip, and ui.draw.SquareShot.

Referenced by controllers.ShotManager.performIntenseDetonationCheck().

int common.Drawable.getX

(

)

[inline]

Gets the x.

Returns:

the x

References common.Drawable.x.

Referenced by controllers.ShotManager.checkIfShotDetonates(), controllers.ShotManager.checkIfShotExitsBoard(), ui.draw.SquareShot.createShot(), ui.draw.SquareShot.draw(), ui.draw.SquareShot.getShape(), controllers.ShotManager.incrementShot(), controllers.KeyboardShipController.run(), controllers.KeyboardShipController.shoot(), and controllers.KeyboardShipController.TestShoot().

int common.Drawable.getY

(

)

[inline]

Gets the y.

Returns:

the y

References common.Drawable.y.

Referenced by ui.draw.SquareShot.createShot(), ui.draw.SquareShot.draw(), ui.draw.SquareShot.getShape(), controllers.KeyboardShipController.run(), controllers.KeyboardShipController.shoot(), and controllers.KeyboardShipController.TestShoot().

int common.Drawable.hashCode

(

)

[inline]

Reimplemented in common.Ship, and common.Shot.

References common.Drawable.x, and common.Drawable.y.

boolean common.Drawable.isVisible

(

)

[inline]

Checks if is visible.

Returns:

the isVisible

Referenced by common.Drawable.Drawable(), common.Drawable.setVisible(), common.Shot.toString(), and common.Ship.toString().

void common.Drawable.setName

(

String

name

)

[inline]

Sets the name.

Parameters:

name	the name to set

References common.Drawable.name.

Referenced by federate.RTI1516e.MakShooterRTI1516eFederateAmbassador.setShipByAttributes(), and ui.RTIActionHelper.startNewGame().

void common.Drawable.setVisible

(

boolean

isVisible

)

[inline]

Sets the visible.

Parameters:

isVisible

the isVisible to set

References common.Drawable.isVisible().

Referenced by federate.RTI1516e.MakShooterRTI1516eFederateAmbassador.discoverNewShot(), controllers.ShotManager.generateInitialShotPool(), federate.RTI1516e.MakShooterRTI1516eFederateAmbassador.reflectAttributeValuesShot(), controllers.ShotManager.removeShotFromUI(), federate.RTI1516e.MakShooterRTI1516eFederateAmbassador.setShipByAttributes(), controllers.KeyboardShipController.shoot(), and ui.RTIActionHelper.startNewGame().

void common.Drawable.setX

(

int

x

)

[inline]

Sets the x.

Parameters:

x

the new x

References common.Drawable.x.

Referenced by controllers.ShotManager.incrementShot(), controllers.KeyboardShipController.moveShip(), federate.RTI1516e.MakShooterRTI1516eFederateAmbassador.reflectAttributeValuesShot(), federate.RTI1516e.MakShooterRTI1516eFederateAmbassador.setShipByAttributes(), and controllers.KeyboardShipController.shoot().

void common.Drawable.setY

(

int

y

)

[inline]

Sets the y.

Parameters:

y

the new y

References common.Drawable.y.

Referenced by controllers.KeyboardShipController.moveShip(), federate.RTI1516e.MakShooterRTI1516eFederateAmbassador.reflectAttributeValuesShot(), federate.RTI1516e.MakShooterRTI1516eFederateAmbassador.setShipByAttributes(), and controllers.KeyboardShipController.shoot().

---

Member Data Documentation

boolean common.Drawable.isVisible [protected]

The is visible.

String common.Drawable.name [protected]

The name.

Referenced by ui.draw.TriangleShip.draw(), common.Drawable.getName(), and common.Drawable.setName().

int common.Drawable.x [protected]

The x.

Referenced by ui.draw.TriangleShip.draw(), common.Drawable.Drawable(), common.Drawable.equals(), ui.draw.TriangleShip.getShape(), common.Drawable.getX(), common.Drawable.hashCode(), common.Drawable.setX(), common.Shot.toString(), and common.Ship.toString().

int common.Drawable.y [protected]

The y.

Referenced by ui.draw.TriangleShip.draw(), common.Drawable.Drawable(), common.Drawable.equals(), ui.draw.TriangleShip.getShape(), common.Drawable.getY(), common.Drawable.hashCode(), common.Drawable.setY(), common.Shot.toString(), and common.Ship.toString().

---

The documentation for this class was generated from the following file:

• Drawable.java