com.almasb.fxgl.scene

Class FXGLScene

java.lang.Object

com.almasb.fxgl.scene.FXGLScene

Direct Known Subclasses:

FXGLMenu, GameScene

public abstract class FXGLScene
extends Object

Base class for all FXGL scenes.

Property Summary

Type	Property and Description
javafx.beans.property.BooleanProperty	active If a scene is active it is being shown by the display.

Constructor Summary

Constructors

Constructor and Description
FXGLScene()

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.BooleanProperty	activeProperty() If a scene is active it is being shown by the display.
void	appendCSS(CSS css)
void	bindSize(javafx.beans.property.DoubleProperty scaledWidth, javafx.beans.property.DoubleProperty scaledHeight, javafx.beans.property.DoubleProperty scaleRatioX, javafx.beans.property.DoubleProperty scaleRatioY)
void	clearCSS()
void	clearEffect() Removes any effects applied to the scene.
javafx.scene.layout.Pane	getContentRoot()
javafx.scene.effect.Effect	getEffect()
double	getHeight()
javafx.scene.layout.Pane	getRoot()
Viewport	getViewport()
double	getWidth()
void	setBackgroundColor(javafx.scene.paint.Paint color)
void	setBackgroundRepeat(javafx.scene.image.Image image) The image is repeated as often as needed to cover the background.
void	setBackgroundRepeat(String textureName) Convenience method to load the texture and repeat as often as needed to cover the background.
void	setCursor(String imageName, javafx.geometry.Point2D hotspot) Sets global game cursor using given name to find the image cursor within assets/ui/cursors/.
void	setEffect(javafx.scene.effect.Effect effect) Applies given effect to the scene.

Methods inherited from class java.lang.Object

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

Property Detail

active

public javafx.beans.property.BooleanProperty activeProperty

If a scene is active it is being shown by the display.

Constructor Detail

FXGLScene

public FXGLScene()

Method Detail

getRoot

public final javafx.scene.layout.Pane getRoot()

Returns:

top-level root node of the scene

getContentRoot

public final javafx.scene.layout.Pane getContentRoot()

Returns:

root node of the content

getViewport

public Viewport getViewport()

Returns:

viewport

getWidth

public final double getWidth()

Returns:

width

getHeight

public final double getHeight()

Returns:

height

setEffect

public final void setEffect(javafx.scene.effect.Effect effect)

Applies given effect to the scene.

Parameters:

effect - the effect to apply

getEffect

public final javafx.scene.effect.Effect getEffect()

Returns:

currently applied effect or null if no effect is applied

clearEffect

public final void clearEffect()

Removes any effects applied to the scene.

setCursor

public final void setCursor(String imageName,
                            javafx.geometry.Point2D hotspot)

Sets global game cursor using given name to find the image cursor within assets/ui/cursors/. Hotspot is location of the pointer end on the image.

Parameters:

imageName - name of image file

hotspot - hotspot location

activeProperty

public javafx.beans.property.BooleanProperty activeProperty()

If a scene is active it is being shown by the display.

appendCSS

public void appendCSS(CSS css)

clearCSS

public void clearCSS()

bindSize

public void bindSize(javafx.beans.property.DoubleProperty scaledWidth,
                     javafx.beans.property.DoubleProperty scaledHeight,
                     javafx.beans.property.DoubleProperty scaleRatioX,
                     javafx.beans.property.DoubleProperty scaleRatioY)

setBackgroundColor

public void setBackgroundColor(javafx.scene.paint.Paint color)

setBackgroundRepeat

public void setBackgroundRepeat(String textureName)

Convenience method to load the texture and repeat as often as needed to cover the background.

setBackgroundRepeat

public void setBackgroundRepeat(javafx.scene.image.Image image)

The image is repeated as often as needed to cover the background.