Entity

java.lang.Object
- asteroids.model.Entity

Direct Known Subclasses:

BlackHole, Bullet, MinorPlanet, Ship
```
public abstract class Entity
extends java.lang.Object
```
A class representing an Asteroid entity involving a position, a velocity, and a radius. Created by joachim on 09/04/2017.

Author:

joachim

Field Summary

Fields
Modifier and Type	Field and Description
`double`	`minRadiusBlackHole` Constant holding the minimum radius of a BlackHole.
`double`	`minRadiusBullet` Constant holding the minimum radius of a bullet.
`double`	`minRadiusMinorPlanet` Constant holding the minimum radius of a MinorPlanet.
`double`	`minRadiusShip` Constant holding the minimum radius of a ship.
`Vector`	`position`
`double`	`radius` VARIABLES ENTITY
`Vector`	`velocity`

Constructor Summary

Constructors
Constructor and Description
`Entity(double x, double y, double velocityX, double velocityY, double radius)` Initialize a new entity with x-position, y-position, velocity in x-direction, velocity in y-direction, radius.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bounceOffEntity(Entity other)` Resolve the bouncing of this entity with another given entity.
`abstract void`	`collide(Entity other)`
`void`	`collideWithBoundary()` Method executing the change in velocity in order to resolve a collision with a boundary.
`double[]`	`getCollisionPositionWithBoundary()` Method returning a pair of coordinates that represent the location of collision between an entity and a boundary.
`double`	`getDistanceBetween(Entity other)` Compute the distance between two entities.
`double`	`getDistanceBetweenCenters(Entity other)` Method getting returning the distance between the centers of two entitues
`double`	`getMass()` Return the mass of the entity.
`double`	`getMinRadius()` Return the minimun radius of the entity.
`double`	`getMinShipMass()` Get the minimum mass a ship must have.
`double[]`	`getMovementPrediction(double t)`
`Vector`	`getPosition()` POSITION RELATED
`double[]`	`getPositionCollisionWithEntity(Entity other)` Method returning the position of the collision between this and another entity
`double`	`getRadius()` Return the radius of this entity.
`static double`	`getSpeedOfLight()`
`double`	`getTimeCollisionWithEntity(Entity entity2)` Method returning the time until a collision happens between this entity and entity2
`double`	`getTimeCollisionWithShip(Ship ship2)` Method returning the time until a collision happens between this entity and ship2
`double`	`getTimeToCollisionWithBoundary()` Method returning the time until THE FIRST collision that happens between this entity and a boundary.
`double`	`getTotalVelocity()` Method computing the total velocity of this entity following the given formula.
`Vector`	`getVelocity()` Returning this entity's velocity
`World`	`getWorld()` Return this entities world.
`boolean`	`isInRange(Entity other)` Check whether entity is in range of another entity or not.
`boolean`	`isTerminated()` Return true if this entity's status (if it's already terminated or not)
`boolean`	`isValidRadius(double radius)` Return if the given radius is a valid radius for this entity.
`void`	`move(double duration)` Move the entity for a certain amount of time (duration).
`boolean`	`overlap(Entity other)` Check if two entities overlap.
`void`	`removeWorld()` Remove the world this entity is part of.
`void`	`setPosition(Vector positionXY)` Set the position of this entity to the given position.
`void`	`setRadius(double radius)`
`void`	`setVelocity(Vector velocity)` Set the velocity of this entity to the given velocity.
`void`	`setWorld(World world)` Set the world of this entity to the given world.
`void`	`terminate()` Terminate the entity.

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

- Field Detail
  - radius
```
public double radius
```
    VARIABLES ENTITY
  - position
```
public Vector position
```
  - velocity
```
public Vector velocity
```
  - minRadiusShip
```
public double minRadiusShip
```
    Constant holding the minimum radius of a ship.
  - minRadiusBullet
```
public double minRadiusBullet
```
    Constant holding the minimum radius of a bullet.
  - minRadiusMinorPlanet
```
public double minRadiusMinorPlanet
```
    Constant holding the minimum radius of a MinorPlanet.
  - minRadiusBlackHole
```
public double minRadiusBlackHole
```
    Constant holding the minimum radius of a BlackHole.
- Constructor Detail
  - Entity
```
public Entity(double x,
              double y,
              double velocityX,
              double velocityY,
              double radius)
       throws java.lang.IllegalArgumentException
