Module technology.sola.engine

Package technology.sola.engine.graphics

Class SolaGraphics.Builder

java.lang.Object

technology.sola.engine.graphics.SolaGraphics.Builder

Enclosing class:

SolaGraphics

public static class SolaGraphics.Builder
extends Object

Builder for SolaGraphics.

Constructor Summary

Constructors

Constructor	Description
Builder(SolaPlatform platform, technology.sola.ecs.SolaEcs solaEcs)	Creates a new SolaGraphics.Builder instance.

Method Summary

Modifier and Type	Method	Description
SolaGraphics	buildAndInitialize(AssetLoaderProvider assetLoaderProvider)	Builds and initializes the SolaGraphics instance.
SolaGraphics.Builder	withBackgroundColor(Color backgroundColor)	Sets the background Color cleared to each frame.
SolaGraphics.Builder	withDebug(@Nullable SolaPhysics solaPhysics, EventHub eventHub, KeyboardInput keyboardInput)	Enables debug rendering.
SolaGraphics.Builder	withGui(MouseInput mouseInput)	Sets the builder to add a GuiDocument and related systems.
SolaGraphics.Builder	withGui(MouseInput mouseInput, GuiTheme guiTheme)	Sets the builder to add a GuiDocument and related systems.
SolaGraphics.Builder	withGui(MouseInput mouseInput, GuiTheme guiTheme, List<GuiElementJsonBlueprint<?,?,?>> additionalGuiElementJsonBlueprints)	Sets the builder to add a GuiDocument and related systems.
SolaGraphics.Builder	withLighting()	Sets the builder to add lighting related graphics modules and systems.
SolaGraphics.Builder	withLighting(Color ambientLightColor)	Sets the builder to add lighting related graphics modules and systems.
SolaGraphics.Builder	withoutDefaultGraphicsModules()	Sets the builder to not add the default SolaGraphicsModules when initializing the SolaGraphics instance.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(SolaPlatform platform,
 technology.sola.ecs.SolaEcs solaEcs)

Creates a new SolaGraphics.Builder instance.

Parameters:

platform - the SolaPlatform instance

solaEcs - the SolaEcs instance to attach systems to

Method Details

withBackgroundColor

public SolaGraphics.Builder withBackgroundColor(Color backgroundColor)

Sets the background Color cleared to each frame.

Parameters:

backgroundColor - the Color to clear to (defaults to Color.BLACK

Returns:

this

withoutDefaultGraphicsModules

public SolaGraphics.Builder withoutDefaultGraphicsModules()

Sets the builder to not add the default SolaGraphicsModules when initializing the SolaGraphics instance.

• CircleEntityGraphicsModule
• RectangleEntityGraphicsModule
• TriangleEntityGraphicsModule
• SpriteEntityGraphicsModule
• ParticleEmitterEntityGraphicsModule

Returns:

this

withLighting

public SolaGraphics.Builder withLighting()

Sets the builder to add lighting related graphics modules and systems. Sets the ambient light color to Color.BLACK.

Returns:

this

withLighting

public SolaGraphics.Builder withLighting(Color ambientLightColor)

Sets the builder to add lighting related graphics modules and systems. Sets the ambient light color to the desired color.

Parameters:

ambientLightColor - the color to set the ambient light to

Returns:

this

withGui

public SolaGraphics.Builder withGui(MouseInput mouseInput)

Sets the builder to add a GuiDocument and related systems. Uses DefaultThemeBuilder.buildLightTheme() for the theme.

Parameters:

mouseInput - the MouseInput instance to use for the GuiDocument

Returns:

this

withGui

public SolaGraphics.Builder withGui(MouseInput mouseInput,
 GuiTheme guiTheme)

Sets the builder to add a GuiDocument and related systems. Uses desired GuiTheme.

Parameters:

mouseInput - the MouseInput instance to use for the GuiDocument

guiTheme - the GuiTheme to use for the GuiDocument

Returns:

this

withGui

public SolaGraphics.Builder withGui(MouseInput mouseInput,
 GuiTheme guiTheme,
 List<GuiElementJsonBlueprint<?,?,?>> additionalGuiElementJsonBlueprints)

Sets the builder to add a GuiDocument and related systems. Uses desired GuiTheme. Also registers additional GuiElementJsonBlueprints.

Parameters:

mouseInput - the MouseInput instance to use for the GuiDocument

guiTheme - the GuiTheme to use for the GuiDocument

additionalGuiElementJsonBlueprints - additional GuiElementJsonBlueprints to add to the GuiDocument

Returns:

this

withDebug

public SolaGraphics.Builder withDebug(@Nullable SolaPhysics solaPhysics,
 EventHub eventHub,
 KeyboardInput keyboardInput)

Enables debug rendering. If SolaPhysics is provided then collision debug rendering will also be present.

Parameters:

solaPhysics - the optional SolaPhysics instance to attach to

eventHub - the EventHub to add listeners to

keyboardInput - the KeyboardInput to control debug rendering state

Returns:

this

buildAndInitialize

public SolaGraphics buildAndInitialize(AssetLoaderProvider assetLoaderProvider)

Builds and initializes the SolaGraphics instance. This will add required EcsSystems, AssetLoaders, a DefaultFont and SolaGraphicsModules.

Parameters:

assetLoaderProvider - the AssetLoaderProvider

Returns:

the initialized SolaGraphics instance