Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: ImageSkybox

[21:7] extends: NodeSkybox

Wraps FXGL's ImageSkybox, a NodeSkybox subclass whose six faces are pre-loaded JavaFX Image nodes wrapped in ImageView. Use when the skybox is a fixed cubemap loaded from assets. ImageSkybox extends NodeSkybox in Java, so this wrapper extends the fxgl NodeSkybox wrapper and inherits its face-Group accessors. Construct directly with six Image wrappers, or through SkyboxBuilder.buildImageSkybox after setting the per-face image names.

Methods

  • ImageSkybox (int Size = 32, object Front = null, object Back = null, object Left = null, object Right = null, object Top = null, object Bot = null)

    Creates a new ImageSkybox with the given face size and six Image wrappers (one per face).

    • @p Size is the per-face size before the 32x scale factor.
    • @p Front is the front face Image wrapper.
    • @p Back is the back face Image wrapper.
    • @p Left is the left face Image wrapper.
    • @p Right is the right face Image wrapper.
    • @p Top is the top face Image wrapper.
    • @p Bot is the bottom face Image wrapper.
  • adopt (object Ajo)

    Wraps an existing ImageSkybox AussomJavaObject (typically one returned from SkyboxBuilder.buildImageSkybox).

    • @p Ajo is an AussomJavaObject around an ImageSkybox.
    • @r A new ImageSkybox wrapper.
  • getSize ()

    Returns the configured per-face size.

  • getFront ()

    Returns the front face Group AJO.

  • getBack ()

    Returns the back face Group AJO.

  • getLeft ()

    Returns the left face Group AJO.

  • getRight ()

    Returns the right face Group AJO.

  • getTop ()

    Returns the top face Group AJO.

  • getBot ()

    Returns the bottom face Group AJO.