```
    Initialize a new entity with x-position, y-position, velocity in x-direction, velocity in y-direction, radius.
    
    Parameters:
    
    x - The x-coordinate of this new entity.
    
    y - The y-coordinate of this new entity.
    
    velocityX - The velocity in the x-direction of this new entity.
    
    velocityY - The velocity in the y-direction of this new entity.
    
    radius - The radius of this new entity.
    
    Throws:
    
    java.lang.IllegalArgumentException
- Method Detail
  - getPosition
```
public Vector getPosition()
```
    POSITION RELATED
  - setPosition
```
public void setPosition(Vector positionXY)
                 throws java.lang.IllegalArgumentException
```
    Set the position of this entity to the given position.
    
    Parameters:
    
    positionXY - the given position as a vector
    
    Throws:
    
    java.lang.IllegalArgumentException - Throw exception is position is not valid.
  - getVelocity
```
public Vector getVelocity()
```
    Returning this entity's velocity
    
    Returns:
    
    Returns the velocity of this entity as a vector | result == velocity
  - setVelocity
```
public void setVelocity(Vector velocity)
```
    Set the velocity of this entity to the given velocity.
    
    Parameters:
    
    velocity - the given velocity as a vector.
  - getTotalVelocity
```
public double getTotalVelocity()
```
    Method computing the total velocity of this entity following the given formula.
  - getSpeedOfLight
```
public static double getSpeedOfLight()
```
  - getRadius
```
@Basic
 @Raw
