PlayGround2D

java.lang.Object
- edu.utdallas.mavs.divas.visualization.vis2D.spectator.PlayGround2D

```
public class PlayGround2D
extends java.lang.Object
```
This class stores the current simulation status as received from the simulation.
The information stored in this class is the only information needed by the 2D visualizer to visualize the simulation.

Constructor Summary

Constructors
Constructor and Description

PlayGround2D()
Default Constructor for the playGround2D that initialize an empty lists and Maps to be used to store information later.

Constructors
Constructor and Description
`PlayGround2D()` Default Constructor for the playGround2D that initialize an empty lists and Maps to be used to store information later.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PlayGround2D`	`clone()`
`AgentState`	`findAgent(int agentID)` Find an agent in the playGround given the agent ID.
`EnvObjectState`	`findEnvObject(int envObjectID)` Find an environment object in the playGround given the environment object ID.
`ExplosionVO2D`	`findExplosion(int explosionID)` Find a explosion event in the playGround given an explosion event ID.
`FireworkVO2D`	`findFirework(int fireworkID)` Find a fireworks event in the playGround given an fireworks event ID.
`java.util.Map<java.lang.Integer,AgentState>`	`getAgents()` Gets the current map of agents in the playGround
`int`	`getAgentsCount(CellID cell)`
`CellMap`	`getCellMap()` Gets the current cellMap stored in the playGround
`java.util.Map<CellID,CellStateDto>`	`getCells()` Gets the current list of CEllBoundsVO in the playGround
`int`	`getEnvObjCount(CellID cell)`
`java.util.List<EnvObjectState>`	`getEnvObjects()` Gets the current list of environment object states in the playGround
`java.util.List<ExplosionVO2D>`	`getExplosions()` Gets the current explosion events in the simulation
`java.util.List<FireworkVO2D>`	`getFireworks()` Gets the current fireworks events in the simulation
`VirtualState`	`getSelectedObject(VirtualState state)` Return an agent or environment object that is selected with the picker
`void`	`removeAgent(AgentState agentState)` Removes the given agent state from the agent map in the PlayGround
`void`	`removeEnvObject(EnvObjectState o)` Removes the given environment object state from the list of environment objects in the playGround
`void`	`reset()` Reset the Playground by emptying all the list in the playGroound
`void`	`triggerEvent(java.util.List<EnvEvent> eventList)` Adds the list of events received from the simulation to the designated list of either the explosion or fireworks events, and assigning an age of 0 to each new event.
`void`	`updateAgent(AgentState agentState)` Update the agents map in the playGround by adding the new agent state to the Map or updating the the existing agent state.
`void`	`updateCell(CellStateDto cell)` Updates the current cellMap in the playGround with the given cellMap
`void`	`updateEnvObject(EnvObjectState o)` Updates the environment object states list in the playground by adding the new environment object state or updating the existing one.
`void`	`updateEvents()` Updates the explosion and fireworks events stored in the playGround by increasing the age of each of these events every cycle and delete the events that exceeds the age limits.

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

- Constructor Detail
  - PlayGround2D
```
public PlayGround2D()
```
    Default Constructor for the playGround2D that initialize an empty lists and Maps to be used to store information later.
- Method Detail
  - getExplosions
```
public java.util.List<ExplosionVO2D> getExplosions()
```
    Gets the current explosion events in the simulation
    
    Returns:
    
    List of explosions
  - getFireworks
```
public java.util.List<FireworkVO2D> getFireworks()
```
    Gets the current fireworks events in the simulation
    
    Returns:
    
    the Fireworks
  - findEnvObject
```
public EnvObjectState findEnvObject(int envObjectID)
```
    Find an environment object in the playGround given the environment object ID.
    
    Parameters:
    
    envObjectID - The environment object ID to be find.
    
    Returns:
    
    Environment object state for the given environment object ID.
  - findAgent
```
public AgentState findAgent(int agentID)
```
    Find an agent in the playGround given the agent ID.
    
    Parameters:
    
    agentID - The agent Id to be find.
    
    Returns:
    
    Agent state for the given agent ID.
  - findFirework
```
public FireworkVO2D findFirework(int fireworkID)
```
    Find a fireworks event in the playGround given an fireworks event ID.
    
    Parameters:
    
    fireworkID - The event ID for the fireworks to be find.
    
    Returns:
    
    FireworkVO2D for the given fireworks event id.
  - findExplosion
```
public ExplosionVO2D findExplosion(int explosionID)
```
    Find a explosion event in the playGround given an explosion event ID.
    
    Parameters:
    
    explosionID - The event ID for the explosion to be find.
    
    Returns:
    
    ExplosionVO2D for the given explosion event id.
  - updateEnvObject
```
public void updateEnvObject(EnvObjectState o)
```
    Updates the environment object states list in the playground by adding the new environment object state or updating the existing one.
    
    Parameters:
    
    o - Environment object state to be updated in the list
  - removeEnvObject
```
public void removeEnvObject(EnvObjectState o)
```
    Removes the given environment object state from the list of environment objects in the playGround
    
    Parameters:
    
    o - The environment object state to be removed
  - updateAgent
```
public void updateAgent(AgentState agentState)
```
    Update the agents map in the playGround by adding the new agent state to the Map or updating the the existing agent state.
    
    Parameters:
    
    agentState - Agent State to be updated
  - removeAgent
```
public void removeAgent(AgentState agentState)
```
    Removes the given agent state from the agent map in the PlayGround
    
    Parameters:
    
    agentState - Agent state to be removed from the map
  - triggerEvent
```
public void triggerEvent(java.util.List<EnvEvent> eventList)
```
    Adds the list of events received from the simulation to the designated list of either the explosion or fireworks events, and assigning an age of 0 to each new event.
    
    Parameters:
    
    eventList - List of event needs to be classified and added to the list of explosion or fireworks
  - reset
```
public void reset()
```
    Reset the Playground by emptying all the list in the playGroound
  - updateCell
```
public void updateCell(CellStateDto cell)
```
    Updates the current cellMap in the playGround with the given cellMap
    
    Parameters:
    
    cell - CellMap to be set in the playGround
  - getAgents
```
public java.util.Map<java.lang.Integer,AgentState> getAgents()
```
    Gets the current map of agents in the playGround
    
    Returns:
    
    Map of agent Id and agent state
  - getEnvObjects
```
public java.util.List<EnvObjectState> getEnvObjects()
```
    Gets the current list of environment object states in the playGround
    
    Returns:
    
    List of environment object states in the playGround
  - getCells
```
public java.util.Map<CellID,CellStateDto> getCells()
```
    Gets the current list of CEllBoundsVO in the playGround
    
    Returns:
    
    A list of CEllBoundsVo in the playGround
  - getCellMap
```
public CellMap getCellMap()
```
    Gets the current cellMap stored in the playGround
    
    Returns:
    
    The cellMap stored in the playGround
  - updateEvents
```
public void updateEvents()
```
    Updates the explosion and fireworks events stored in the playGround by increasing the age of each of these events every cycle and delete the events that exceeds the age limits.
  - getSelectedObject
```
public VirtualState getSelectedObject(VirtualState state)
```
    Return an agent or environment object that is selected with the picker
    
    Parameters:
    
    state - VirtualState that represent the picker
    
    Returns:
    
    Virtual State of any agent or environment object that picked with the picker
  - clone
```
public PlayGround2D clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - getAgentsCount
```
public int getAgentsCount(CellID cell)
```
  - getEnvObjCount
```
public int getEnvObjCount(CellID cell)
```

Class PlayGround2D

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PlayGround2D

Method Detail

getExplosions

getFireworks

findEnvObject

findAgent

findFirework

findExplosion

updateEnvObject

removeEnvObject

updateAgent

removeAgent

triggerEvent

reset

updateCell

getAgents

getEnvObjects

getCells

getCellMap

updateEvents

getSelectedObject

clone

getAgentsCount

getEnvObjCount