[SOLVED] javaCOMP1040 Assignment 2

C ONTENTS

Introduction 1

GameEngine 1

Provided Classes . 1

engine..GGameEngine .. 1

engine..iinterfaces..IIPaintable . 1

engine..iinterfaces..IIUpdatable 2

engine..GGame 2

engine..mmath..VVector2D .. 2

engine..mmath..BBoundingBox .. 2

UML Di agram . 3

EcoSim 4

Provided Classes . 4

ecosim..ggame..MMain .. 4

ecosim..wworld..TTile 4

ecosim..wworld..GGrassTile 4

ecosim..wworld..SSandTile .. 4

ecosim..eentity..EEntity 4

ecosim..eentity..GGrassTuft . 4

Required Classes .. 5

ecosim..ggame..EEcoSim . 5

ecosim..eent ity..AAnimal .. 5

ecosim..eentity..WWombat . 6

ecosim..eentity..SSnake . 6

ecosim..eexception..OOutOfBoundsException . 7

Source Code Documentation . 7

UML Diagra m . 8

How To Start 9

Additions .. 9

Submission Details 10

Extensions and Late Submissions 10

Academic Misconduct .. 11

Marking Criteria . 11

I NTRODUCTION

This document describes Assignment 2 for Programming Fundamentals.. The assignme nt will require you to write classes to represent Animals and Plants in an ecosystem simulator , called EcoSim . This will be a graphical application,, utilizing your own classes and code with help from a provided game engine . You will be required to demonstrate the use of arrays,, inheritance,, polymorphism and exception handling..

This document outlines how to use the game engine.. Documentation for the game engine may be found in Javadoc format,, written as comments in the source code and organized into html files in the doc folder.. This document also provides instructions for how to complete the ecosystem simulator..

This assignment is an individual task that will require an individual submission . You will be required to submit this project in week 12 of the study period.. In the case that you do not fully understand the assignmen t , please ask your lecturer..

G AME E NGINE

The assignment files include a GameEngine which will aut omatically handle graphics,, input and object updates.. Part of the assignment is learning how to use the provided GameEngine to create a graphical application.. There are many classes in the GameEngine and many methods in those classes.. You will need to read the source code documentation to get a full understanding of how to use them..

Provided Classes

The following is a summary of some of the important classes that have been provided

engine.. GameEngine

GameEngine manages a resizable array of IPaintable,, IUpdatable and ICollidable objects.. It also manages the Keyboard,, Mouse,, GraphicsWindow and Game objects.. All methods in the GameEngine are static,, which means they can be accessed from anywhere without constructing a GameEngine object..

The following is a li st of the most important static methods in the GameEngine::

GameEngine..lloadGame((GGame g)) Calls that games load method and makes the window visible.. It then starts the GameEngine update and paint loops..

GameEngine..aadd((OObject o)) If the object is an IPaintable,, ICollidable and//oor IUpdatable,, it will be added to the GameEngines array a nd will automatically be painted and updated..

GameEngine..aaddToBackground((IIPaintable p)) If the object is an IPaintable,, ICollidable and//oor IUpdatable,, it will be added to the GameEngines background and will automatically be updated and painted behind other IPaintables..

GameEngine..rremove((OObject o)) If the object has been added to the GameEngine it will be removed..

GameEngine..ggetGameObjs(()) Returns all game objects in the Gam eEngines array..

GameEngine..ggetGameObjs((SString classPath)) Returns all objec ts in the GameEngines array that are instances of the argument classPath.. The classPath must be fully qualified,, including the package path.. For example,, getGameObjs((eecosim..eentity .WWombat)) will return all the Wombat objects in the GameEngine .

engine..iinterfaces..IIPaintable

The IPaintable interface has one method,, paint((GGraphics g)).. The Entity and Tile classes implement IPaintable and already have a suitable paint method..

engine..iinte rfaces..IIUpdatable

The IUpdatable interface has one method,, update((llong millisElapsed)).. Entity implements the IUpdatable interface and you will have to write your own update method.. This method will be called automatically by the GameEngine 60 times per sec ond..

engine..GGame

Game is an abstract class including the following abstract methods::

loadKeyFunctions(()) Creates executable functions and binds them to Keyboard keys..

loadMouseFunctions(()) Creates executable functions and binds them to Mouse buttons..

