com.almasb.fxgl.scene

Class GameScene

java.lang.Object

com.almasb.fxgl.scene.FXGLScene

com.almasb.fxgl.scene.GameScene

All Implemented Interfaces:

EntityWorldListener, ModuleListener

public final class GameScene
extends FXGLScene
implements EntityWorldListener, ModuleListener

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 (game view)
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)
void	addGameView(EntityView view, RenderLayer layer) 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.
void	clear()
void	clearGameViews() Removes all nodes from the game view layer.
void	clearUINodes() Removes all nodes from the UI overlay.
javafx.scene.canvas.GraphicsContext	getGraphicsContext() Returns graphics context of the game scene.
javafx.scene.text.Text	getProfilerText()
javafx.collections.ObservableList<javafx.scene.Node>	getUINodes()
void	onAdded(Control control)
void	onEntityAdded(Entity entity) Called after entity was added to the world.
void	onEntityRemoved(Entity entity) Called after entity was removed from the world but before entity has been cleaned.
void	onRemoved(Control control)
void	onUpdate(double tpf)
void	removeGameView(EntityView view, RenderLayer layer) 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.
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, appendCSS, bindSize, clearCSS, clearEffect, getContentRoot, getEffect, getHeight, getRoot, getViewport, getWidth, setBackgroundColor, setBackgroundRepeat, setBackgroundRepeat, setCursor, setEffect

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.almasb.fxgl.entity.ModuleListener

onAdded, onRemoved

Constructor Detail

GameScene

protected GameScene(int width,
                    int height)

Method Detail

getProfilerText

public javafx.scene.text.Text getProfilerText()

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,
                        RenderLayer layer)

Add a view to the game root.

Parameters:

view - view to add

addGameView

public void addGameView(EntityView view)

removeGameView

public void removeGameView(EntityView view,
                           RenderLayer layer)

Remove a view from the game root.

Parameters:

view - view to remove

clearGameViews

public void clearGameViews()

Removes all nodes from the game view layer.

clearUINodes

public void clearUINodes()

Removes all nodes from the UI overlay.

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

onUpdate

public void onUpdate(double tpf)

clear

public void clear()

onEntityAdded

public void onEntityAdded(Entity entity)

Description copied from interface: EntityWorldListener

Called after entity was added to the world.

Specified by:

onEntityAdded in interface EntityWorldListener

Parameters:

entity - the entity

onEntityRemoved

public void onEntityRemoved(Entity entity)

Description copied from interface: EntityWorldListener

Called after entity was removed from the world but before entity has been cleaned. This allows other parties to free resources before doing final entity clean.

Specified by:

onEntityRemoved in interface EntityWorldListener

Parameters:

entity - the entity

onAdded

public void onAdded(Control control)

Specified by:

onAdded in interface ModuleListener

onRemoved

public void onRemoved(Control control)

Specified by:

onRemoved in interface ModuleListener