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.scene.canvas.GraphicsContext	getGraphicsContext() Returns graphics context of the game scene.
javafx.collections.ObservableList<javafx.scene.Node>	getUINodes()
void	onComponentAdded(Component component) Called after a component is added to an entity.
void	onComponentRemoved(Component component) Called before a component is removed from an entity.
void	onControlAdded(Control control) Called after control was added to an entity.
void	onControlRemoved(Control control) Called before control is removed from an entity.
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	onWorldReset() Called after the world has been reset.
void	onWorldUpdate(double tpf) Called after the world updated itself.
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.
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, 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

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)

Description copied from interface: EntityWorldListener

Called after the world updated itself.

Specified by:

onWorldUpdate in interface EntityWorldListener

Parameters:

tpf - time per frame

onWorldReset

public void onWorldReset()

Description copied from interface: EntityWorldListener

Called after the world has been reset.

Specified by:

onWorldReset in interface EntityWorldListener

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

onComponentAdded

public void onComponentAdded(Component component)

Description copied from interface: ComponentListener

Called after a component is added to an entity.

Specified by:

onComponentAdded in interface ComponentListener

Parameters:

component - the component

onComponentRemoved

public void onComponentRemoved(Component component)

Description copied from interface: ComponentListener

Called before a component is removed from an entity.

Specified by:

onComponentRemoved in interface ComponentListener

Parameters:

component - the component

onControlAdded

public void onControlAdded(Control control)

Description copied from interface: ControlListener

Called after control was added to an entity.

Specified by:

onControlAdded in interface ControlListener

Parameters:

control - the control that was added

onControlRemoved

public void onControlRemoved(Control control)

Description copied from interface: ControlListener

Called before control is removed from an entity.

Specified by:

onControlRemoved in interface ControlListener

Parameters:

control - the control to be removed