class: SkyboxBuilder

[13:7] extends: FxObj

Wraps FXGL's SkyboxBuilder, the fluent builder for a 6-sided skybox (cubemap). Set each face by image asset name or pre- loaded JavaFX Image, then call buildImageSkybox or buildCanvasSkybox to produce the rendered skybox.

Methods

SkyboxBuilder (int Size = 1024)

Creates a new SkyboxBuilder with the given face-image size (each face is Size x Size).
- @p Size is the side length in pixels.
front (string ImageName)

Sets the front face from an image asset name.
- @p ImageName is the asset path.
- @r this object
back (string ImageName)

Sets the back face from an image asset name.
- @p ImageName is the asset path.
- @r this object
left (string ImageName)

Sets the left face from an image asset name.
- @p ImageName is the asset path.
- @r this object
right (string ImageName)

Sets the right face from an image asset name.
- @p ImageName is the asset path.
- @r this object
top (string ImageName)

Sets the top face from an image asset name.
- @p ImageName is the asset path.
- @r this object
bot (string ImageName)

Sets the bottom face from an image asset name.
- @p ImageName is the asset path.
- @r this object
buildImageSkybox ()

Builds the image-based skybox.
- @r An AussomJavaObject around an ImageSkybox.
buildCanvasSkybox ()

Builds the canvas-based skybox.
- @r An AussomJavaObject around a CanvasSkybox.
getSize ()

Returns the configured face-image size.
frontImage (object ImageObj)

Sets the front face from a pre-loaded JavaFX Image.
- @p ImageObj is a fx.Image wrapper.
- @r this object
backImage (object ImageObj)

Sets the back face from an Image wrapper.
leftImage (object ImageObj)

Sets the left face from an Image wrapper.
rightImage (object ImageObj)

Sets the right face from an Image wrapper.
topImage (object ImageObj)

Sets the top face from an Image wrapper.
botImage (object ImageObj)

Sets the bottom face from an Image wrapper.