AbstractApplication (org.dayflower.pathtracer API)

java.lang.Object
- javafx.application.Application
- - org.dayflower.pathtracer.application.AbstractApplication

Direct Known Subclasses:

DayflowerApplication
```
public abstract class AbstractApplication
extends javafx.application.Application
```
An extension of Application that adds a bunch of functionality such as scaling and cursor visibility.

Since:

1.0.0

Author:

Jörgen Lundgren

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractApplication.Setting
A Setting represents a setting that can be enabled or disabled.
- Nested classes/interfaces inherited from class javafx.application.Application
  javafx.application.Application.Parameters

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractApplication.Setting` A `Setting` represents a setting that can be enabled or disabled.

Field Summary
- Fields inherited from class javafx.application.Application
  STYLESHEET_CASPIAN, STYLESHEET_MODENA

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractApplication()
Constructs a new AbstractApplication with no title.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractApplication()` Constructs a new `AbstractApplication` with no title.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`configureMenuBar(javafx.scene.control.MenuBar menuBar)` Called when the `MenuBar` can be configured.
`protected abstract void`	`configurePixels(byte[] pixels)` Called when pixels can be configured at start.
`protected abstract void`	`configureStage(javafx.stage.Stage stage)` Called when the primary `Stage` can be configured.
`protected abstract void`	`configureStatusBar(javafx.scene.layout.HBox hBox)` Called when the status bar can be configured.
`protected abstract void`	`configureTabPane(javafx.scene.control.TabPane tabPane)` Called when the `TabPane` can be configured.
`protected void`	`enter()` Enters the FPS-game mode.
`protected void`	`exit()` Call this method when it's time to exit.
`protected int`	`getCanvasHeight()` Returns the canvas height.
`protected int`	`getCanvasWidth()` Returns the canvas width.
`protected FPSCounter`	`getFPSCounter()` Returns the `FPSCounter` associated with this `AbstractApplication`.
`protected int`	`getKernelHeight()` Returns the kernel height.
`protected int`	`getKernelWidth()` Returns the kernel width.
`protected int`	`getMouseX()` Returns the X-coordinate of the mouse.
`protected int`	`getMouseY()` Returns the Y-coordinate of the mouse.
`protected boolean`	`hasEntered()` Returns `true` if, and only if, this `AbstractApplication` has been entered like an FPS-game, `false` otherwise.
`protected boolean`	`hasRequestedToExit()` Returns `true` if, and only if, exit has been requested, `false` otherwise.
`protected boolean`	`isCursorHidden()` Returns `true` if, and only if, the cursor is hidden, `false` otherwise.
`protected boolean`	`isKeyPressed()` Returns `true` if, and only if, at least one key is being pressed, `false` otherwise.
`protected boolean`	`isKeyPressed(javafx.scene.input.KeyCode keyCode)` Returns `true` if, and only if, the key denoted by `keyCode` is being pressed, `false` otherwise.
`protected boolean`	`isKeyPressed(javafx.scene.input.KeyCode keyCode, boolean isKeyPressedOnce)` Returns `true` if, and only if, the key denoted by `keyCode` is being pressed, `false` otherwise.
`protected boolean`	`isMouseDragging()` Returns `true` if, and only if, the mouse is being dragged, `false` otherwise.
`protected boolean`	`isMouseMoving()` Returns `true` if, and only if, the mouse is being moved, `false` otherwise.
`protected boolean`	`isMouseRecentering()` Returns `true` if, and only if, mouse re-centering is being performed, `false` otherwise.
`protected void`	`leave()` Leaves the FPS-game mode.
`protected abstract void`	`onExit()` Called before this `AbstractApplication` is finally exiting.
`protected abstract void`	`onMouseDragged(float x, float y)` Called when the mouse is dragged.
`protected abstract void`	`onMouseMoved(float x, float y)` Called when the mouse is moved.
`protected abstract void`	`render()` Called when rendering.
`protected void`	`setCanvasHeight(int canvasHeight)` Sets a new canvas height.
`protected void`	`setCanvasWidth(int canvasWidth)` Sets a new canvas width.
`protected void`	`setCursorHidden(boolean isCursorHidden)` Sets whether the cursor should be hidden or shown.
`protected void`	`setKernelHeight(int kernelHeight)` Sets a new kernel height.
`protected void`	`setKernelWidth(int kernelWidth)` Sets a new kernel width.
`protected void`	`setMouseRecentering(boolean isMouseRecentering)` Sets the mouse re-centering.
`void`	`start(javafx.stage.Stage stage)` Starts this `AbstractApplication` instance.
`protected abstract void`	`update()` Called when updating.

