com.almasb.fxgl.scene

Class GameScene

java.lang.Object

com.almasb.fxgl.scene.FXGLScene

com.almasb.fxgl.scene.GameScene

All Implemented Interfaces:

ComponentListener, ControlListener, EntityWorldListener

public final class GameScene
extends FXGLScene
implements EntityWorldListener, ComponentListener, ControlListener

Represents the scene that shows game objects on the screen during "play" mode. Contains 3 layers. From bottom to top:

1. Entities and their render layers
2. Particles
3. UI Overlay

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Property Summary

Properties inherited from class com.almasb.fxgl.scene.FXGLScene

activeProperty

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GameScene(int width, int height)

Method Summary

Modifier and Type	Method and Description
void	addGameView(EntityView view) Add a view to the game root.
void	addUI(UI ui)
void	addUINode(javafx.scene.Node node) Add a node to the UI overlay.
void	addUINodes(javafx.scene.Node... nodes) Add nodes to the UI overlay.
javafx.geometry.Point2D	gameToScreen(javafx.geometry.Point2D gamePoint) Converts a point in game world to a point within screen (viewport).
javafx.scene.canvas.GraphicsContext	getGraphicsContext() Returns graphics context of the game scene.
javafx.collections.ObservableList<javafx.scene.Node>	getUINodes()
Viewport	getViewport()
void	onComponentAdded(Component component)
void	onComponentRemoved(Component component)
void	onControlAdded(Control control)
void	onControlRemoved(Control control)
void	onEntityAdded(Entity entity)
void	onEntityRemoved(Entity entity)
void	onWorldReset()
void	onWorldUpdate(double tpf)
void	removeGameView(EntityView view) Remove a view from the game root.
void	removeUI(UI ui)
boolean	removeUINode(javafx.scene.Node n) Remove given node from the UI overlay.
void	removeUINodes(javafx.scene.Node... nodes) Remove nodes from the UI overlay.
javafx.geometry.Point2D	screenToGame(javafx.geometry.Point2D screenPoint) Converts a point on screen to a point within game scene.
void	setUIMouseTransparent(boolean b) Set true if UI elements should forward mouse events to the game layer.

Methods inherited from class com.almasb.fxgl.scene.FXGLScene

activeProperty, addEventHandler, appendCSS, bindSize, clearCSS, clearEffect, fireEvent, getContentRoot, getEffect, getHeight, getRoot, getWidth, removeEventHandler, setCursor, setEffect

Methods inherited from class java.lang.Object

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

Constructor Detail

GameScene

@Inject
protected GameScene(int width,
                             int height)

Method Detail

getViewport

public Viewport getViewport()

Returns:

viewport

screenToGame

public javafx.geometry.Point2D screenToGame(javafx.geometry.Point2D screenPoint)

Converts a point on screen to a point within game scene.

Parameters:

screenPoint - point in UI coordinates

Returns:

point in game coordinates

gameToScreen

public javafx.geometry.Point2D gameToScreen(javafx.geometry.Point2D gamePoint)

Converts a point in game world to a point within screen (viewport).

Parameters:

gamePoint - point in game world coordinates

Returns:

point in UI coordinates

getUINodes

public javafx.collections.ObservableList<javafx.scene.Node> getUINodes()

Returns:

unmodifiable list of UI nodes

addUINode

public void addUINode(javafx.scene.Node node)

Add a node to the UI overlay.

Parameters:

node - UI node to add

addUINodes

public void addUINodes(javafx.scene.Node... nodes)

Add nodes to the UI overlay.

Parameters:

nodes - UI nodes to add

removeUINode

public boolean removeUINode(javafx.scene.Node n)

Remove given node from the UI overlay.

Parameters:

n - node to remove

Returns:

true iff the node has been removed

removeUINodes

public void removeUINodes(javafx.scene.Node... nodes)

Remove nodes from the UI overlay.

Parameters:

nodes - nodes to remove

addUI

public void addUI(UI ui)

removeUI

public void removeUI(UI ui)

addGameView

public void addGameView(EntityView view)

Add a view to the game root.

Parameters:

view - view to add

removeGameView

public void removeGameView(EntityView view)

Remove a view from the game root.

Parameters:

view - view to remove

setUIMouseTransparent

public void setUIMouseTransparent(boolean b)

Set true if UI elements should forward mouse events to the game layer.

Parameters:

b - flag

Default Value:

false

getGraphicsContext

public javafx.scene.canvas.GraphicsContext getGraphicsContext()

Returns graphics context of the game scene. The render layer is over all entities. Use this only if performance is required. The drawing on this context can be done in GameApplication.onUpdate(double).

Returns:

graphics context

onWorldUpdate

public void onWorldUpdate(double tpf)

Specified by:

onWorldUpdate in interface EntityWorldListener

onWorldReset

public void onWorldReset()

Specified by:

onWorldReset in interface EntityWorldListener

onEntityAdded

public void onEntityAdded(Entity entity)

Specified by:

onEntityAdded in interface EntityWorldListener

onEntityRemoved

public void onEntityRemoved(Entity entity)

Specified by:

onEntityRemoved in interface EntityWorldListener

onComponentAdded

public void onComponentAdded(Component component)

Specified by:

onComponentAdded in interface ComponentListener

onComponentRemoved

public void onComponentRemoved(Component component)

Specified by:

onComponentRemoved in interface ComponentListener

onControlAdded

public void onControlAdded(Control control)

Specified by:

onControlAdded in interface ControlListener

onControlRemoved

public void onControlRemoved(Control control)

Specified by:

onControlRemoved in interface ControlListener