public double getRadius()
```
    Return the radius of this entity.
    
    Returns:
    
    Return the radius for this entity. | result == radius
  - isValidRadius
```
public boolean isValidRadius(double radius)
```
    Return if the given radius is a valid radius for this entity.
    
    Parameters:
    
    radius - The given radius. // * @see implementation
  - setRadius
```
public void setRadius(double radius)
```
    Parameters:
    
    radius -
  - getMinRadius
```
public double getMinRadius()
```
    Return the minimun radius of the entity. //* @see implementation
  - move
```
public void move(double duration)
```
    Move the entity for a certain amount of time (duration). If the entity is a ship and the thruster of that ship is enabled, adjust the velocity of the ship after moving.0
    
    Parameters:
    
    duration - The amount of time to move.
    
    Throws:
    
    java.lang.IllegalArgumentException - The duration is less than zero.
  - getMass
```
public double getMass()
```
    Return the mass of the entity.
    
    Returns:
    
    Returns the calculated mass of the entity.
  - getMinShipMass
```
public double getMinShipMass()
```
    Get the minimum mass a ship must have. // * @see implementation
  - setWorld
```
public void setWorld(World world)
```
    Set the world of this entity to the given world.
    
    Parameters:
    
    world - The given world.
  - getWorld
```
public World getWorld()
```
    Return this entities world. Returns null if the entity isn't linked to a world.
    
    Returns:
    
    World linked with this entity | result == world
  - removeWorld
```
public void removeWorld()
```
    Remove the world this entity is part of.
  - terminate
```
public void terminate()
```
    Terminate the entity.
  - isTerminated
```
public boolean isTerminated()
```
    Return true if this entity's status (if it's already terminated or not)
    
    Returns:
    
    The status of the entity. | result == status
  - getTimeToCollisionWithBoundary
```
public double getTimeToCollisionWithBoundary()
```
    Method returning the time until THE FIRST collision that happens between this entity and a boundary.
    
    Returns:
    
    shall return Double.POSITIVE_INFINITY if the entity and boundary never collide. => default is Double.POSITIVE_INFINITY
  - getCollisionPositionWithBoundary
```
public double[] getCollisionPositionWithBoundary()
```
    Method returning a pair of coordinates that represent the location of collision between an entity and a boundary.
    
    Returns:
  - getMovementPrediction
```
public double[] getMovementPrediction(double t)
```
  - collideWithBoundary
```
public void collideWithBoundary()
```
    Method executing the change in velocity in order to resolve a collision with a boundary.
  - getTimeCollisionWithEntity
```
public double getTimeCollisionWithEntity(Entity entity2)
```
    Method returning the time until a collision happens between this entity and entity2
    
    Parameters:
    
    entity2 - the entity this entity is colliding with
    
    Returns:
    
    positive infinity | if product of the positionDifference and the velocityDifference is greater than or equal to zero | they thus will never collide
    
    Throws:
    
    java.lang.IllegalArgumentException - | if entity 2 == null | entity2 does not exist
  - getPositionCollisionWithEntity
```
public double[] getPositionCollisionWithEntity(Entity other)
```
    Method returning the position of the collision between this and another entity
    
    Parameters:
    
    other - the entity this entity is colliding with
    
    Returns:
    
    null | if the time till collision is positive infinity there will be no collision (see method getTimeCollisionWithEntity ) | if (time == Double.POSITIVE_INFINITY) return null;
  - getTimeCollisionWithShip
```
public double getTimeCollisionWithShip(Ship ship2)
```
    Method returning the time until a collision happens between this entity and ship2
    
    Parameters:
    
    ship2 - the entity this entity is colliding with
    
    Returns:
    
    positive infinity | if product of the positionDifference and the velocityDifference is greater than or equal to zero | they thus will never collide
    
    Throws:
    
    java.lang.IllegalArgumentException - | if ship2 == null | ship2 does not exist
  - overlap
```
public boolean overlap(Entity other)
```
    Check if two entities overlap.
    
    Parameters:
    
    other - | Second entity
    
    Returns:
    
    | True if the entities overlap
  - getDistanceBetween
```
public double getDistanceBetween(Entity other)
```
    Compute the distance between two entities. If the two compared entities are the same, distance is 0.
    
    Parameters:
    
    other - | Second entity//TODO
    
    Returns:
    
    The distance between this entity and the given other entity. | return (Math.sqrt(Math.pow((x1 - x2), 2) + Math.pow((y1 - y2), 2)));
  - getDistanceBetweenCenters
```
public double getDistanceBetweenCenters(Entity other)
```
    Method getting returning the distance between the centers of two entitues
    
    Parameters:
    
    other - | second entity
    
    Returns:
    
    The distance between the center of this entity and the center of the given other entity. | Math.sqrt(Math.pow((other.getPositionX() - this.getPositionX()), 2) + Math.pow((other.getPositionY() - this.getPositionY()),2))
  - bounceOffEntity
```
public void bounceOffEntity(Entity other)
```
    Resolve the bouncing of this entity with another given entity.
    
    Parameters:
    
    other - The other entity.
  - collide
```
public abstract void collide(Entity other)
```
  - isInRange
```
public boolean isInRange(Entity other)
```
    Check whether entity is in range of another entity or not.
    
    Parameters:
    
    other - The other entity. // * @see implementation

Class Entity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

radius

position

velocity

minRadiusShip

minRadiusBullet

minRadiusMinorPlanet

minRadiusBlackHole

Constructor Detail

Entity

Method Detail

getPosition

setPosition

getVelocity

setVelocity

getTotalVelocity

getSpeedOfLight

getRadius

isValidRadius

setRadius

getMinRadius

move

getMass

getMinShipMass

setWorld

getWorld

removeWorld

terminate

isTerminated

getTimeToCollisionWithBoundary

getCollisionPositionWithBoundary

getMovementPrediction

collideWithBoundary

getTimeCollisionWithEntity

getPositionCollisionWithEntity

getTimeCollisionWithShip

overlap

getDistanceBetween

getDistanceBetweenCenters

bounceOffEntity

collide

isInRange