path: root/src/subconscious/graphics/Scene.java

package subconscious.graphics;

import subconscious.Game;

import subconscious.graphics.widget.Widget;
import subconscious.graphics.widget.Clickable;
import subconscious.graphics.widget.Dynamic;
import subconscious.graphics.widget.PerfView;

import java.util.ArrayList;
import java.util.Map;

import java.awt.Canvas;
import java.awt.Graphics2D;
import java.awt.Dimension;
import java.awt.BorderLayout;
import java.awt.Panel;
import java.awt.RenderingHints;

import java.awt.event.KeyListener;
import java.awt.event.KeyEvent;
import java.awt.event.MouseListener;
import java.awt.event.MouseMotionListener;
import java.awt.event.MouseEvent;
import java.awt.event.MouseWheelListener;
import java.awt.event.MouseWheelEvent;
import java.awt.event.ComponentListener;
import java.awt.event.ComponentEvent;

import java.awt.image.BufferStrategy;


/* Scene
 * Abstract model class for all scenes of the game. Each scene is in a different
 * thread and renders with a double buffered. As threads, scenes can be paused
 * from rendering.
 *
 * It is also responsable for all inputs, which are transferred to the Game 
 * object which controls the internal state of the game.
 */
@SuppressWarnings("serial")
public abstract class Scene extends Panel
	implements Runnable, KeyListener, MouseListener, MouseMotionListener, 
				MouseWheelListener, ComponentListener {

	// this is required to manage multiple scenes
	public final String UNIQUE_NAME;
	private static int absScenesCount = 0;

	protected final long DESIRED_FPS = 60;
	protected final long DESIRED_DELTA_LOOP = (1000*1000*1000)/DESIRED_FPS;
	protected final Map<RenderingHints.Key, ?> RENDERING_HINTS = Map.of(
		RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON,
		RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON,
		RenderingHints.KEY_ALPHA_INTERPOLATION, RenderingHints.VALUE_ALPHA_INTERPOLATION_SPEED,
		RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_NEAREST_NEIGHBOR,
		// RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BILINEAR,
		RenderingHints.KEY_RENDERING, RenderingHints.VALUE_RENDER_SPEED
	);

	protected ArrayList<Widget> widgets = new ArrayList<>();
	protected ArrayList<Widget> dynamicWidgetsCache = new ArrayList<>();
	// protected ArrayList<Widget> clickableWidgetsCache = new ArrayList<>();

	// Game is never cached in the local thread
	protected volatile Game game;

	// TODO: this could become a Queue of scenes to load
	protected Scene requestedScene = null;
	protected boolean requestedPrevScene = false;

	protected volatile boolean running = true;
	protected volatile boolean threadPaused = false;
	protected Object pauseLock = new Object();

	protected volatile Dimension canvasSize = GameWindow.WINDOW_SIZE;
	protected Canvas canvas = new Canvas();
	protected BufferStrategy buffer;

	// TODO: make accessible from user settings
	protected int guiSize = 2;

	public Scene(Game game, String label) {
		// generate unique name
		String uniqueName = this.getClass().getCanonicalName() + Integer.toString(Scene.absScenesCount);
		Scene.absScenesCount++;

		this.UNIQUE_NAME = uniqueName + " (" + label + ")";
		this.game = game;

		// watch for resize
		this.addComponentListener(this);

		// set up canvas
		this.canvas.setBounds(0, 0, this.canvasSize.width, this.canvasSize.height);
		this.canvas.setIgnoreRepaint(true);

		this.canvas.addKeyListener(this);
		this.canvas.addMouseListener(this);
		this.canvas.addMouseMotionListener(this);
		this.canvas.addMouseWheelListener(this);

		// TODO: solve canvas
		// this.add(this.canvas, BorderLayout.CENTER);
		this.build();

		// TODO: this will be controlled in the settings
		this.addWidget(new PerfView("default-perfview", 0, 0));
	}

	public Scene(Game game) {
		this(game, "");
	}

	/* */

	/* abstract methods */
	// runs when the the scene thread starts
	protected abstract void build();
	// runs on each tick
	protected abstract void update(long deltaNanoTime);
	protected abstract void render(Graphics2D g);

	protected void updateWidgets(long deltaNanoTime) {
		for (Widget w : this.dynamicWidgetsCache) {
			((Dynamic) w).update(deltaNanoTime);
		}
	}

	protected void renderWidgets(Graphics2D g) {
		for (Widget w : this.widgets) {
			Graphics2D widgetGraphics = (Graphics2D) g.create(
				w.getX(), w.getY(), w.getWidth(), w.getHeight()
			);

			w.render(widgetGraphics);
			widgetGraphics.dispose();
		}
	}

	/* widgets management */
	protected void addWidget(Widget widget) {
		this.widgets.add(widget);

		if (widget instanceof Dynamic) {
			this.dynamicWidgetsCache.add(widget);
		}
	}

	/* request scenes */
	protected synchronized void requestPrevScene() {
		this.requestedPrevScene = true;
	}

	protected synchronized boolean isRequestingPrevScene() {
		return this.requestedPrevScene;
	}

	protected synchronized void requestScene(Scene sc) {
		if (this.requestedScene != null)
			throw new UnsupportedOperationException("only one scene can be requested at once");

		this.requestedScene = sc;
	}

	// TODO: protected synchronized void requestScene(String uniqueName) {}

	public synchronized boolean isRequestingScene() {
		return this.requestedScene != null;
	}

	public synchronized Scene getRequestedScene() {
		Scene requested = this.requestedScene;
		this.requestedScene = null;

		return requested;
	}

	/* runnable implementation */
	public void run() {
		long beginLoopTime;
		long endLoopTime;
		long currentUpdateTime = System.nanoTime();
		long lastUpdateTime;
		long deltaLoop;
		long gameDeltaTime;

		this.running = true;
		this.threadPaused = false;

		// wait for the canvas to be ready
		// this is required otherwise createBufferStrategy()
		// throws an IllegalStateException
		while (!this.canvas.isDisplayable() && running);

		// initialize canvas buffer
		// the condition checks because the while above can be interrupted by
		// changing this.running
		// TODO: this is because of the MainMenuScene which hides the canvas
		//       when the scene will be fixed this if can be removed
		if (this.canvas.isDisplayable()) {
			this.canvas.createBufferStrategy(2);
			this.buffer = this.canvas.getBufferStrategy();
			this.canvas.requestFocus();	
		}

		while (running) {
			beginLoopTime = System.nanoTime();

			do {
				do {
					Graphics2D g = (Graphics2D) this.buffer.getDrawGraphics();
					g.addRenderingHints(this.RENDERING_HINTS);
					this.render(g);
					this.renderWidgets(g);
					g.dispose();
				// repeat if the rendering buffer contents were restored
				} while (this.buffer.contentsRestored() && running);
			// repeat if the drawing buffer contents were lost
			} while (this.buffer.contentsLost() && running);

			try {
				this.buffer.show();
			} catch (IllegalStateException ex) {
				// this happens when the scene is hidden or the frame is disposed
				// for example then the thread is stopped, and so this exception
				// can be ignored
			}

			lastUpdateTime = currentUpdateTime;
			currentUpdateTime = System.nanoTime();

			gameDeltaTime = currentUpdateTime - lastUpdateTime;

			// TODO: remove Scene.update?
			this.update(gameDeltaTime);
			this.updateWidgets(gameDeltaTime);
			this.game.update(gameDeltaTime);

			endLoopTime = System.nanoTime();
			deltaLoop = endLoopTime - beginLoopTime;

			if (deltaLoop > this.DESIRED_DELTA_LOOP) {
				// TODO: late => skip frame
			} else {
				try {
					Thread.sleep((this.DESIRED_DELTA_LOOP - deltaLoop)/(1000*1000));
				} catch (InterruptedException ex) {
					ex.printStackTrace();
				}
			}

			synchronized (this.pauseLock) {
				if (this.threadPaused) {
					try {
						this.pauseLock.wait();
					} catch (InterruptedException ex) {
						ex.printStackTrace();
					}
				}
			}
		}
	}

	/* game pause controls */
	public void stop() {
		// stop thread even if paused
		this.resumeThread();
		this.running = false;
	}

	public void pauseThread() {
		this.threadPaused = true;
	}

	public void resumeThread() {
		if (!this.threadPaused)
			return;

		this.threadPaused = false;

		synchronized (this.pauseLock) {
			this.pauseLock.notifyAll();
		}
	}


	// automagically set the canvas size to the parent's size
	// WARNING: does not always work
	// TODO: why doesn't this always work?
	public synchronized void updateCanvasSize() {
		this.updateCanvasSize(this.getParent().getSize());
	}

	// this one always works
	public synchronized void updateCanvasSize(Dimension newSize) {
		this.canvasSize = newSize;
	}

	/* key listener */
	@Override public void keyTyped(KeyEvent e) {}
	@Override public void keyPressed(KeyEvent e) {}
	@Override public void keyReleased(KeyEvent e) {}
	
	/* mouse listener */
	@Override
	public void mouseClicked(MouseEvent e) {
		// could be cached
		for (Widget w : this.widgets) {
			if (w instanceof Clickable) {
				((Clickable) w).mouseClick(e.getPoint());
			}
		}
	}

	@Override public void mouseEntered(MouseEvent e) {}
	@Override public void mouseExited(MouseEvent e) {}
	@Override public void mousePressed(MouseEvent e) {}
	@Override public void mouseReleased(MouseEvent e) {}
	@Override public void mouseDragged(MouseEvent e) {}
	@Override public void mouseMoved(MouseEvent e) {}
	@Override public void mouseWheelMoved(MouseWheelEvent e) {}

	/* component listener */
	@Override
	public void componentResized(ComponentEvent e) {
		this.updateCanvasSize();
	}

	@Override public void componentMoved(ComponentEvent e) {}
	@Override public void componentShown(ComponentEvent e) {}
	@Override public void componentHidden(ComponentEvent e) {}

}