Methods inherited from class javafx.application.Application
getHostServices, getParameters, getUserAgentStylesheet, init, launch, launch, notifyPreloader, setUserAgentStylesheet, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractApplication
```
protected AbstractApplication()
```
    Constructs a new AbstractApplication with no title.
- Method Detail
  - start
```
public final void start(javafx.stage.Stage stage)
```
    Starts this AbstractApplication instance.
    
    Specified by:
    
    start in class javafx.application.Application
    
    Parameters:
    
    stage - a Stage
  - getFPSCounter
```
protected final FPSCounter getFPSCounter()
```
    Returns the FPSCounter associated with this AbstractApplication.
    
    Returns:
    
    the FPSCounter associated with this AbstractApplication
  - hasEntered
```
protected final boolean hasEntered()
```
    Returns true if, and only if, this AbstractApplication has been entered like an FPS-game, false otherwise.
    To enter this AbstractApplication like an FPS-game, call enter().
    If it has been entered like an FPS-game and you want to leave, call leave().
    When it's been entered like an FPS-game, the cursor will be hidden and the mouse will be re-centering.
    
    Returns:
    
    true if, and only if, this AbstractApplication has been entered like an FPS-game, false otherwise
  - hasRequestedToExit
```
protected final boolean hasRequestedToExit()
```
    Returns true if, and only if, exit has been requested, false otherwise.
    To request this AbstractApplication to exit, call exit().
    
    Returns:
    
    true if, and only if, exit has been requested, false otherwise
  - isCursorHidden
```
protected final boolean isCursorHidden()
```
    Returns true if, and only if, the cursor is hidden, false otherwise.
    
    Returns:
    
    true if, and only if, the cursor is hidden, false otherwise
  - isKeyPressed
```
protected final boolean isKeyPressed()
```
    Returns true if, and only if, at least one key is being pressed, false otherwise.
    
    Returns:
    
    true if, and only if, at least one key is being pressed, false otherwise
  - isKeyPressed
```
protected final boolean isKeyPressed(javafx.scene.input.KeyCode keyCode)
```
    Returns true if, and only if, the key denoted by keyCode is being pressed, false otherwise.
    Calling this method is equivalent to calling isKeyPressed(keyCode, false).
    If keyCode is null, a NullPointerException will be thrown.
    
    Parameters:
    
    keyCode - a KeyCode
    
    Returns:
    
    true if, and only if, the key denoted by keyCode is being pressed, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, keyCode is null
  - isKeyPressed
```
protected final boolean isKeyPressed(javafx.scene.input.KeyCode keyCode,
                                     boolean isKeyPressedOnce)
```
    Returns true if, and only if, the key denoted by keyCode is being pressed, false otherwise.
    If isKeyPressedOnce is true, only the first call to this method will return true per press-release cycle given a specific key.
    If keyCode is null, a NullPointerException will be thrown.
    
    Parameters:
    
    keyCode - a KeyCode
    
    isKeyPressedOnce - true if, and only if, a key press should occur at most one time per press-release cycle, false otherwise
    
    Returns:
    
    true if, and only if, the key denoted by keyCode is being pressed, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, keyCode is null
  - isMouseDragging
```
protected final boolean isMouseDragging()
```
    Returns true if, and only if, the mouse is being dragged, false otherwise.
    
    Returns:
    
    true if, and only if, the mouse is being dragged, false otherwise
  - isMouseMoving
```
protected final boolean isMouseMoving()
```
    Returns true if, and only if, the mouse is being moved, false otherwise.
    
    Returns:
    
    true if, and only if, the mouse is being moved, false otherwise
  - isMouseRecentering
```
protected final boolean isMouseRecentering()
```
    Returns true if, and only if, mouse re-centering is being performed, false otherwise.
    
    Returns:
    
    true if, and only if, mouse re-centering is being performed, false otherwise
  - getCanvasHeight
```
protected final int getCanvasHeight()
```
    Returns the canvas height.
    
    Returns:
    
    the canvas height
  - getCanvasWidth
```
protected final int getCanvasWidth()
```
    Returns the canvas width.
    
    Returns:
    
    the canvas width
  - getKernelHeight
```
protected final int getKernelHeight()
```
    Returns the kernel height.
    
    Returns:
    
    the kernel height
  - getKernelWidth
```
protected final int getKernelWidth()
```
    Returns the kernel width.
    
    Returns:
    
    the kernel width
  - getMouseX
```
protected final int getMouseX()
```
    Returns the X-coordinate of the mouse.
    
    Returns:
    
    the X-coordinate of the mouse
  - getMouseY
