asteroids.model

Class World

java.lang.Object

asteroids.model.World

public class World
extends java.lang.Object

A class representing an Asteroid World involving the dimensions, witdh and height.

Version:

v2.0

Author:

Stef & Joachim

Constructor Summary

Constructors

Constructor and Description
World(double width, double height) Initaliaze a world with width and height.

Method Summary

Modifier and Type	Method and Description
void	addEntity(Entity entity) Add the given entity to the world.
boolean	entityOutOfBounds(Entity entity) Return true if the entity is out of bounds.
void	evolve(double duration, asteroids.part2.CollisionListener collisionListener) Method to evolve the world during a given duration.
Entity	getEntityAtPosition(double x, double y) Return the entity, if any, at the given x- and y-coordinate.
java.util.Set<Entity>	getEntitySet() Return the set of Entities of this world.
double	getHeight() Returning this world's height.
Entity[]	getNextCollidingEntities() Method that returns the entities involved in the next collision.
double[]	getNextCollisionPosition() Method that returns the position of the next collision.
double	getTimeNextCollision() Return the time until the next collision occurs in this world, if 2 entities overlap, return 0.
double	getWidth() Returning this world's width.
boolean	isTerminated() Return the status of this world.
boolean	isValidEntity(Entity entity) Return true if the entity is valid for this world.
void	removeEntity(Entity entity) Remove the given entity from the world.
void	setHeight(double height) Set the height of this world with the given height.
void	setWidth(double width) Set the width of this world with the given width.
void	terminateWorld() Terminate the world by removing all of its entities.

Methods inherited from class java.lang.Object

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

Constructor Detail

World

public World(double width,
             double height)

Initaliaze a world with width and height.

Parameters:

width - The width of the world.

height - The height of the world.

Method Detail

setWidth

public void setWidth(double width)

Set the width of this world with the given width.

Parameters:

width - The given width for this world.

setHeight

public void setHeight(double height)

Set the height of this world with the given height.

Parameters:

height - The given height for this world.

getWidth

public double getWidth()

Returning this world's width.

Returns:

Returns the width of this world. | result == this.width

getHeight

public double getHeight()

Returning this world's height.

Returns:

Returns the height of this world. | result == this.height

addEntity

public void addEntity(Entity entity)
               throws java.lang.IllegalArgumentException

Add the given entity to the world.

Parameters:

entity - The entity to add.

Throws:

java.lang.IllegalArgumentException - The entity is already in the world.

removeEntity

public void removeEntity(Entity entity)
                  throws java.lang.IllegalArgumentException

Remove the given entity from the world.

Parameters:

entity - Entity to remove.

Throws:

java.lang.IllegalArgumentException

entityOutOfBounds

public boolean entityOutOfBounds(Entity entity)

Return true if the entity is out of bounds.

Parameters:

entity - The given entity to evaluate.

See Also:

implementation

getEntitySet

public java.util.Set<Entity> getEntitySet()

Return the set of Entities of this world.

Returns:

Return the set of Entities of this world.

terminateWorld

public void terminateWorld()

Terminate the world by removing all of its entities.

isTerminated

public boolean isTerminated()

Return the status of this world.

Returns:

Returns true if the world is terminated. | result == isTerminated

getEntityAtPosition

public Entity getEntityAtPosition(double x,
                                  double y)

Return the entity, if any, at the given x- and y-coordinate.

Parameters:

x - Given x-coordinate.

y - Given y-coordinate.

Returns:

Returns the entity positioned at the given coordinates. | givenPosition == entity.position

isValidEntity

public boolean isValidEntity(Entity entity)

Return true if the entity is valid for this world.

Parameters:

entity - The given entity to evaluate.

See Also:

implementation

evolve

public void evolve(double duration,
                   asteroids.part2.CollisionListener collisionListener)
            throws java.lang.IllegalArgumentException

Method to evolve the world during a given duration.

Throws:

java.lang.IllegalArgumentException

getTimeNextCollision

public double getTimeNextCollision()

Return the time until the next collision occurs in this world, if 2 entities overlap, return 0. If no collisions in return Double.POSITIVE_INFINITY.

See Also:

implementation

getNextCollisionPosition

public double[] getNextCollisionPosition()

Method that returns the position of the next collision.

Returns:

The position of the next collision. | if there is no collision, return Double.POSITIVE_INFINITY. | if (collidingEntities == null) return Double.POSITIVE_INFINITY | if there is a collision with a boundary, return the collision position | see implementation | if two entities collide, return the collision position. | see implementation

getNextCollidingEntities

public Entity[] getNextCollidingEntities()

Method that returns the entities involved in the next collision.

See Also:

implementation