loadIma ges(()) Calls ImageLibrary..lload((SString alias,, String imagePath)) for each image in the assets folder..

getWinWidth(()) Returns the width of the game window..

getWinHeight(()) Returns the height of the game window..

update((llong millisElapsed)) Updates the state of the game.. Any code that should be executed 60 times a second should be added here..

The above methods will have to be implemented in any class that derives from Game.. Game has one non static method,, load(()),, which will automatically call loadImages(()),, loadMous eFunctions(()) and loadKeyFunctions(())..

engine..mmath..VVector2D

A Vector2D contains x and y coordinates.. It can be interpreted as a point in space or a direction with an origin.. The Vector2D contains the following methods::

add((VVector2D other)) Adds the argument x to this x and the argument y to this y..

subtract((VVector2D other)) Subtracts the argument x from this x and the argument y from this y..

scale((ffloat scale)) Multiplies both the x and y by the argument scale..

normalize(()) Divides the x and y components by the V ectors length.. The result is a Vector with a length of 1,, also known as a unit vector..

distance((VVector2D other)) Returns the distance between this Vector and the argument Vector..

engine..mmath..BBoundingBox

A BoundingBox contains a position,, as a Vector2D,, and a width and height.. The position is the top left point of the box.. It contains the following methods::

move((VVector2D movement)) Adds the argument vector to this objects position..

distance((BBoundingBox other)) Returns the distance between this BoundingBoxs p osition and the arguments position..

contains((VVector2D point)) Returns true if the given point is inside this BoundingBox..

intersects((BBoundingBox other)) Returns true if any corner point in the argument is inside this BoundingBox..

E CO S IM

EcoSim attempts to simulate the relationship between predators and prey in the environment.. Each animal will have to find food to survive.. If they survive for long enough they will reproduce to create more animals.. Some animals eat other animals.. Some animals eat plants.. In this assignment our animals will be wombats and snakes.. The snakes will eat the wombats,, the wombats will eat grass.. The wombats will breed faster than the snakes but will have to eat more to stay alive..

You will need to complete the ecosim package and add its game objects to the GameEngine.. In this assignment,, you will have to define five classes.. You will need to define the Animal,, Wombat and Snake classes.. You will also need to define the EcoSim and OutOfBoundsException classes.. You have been provided some complete classes to get you started.. These include Main,, Entity,, GrassTuft,, Tile,, SandTile and GrassTile..

Provided Classes

The following classes have been provided for you

ecosim..ggame.. Main

Main is the starting point of the program.. I t constructs an EcoSim object and adds it to the GameEngine.. Execute the main method in the Main class to start the EcoSim application..

ecosim..wworld.. Tile

Tile contains a BoundingBox and a BufferedImage.. Tile implements IPaintable so it has a paint method w hich will paint its image to its bounding box position.. Tiles will be created and arranged into a grid.. This will act as a background image and determine the area in which the Wombats and Snakes are allowed to move.. Once added to the GameEngine,, using Game Engine..aaddToBackground((ttile)),, it will automatically be painted to the screen and will appear behind images added on top of it.. It also contains the constants Tile..WWIDTH and Tile..HHEIGHT which should be used as the width and height of every Tile..

ecosim..wworld.. GrassTile

GrassTile extends from Tile.. GrassTufts are only allowed to be created in the same position as a GrassTil e.. GrassTiles should be added to the GameEngine background..

ecosim..wworld.. SandTile

SandTile extends from Tile.. A GrassTuft should never be allowed to grow on top of a SandTile.. SandTiles should also be added to the GameEngine background..

ecosim..eentity.. Entit y

Entity is the base class of Animal and GrassTuft . An Entity has a b ounding b ox,, a target position,, an image and an alive status . The bounding box determines the Entitys position and size.. Entity implements IPaintable and consequently,, has a paint method which will paint the Entitys image to the screen at its position.. It implements IUpdatable so it has an abstract update method,, which should be overridden in its derived classes to determine how the Entity acts and how it moves.. In gene ral,, the Entity will move towards its target position over time.. It has a die method which,, when called,, will set alive to false and automatically remove the Entity from the GameEngine.. Once removed from the GameEngine,, an Entity will not be updated or pai nted to the screen..

Any class extending from Entity can be added to the GameEngine using GameEngine..aadd((eentity)).. This will paint it on top of objects added to the background..