```
protected final int getMouseY()
```
    Returns the Y-coordinate of the mouse.
    
    Returns:
    
    the Y-coordinate of the mouse
  - configureMenuBar
```
protected abstract void configureMenuBar(javafx.scene.control.MenuBar menuBar)
```
    Called when the MenuBar can be configured.
    
    Parameters:
    
    menuBar - the MenuBar to configure
  - configurePixels
```
protected abstract void configurePixels(byte[] pixels)
```
    Called when pixels can be configured at start.
    
    Parameters:
    
    pixels - a byte array with pixel data
  - configureStage
```
protected abstract void configureStage(javafx.stage.Stage stage)
```
    Called when the primary Stage can be configured.
    
    Parameters:
    
    stage - the primary Stage to configure
  - configureStatusBar
```
protected abstract void configureStatusBar(javafx.scene.layout.HBox hBox)
```
    Called when the status bar can be configured.
    
    Parameters:
    
    hBox - a HBox that acts as a status bar
  - configureTabPane
```
protected abstract void configureTabPane(javafx.scene.control.TabPane tabPane)
```
    Called when the TabPane can be configured.
    
    Parameters:
    
    tabPane - the TabPane to configure
  - exit
```
protected final void exit()
```
    Call this method when it's time to exit.
    When this AbstractApplication is exiting, it will call onExit() before finally exiting.
    If this AbstractApplication has been entered like an FPS-game, it will leave this state instead of exiting. In this case you'll have to call this method twice in order to exit.
  - enter
```
protected final void enter()
```
    Enters the FPS-game mode.
    If you want to leave this FPS-game mode, call leave().
  - leave
```
protected final void leave()
```
    Leaves the FPS-game mode.
    If you want to enter this FPS-game mode, call enter().
  - onExit
```
protected abstract void onExit()
```
    Called before this AbstractApplication is finally exiting.
  - onMouseDragged
```
protected abstract void onMouseDragged(float x,
                                       float y)
```
    Called when the mouse is dragged.
    
    Parameters:
    
    x - the new X-coordinate
    
    y - the new Y-coordinate
  - onMouseMoved
```
protected abstract void onMouseMoved(float x,
                                     float y)
```
    Called when the mouse is moved.
    
    Parameters:
    
    x - the new X-coordinate
    
    y - the new Y-coordinate
  - render
```
protected abstract void render()
```
    Called when rendering.
  - setCanvasHeight
```
protected final void setCanvasHeight(int canvasHeight)
```
    Sets a new canvas height.
    
    Parameters:
    
    canvasHeight - a new canvas height
  - setCanvasWidth
```
protected final void setCanvasWidth(int canvasWidth)
```
    Sets a new canvas width.
    
    Parameters:
    
    canvasWidth - a new canvas width
  - setCursorHidden
```
protected final void setCursorHidden(boolean isCursorHidden)
```
    Sets whether the cursor should be hidden or shown.
    
    Parameters:
    
    isCursorHidden - true if, and only if, the cursor should be hidden, false otherwise
  - setKernelHeight
```
protected final void setKernelHeight(int kernelHeight)
```
    Sets a new kernel height.
    
    Parameters:
    
    kernelHeight - a new kernel height
  - setKernelWidth
```
protected final void setKernelWidth(int kernelWidth)
```
    Sets a new kernel width.
    
    Parameters:
    
    kernelWidth - a new kernel width
  - setMouseRecentering
```
protected final void setMouseRecentering(boolean isMouseRecentering)
```
    Sets the mouse re-centering.
    
    Parameters:
    
    isMouseRecentering - true if, and only if, mouse re-centering should be performed, false otherwise
  - update
```
protected abstract void update()
```
    Called when updating.

Class AbstractApplication

Nested Class Summary

Nested classes/interfaces inherited from class javafx.application.Application

Field Summary

Fields inherited from class javafx.application.Application

Constructor Summary

Method Summary

Methods inherited from class javafx.application.Application

Methods inherited from class java.lang.Object

Constructor Detail

AbstractApplication

Method Detail

start

getFPSCounter

hasEntered

hasRequestedToExit

isCursorHidden

isKeyPressed

isKeyPressed

isKeyPressed

isMouseDragging

isMouseMoving

isMouseRecentering

getCanvasHeight

getCanvasWidth

getKernelHeight

getKernelWidth

getMouseX

getMouseY

configureMenuBar

configurePixels

configureStage

configureStatusBar

configureTabPane

exit

enter

leave

onExit

onMouseDragged

onMouseMoved

render

setCanvasHeight

setCanvasWidth

setCursorHidden

setKernelHeight

setKernelWidth

setMouseRecentering

update