Package bytemusketeers.heslingtonhustle.ui

Class HeadsUpDisplay

java.lang.Object

bytemusketeers.heslingtonhustle.ui.Overlay

bytemusketeers.heslingtonhustle.ui.HeadsUpDisplay

All Implemented Interfaces:

MetricListener, Drawable, com.badlogic.gdx.utils.Disposable

class HeadsUpDisplay
extends Overlay
implements MetricListener

The HeadsUpDisplay displays persistent player and game information throughout the gameplay.

Author:

ENG1 Team 23 (Cohort 3)

Field Summary

Fields

Modifier and Type	Field	Description
private static com.badlogic.gdx.scenes.scene2d.ui.Label.LabelStyle	LABEL_STYLE	The Label.LabelStyle to use for all text; this is standard and shipped with LibGDX
private java.util.Map<MetricController.Metric,com.badlogic.gdx.scenes.scene2d.ui.Label>	metricLabels	A persistent mapping between MetricController.Metric elements and the Overlay-specific Label form elements

Fields inherited from class bytemusketeers.heslingtonhustle.ui.Overlay

GENERAL_FORM_PADDING

Constructor Summary

Constructors

Constructor	Description
HeadsUpDisplay(com.badlogic.gdx.graphics.g2d.SpriteBatch batch, MetricController.Metric[] leftMetrics, MetricController.Metric[] rightMetrics)	Creates a new HeadsUpDisplay relating to the given SpriteBatch

Method Summary

Modifier and Type	Method	Description
private void	addLabel(MetricController.Metric metric, com.badlogic.gdx.scenes.scene2d.ui.Table table)	Prepares and adds a name-value Label pair to the given Table, and ends the row
void	updateMetricText(MetricController.Metric metric, java.lang.String text)	Update the MetricController.Metric label with the given value

Methods inherited from class bytemusketeers.heslingtonhustle.ui.Overlay

addActor, dispose, render

Methods inherited from class java.lang.Object

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

Field Detail

metricLabels

private final java.util.Map<MetricController.Metric,com.badlogic.gdx.scenes.scene2d.ui.Label> metricLabels

A persistent mapping between MetricController.Metric elements and the Overlay-specific Label form elements

See Also:

MetricController

LABEL_STYLE

private static final com.badlogic.gdx.scenes.scene2d.ui.Label.LabelStyle LABEL_STYLE

The Label.LabelStyle to use for all text; this is standard and shipped with LibGDX

Constructor Detail

HeadsUpDisplay

HeadsUpDisplay(com.badlogic.gdx.graphics.g2d.SpriteBatch batch,
               MetricController.Metric[] leftMetrics,
               MetricController.Metric[] rightMetrics)

Creates a new HeadsUpDisplay relating to the given SpriteBatch

Parameters:

batch - The SpriteBatch to which the HeadsUpDisplay should be connected

leftMetrics - The MetricController.Metric elements to be displayed on the left-hand side

rightMetrics - The MetricController.Metric elements to be displayed on the right-hand side

Method Detail

updateMetricText

public void updateMetricText(MetricController.Metric metric,
                             java.lang.String text)

Update the MetricController.Metric label with the given value

Specified by:

updateMetricText in interface MetricListener

Parameters:

metric - The key of the MetricController.Metric to update

text - The new text

addLabel

private void addLabel(MetricController.Metric metric,
                      com.badlogic.gdx.scenes.scene2d.ui.Table table)

Prepares and adds a name-value Label pair to the given Table, and ends the row

Parameters:

metric - The MetricController.Metric associated with the Label