OverlayFactory

java.lang.Object
- bytemusketeers.heslingtonhustle.ui.OverlayFactory

```
public final class OverlayFactory
extends java.lang.Object
```
The OverlayFactory constructs types of Overlay objects given with a persistent SpriteBatch

Author:

ENG1 Team 23 (Cohort 3)

Field Summary

Fields
Modifier and Type Field Description

private com.badlogic.gdx.graphics.g2d.SpriteBatch batch
The SpriteBatch with which Overlay instances should be constructed

Constructor Summary

Constructors
Constructor Description

OverlayFactory(com.badlogic.gdx.graphics.g2d.SpriteBatch batch)
Constructs a new Overlay with the given SpriteBatch

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Overlay`	`createGameOverMenu()`	Creates a blank `GameOverMenu` with the `batch`
`Overlay`	`createHUD(MetricController.Metric[] leftMetrics, MetricController.Metric[] rightMetrics)`	Creates a heads-up display with the given left and right metric labels
`Overlay`	`createPauseMenu()`	Creates a blank `PauseMenu` with the `batch`

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

- Field Detail
  - batch
```
private final com.badlogic.gdx.graphics.g2d.SpriteBatch batch
```
    The SpriteBatch with which Overlay instances should be constructed
- Constructor Detail
  - OverlayFactory
```
public OverlayFactory(com.badlogic.gdx.graphics.g2d.SpriteBatch batch)
```
    Constructs a new Overlay with the given SpriteBatch
    
    Parameters:
    
    batch - The SpriteBatch with which Overlay instances should be bound
- Method Detail
  - createGameOverMenu
```
public Overlay createGameOverMenu()
```
    Creates a blank GameOverMenu with the batch
    
    Returns:
    
    A new GameOverMenu
    
    See Also:
    
    GameOverMenu
  - createPauseMenu
```
public Overlay createPauseMenu()
```
    Creates a blank PauseMenu with the batch
    
    Returns:
    
    A new PauseMenu
    
    See Also:
    
    PauseMenu
  - createHUD
```
public Overlay createHUD(MetricController.Metric[] leftMetrics,
                         MetricController.Metric[] rightMetrics)
```
    Creates a heads-up display with the given left and right metric labels
    
    Parameters:
    
    leftMetrics - Metrics to display on the LHS of the HUD
    
    rightMetrics - Metrics to display on the RHS of the HUD
    
    Returns:
    
    A new HeadsUpDisplay, prepared to display the given MetricController.Metric items
    
    See Also:
    
    HeadsUpDisplay