ecosim..eentity.. GrassTuft

GrassTuft extends from Entity and,, as a result,, has an i mage,, bounding box,, and alive status.. It will be painted to the screen at its bounding box position.. It can die,, just like any Entity.. It also has an update method,, but the update method is empty.. Wombats will find GrassTuft objects,, move to their location and eat them.. If a GrassTuft is eaten by a Wombat,, the GrassTuft will die and be removed from the GameEngine..

Required Classes

The following classes will need to be written by you

ecosim..ggame.. EcoSim

EcoSim extends from the abstract class engine..GGame . It must implement the abstract methods loadKeyFunctions(()),, loadMouseFunctions(()),, loadImages(()),, getWinWidth(()),, getWinHeight(()) and update((llong millisElapsed)).. Most of these methods have been written for you.. The class contains a gridWidth,, gridHeight,, time r and 2 dimensional array of Tiles.. The gridWidth and gridHeight determine the length of the tile array.. The timer will be used in the update method..

Complete the EcoSim constructor to save the arguments gridWidth and gridHeight to instance variables.. Init ialize the length of the tile array to gridHeight arrays of gridWidth length each.. Implement the getWinWidth method to return gridWidth multiplied by the Tile width.. Implement the getWinHeight method to return gridHeight multiplied by the Tile height..

The EcoSim load method should call super..lload(()).. This will automatically call the loadKeyFunctions(()),, loadMouseFunctions(()) and loadImages(()) methods.. After calling super..lload(()),, you will need to create a two dimensional array of Tiles and add each to the GameEn gine background.. You will need a nested for loop to place the tiles at intervals of Tile.. WIDTH along the x coordinate and intervals of Tile.. HEIGHT along the y coordinate..

While creating your tiles,, g enerate a random number and use it to ensure that approximately 80%% of the Tiles are GrassTiles and 20%% of the Tiles are SandTiles.. If it is a GrassTile,, generate another random number and use it to ensure that 50%% of the time,, you create a GrassTuft object and add it to the GameEngine at the same position as the GrassTile.. Generate another random number and use it to ensure that about 20%% of the time,, you add a Wombat at the same position as the Tile and 10%% of the time,, you add a Snake.. There should be about half as many Snakes as Wombats..

The EcoSim update method should add a GrassTuft object to the GameEngine background every 1000 milliseconds.. Add the millisElapsed argument to the timer instance variable.. If the timer is greater than 1000 add a GrassTuft object in the same position as a random GrassTile that does not already have a GrassTuft in the same position.. You can access the GrassTuft objects from the GameEngine using GameEngine..ggetGameObjs((eecosim..eentity..GGrassTuft)).. This will return an Object array.. You can type cast each item from the array to a GrassTuft and check its position is not the same as the GrassTile you have selected.. If none of the GrassTufts are in its position,, create the GrassTuft here.. If a GrassTuft was succes sfully created,, reset the timer back to zero..

ecosim..eentity.. Animal

Animal is an abstract class that extends from Entity.. It has energy,, breedTime,, maxBreed Time,, speed and a timer . The energy starts at a high number but,, if it reaches zero,, the Animal will die.. The breedTime will start at maxBreedTime and when it reaches zero,, the Animal will breed to create a copy of itself and add it to the GameEngine.. The breedTime will then be reset to maxBreedTime.. The speed determines how far the Animal can move each s tep.. The timer will add up towards 1000.. Every time it reaches 1000,, it will decrease the energy by 1 and decrease the breedTime by 1.. The timer should then be reset to zero..

You will need to complete the constructor,, provide getters and setters and imple ment the update method.. In the constructor,, initialize the instance v ariables to the given arguments and i nitialize the timer to zero.. Also call the abstract selectTarget method.. Add getters and setters for each of the variables except for the timer.. Ensur e that the setters only change the variables if the argument is greater than or equal to zero..

The Animal update method should add the millisElapsed to the timer.. If the timer is greater than 1000,, the timer should reset to zero and the energy and the bre edTime should decrease by one.. If the energy is zero or less,, the animal should call the die(()) method.. Otherwise,, if the breedTime is less than or equal to zero,, the Animal should call the breed method and add the result to the GameEngi ne.. If the Animal is still alive , the animal should move towards its target position .

The breed method should return a Snake at the same position as the calling object.. The update method should call super..uupdate(()).. Provided the Snake is not dead,, it should se t its speed to its moveSpeed.. If its targetWombat is not null and the targetWombat is alive,, if the distance to the Wombat is less than half a Tile width , then the Snake should gain the energy of the Wombat,, the Wombat should die and the targetWombat shoul d be set to null.. Otherwise,, if the distance from the Snake to the Wombat is less than 3 Tile widths,, set the Snakes speed to its attackSpeed , so it can chase down the Wombat.. It should then call the selectTarget method..

The selectTarget method will check to see if the Snakes energy is lower than 8 and if it is,, the Snake should find the closest Wombat object and set a reference to that Wombats position as the Snakes target.. The Wombat should also be saved as the Snakes target Wombat . If the Snake does not have a target Wombat and it does not have a target,, you should generate a new target at a random position between 0 and 150 pixels away from the Snakes current position.. If the new targets x or y coordinate is less than zero or its x coordinate is gre ater than the Games pixel width or its y coordinate is greater than the Games pixel height,, you should throw an OutOfBoundsException.. If an OutOfBoundsException is caught,, the target vector should be constrained to between 0 and the Games width along th e x and between 0 and the Games height along the y..

ecosim..eexception.. OutOfBoundsException

The OutOfBoundsException class should extend from Exception.. It should have a private final instance variable called badPosition that contains a Vector2D.. The class will need a constructor that takes a Vector2D parameter and saves it in the instance variable.. It should also call super with the default error message,, OOut of bounds:: + badPosition.. Provide a getter method to return the badPosition..

Source Code Docume ntation

You will be required to include source code documentation for each of the methods you write.. You must place a comment between /**** and *// on the line above each of the methods you write.. Describe in detail what the method does,, what parameters are required and what value is returned..

An example of a doc string for the EcoSim getWinWidth method is as follows :

/****

* Return the total screen width of the Game,, which should be

* the number of horizontal Tiles multiplied by the tile width .

* @rreturn gridWidth multiplied by default Tile width..

*//

public int getWinWidth(()) {

return this . gridWidth * Tile.. WIDTH ;

}

H OW T O S TART

The follow ing are a few things you can do to test that the GameEngine works::

Implement any unimplemented methods to remove all the compile errors..

In the EcoSim load method,, under super..lload(()) call GameEngine..aadd((nnew Wombat((2200,, 300)))).. This should put a Wombat on t he screen.. Change the numbers to change the Wombats position..

If your window is too small,, return a number from the EcoSim getWinHeight(()) and getWinWidth(()) method.. Maybe return 600 from the getWinWidth(()) and return 400 from getWinHeight(())..

In the Wombat update method call this..ggetBounds(())..mmove((11,, 0)).. This should cause the Wombat to move 1 pixel to the right 60 times per second.. Try ch anging the numbers to see what causes it to move in different directions..

Press the tilde button ( ~ ).. This should set the GameEngine debugging state to true.. You should be able to see a BoundingBox drawn around the Wombat.. Normally this would show the movement vector as an arrow,, but you will have to follow the spec ifications above to get that to work.. You can also try press ing the space key to pause the program..

You may like to open the GameEngine,, BoundingBox and Vector2D classes to read their code . You may also like to read the documentation in the doc folder.. This should give you further understanding of how the GameEngine works..

Once you are feeling confident return to the EcoSim Required Classes section and follow the instructions to complete the assignment..

A DDITIONS

The EcoSim and GameEngine are extendable.. For full marks you must implement at least one of the following additions . Please only attempt these once you have completed all other requirements.. If you submit an unfinished addition,, please ensure that your code still compiles without errors..

Another Animal : Implement a predator of Snakes or anot her predator of GrassTufts.. The new Animal must have a new image..

Animation : Implement sprite animations.. In the assets//iimages folder,, there is a second image for both Wombat and Snake.. Cycle between the first and second image every 500 milliseconds to cre ate a walk cycle..

Obstacle : Implement a new Tile that Animals cannot stand on or move through.. Water or Bush tiles might be appropriate.. These Tiles will need new images..

Wombat Artificial Intelligence : Wombats should try to m ove away from any nearby Snake s,, unless they are hungry and the Snake has gotten in the way of their food..

Collisions : Implement the ICollidable interface for Snakes and Wombats so that Snakes do not pass through other Snakes and Wombats do not pass through other Wombats..

Realistic Bre eding : Implement the ICollidable interface for Animals so that Animals can only breed when their breedTimer is less than or equal to zero and they have collide d with another object of the same class..

Sound : Add a sound system and sound files to the EcoSim,, so that Snakes and Wombats make sounds whenever they eat,, breed or die..

Paused Label : Display a label saying PAUSED at the center of the screen whenever the GameEngine is paused..

Other : If you would like to make an addition not listed above,, pleas e discuss it with your lecturer..

S UBMISSION D ETAILS

You are required to submit an electronic copy of your program via Moodle . Make sure your eclipse project is included in a zip file (WWinZip)).. The zip file should be called your Id..zzip . For example:: bonj y 12 07..zzip . Ensure that your file s are named correctly (aas per instructions outlined in this document))..

All Java files that you submit must include the following comments..

/****

/ File:: fileName .jjava

/ Author:: your name

/ Id:: your id

/ Version:: 1.0 todays date

/ Description:: Assignment 2 .

/ This is my own work as defined by the SAIBT

/ Academic Misconduct policy..

*//

This is to acknowledge this is your own individual work..

Assignments that do not contain these details may not be marked..

Work that has not been correctly submitted to Moodle will not be marked..

It is expected that students will make copies of all assignments and be able to provide these if required..

E XTENSIONS AND L ATE S UBMISSIONS

There will be no extensions//lla te submissions for this course without one of the following exceptions::

1.. A medical certificate is provided that has the timing and duration of the illness and an opinion on how much the students ability to perform has been compromised by the illness.. Pleas e note if this information is not provided the medical certificate WILL NOT BE ACCEPTED.. Late assessment items will not be accepted unless a medical certificate is presented to the Course Coordinator.. The certificate must be produced as soon as possible and must cover the dates during which the assessment was to be attempted.. In the case where you have a valid medical certificate,, the due date will be extended by the number of days stated on the certificate up to five working days..

2.. A SAIBT councillor con tacts the Course Coordinator on your behalf requesting an extension.. Normally you would use this if you have events outside your control adversely affecting your course work .

3.. Unexpected work commitments.. In this case,, you will need to attach a letter fro m your work supervisor with your application stating the impact on your ability to complete your assessment..

4.. Military obligations with proof..

Applications for extensions must be lodged with the Course Coordinator before the due date of the assignment..

Note : Equipment failure,, loss of data,, HHeavy work commitments or late starting of the course are not sufficient grounds for an extension..

A CADEMIC M ISCONDUCT

Students are reminded that they should be aware of the academic misconduct guidelines available from the SAIBT website..

Deliberate academic misconduct such as plagiarism is subject to penalties.. Information about Academic integrity can be found in the PPolicies and Procedures section of the SAIBT website..

M ARKING C RITERIA

Assessment feedback

Programming Fundamentals (CCOMP1040))

Assignment 2 Weighting:: 20 %

N AME :

M AX M ARK

M ARK

C OMMENT

E CO S IM : C onstructor (33)),, l oad(( 7 ),, update((11 0 )

2 0

A NIMAL : C onstructor(( 2 ),, update((110 ),, getters and setters(( 8 )

2 0

W OMBAT : Constructor((33)),, update((55)),, selectTarget((55)),, findGrass((77))

20

S NAKE : Constructor((33)),, update((55)),, selectTarget((55)),, findWombat((77))

20

O UT O F B OUNDS E XCEPTION : Constructor((33)),, getter((22)),, Exception Handling((55))

10

S TYLE : Doc comments (55))

5

A DDITIONS * : Animation (110 ) , extra animal(( 10)),, obstacle((110)),, Wombat A . I . (110)),, collisions((110)),, breeding((110)),, sound((110)),, paused label(( 10 ) , other

5 ~ 20

T OTAL

100 MARKS

*NNote that the maximum marks without additions is 95%%.. An addition must be made for full marks.. Additions may recover lost marks up to a maximum of 20..

Possible d eductions::

Programming style : 10 marks for poor or no commenting,, poor variable names,, poor indentation,, use of break and continue etc..

Submitted incorrectly:: 20 marks if assignment is submitted incorrectly .