Module technology.sola.engine

Package technology.sola.engine.defaults

Class SolaWithDefaults.DefaultsConfigurator

java.lang.Object

technology.sola.engine.defaults.SolaWithDefaults.DefaultsConfigurator

Enclosing class:

SolaWithDefaults

public class SolaWithDefaults.DefaultsConfigurator
extends Object

DefaultsConfigurator provides methods for enabling various default functionality.

Constructor Summary

Constructors

Constructor	Description
DefaultsConfigurator()

Method Summary

Modifier and Type	Method	Description
SolaWithDefaults.DefaultsConfigurator	useBackgroundColor(Color backgroundColor)	Updates the background color (what everything clears to each frame).
SolaWithDefaults.DefaultsConfigurator	useDebug()	Enables debug rendering.
SolaWithDefaults.DefaultsConfigurator	useGraphics()	Initializes the SolaWithDefaults.solaGraphics instance.
SolaWithDefaults.DefaultsConfigurator	useGui()	Initializes the GuiDocument instance with a light GuiTheme.
SolaWithDefaults.DefaultsConfigurator	useGui(GuiTheme guiTheme)	Initializes the GuiDocument instance with a desired GuiTheme.The theme will only be applied to GuiElements that are loaded via JSON files.
SolaWithDefaults.DefaultsConfigurator	useGui(GuiTheme guiTheme, List<GuiElementJsonBlueprint<?,?,?>> additionalGuiElementJsonBlueprints)	Initializes the GuiDocument instance with a desired GuiTheme.
SolaWithDefaults.DefaultsConfigurator	useLighting()	Adds the ScreenSpaceLightMapGraphicsModule SolaGraphicsModule with ambient color set to black.
SolaWithDefaults.DefaultsConfigurator	useLighting(Color ambientColor)	Adds the ScreenSpaceLightMapGraphicsModule SolaGraphicsModule with ambient color set.
SolaWithDefaults.DefaultsConfigurator	usePhysics()	Initializes the SolaWithDefaults.solaPhysics instance.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultsConfigurator

public DefaultsConfigurator()

Method Details

useDebug

public SolaWithDefaults.DefaultsConfigurator useDebug()

Enables debug rendering. This includes collider outlines and broad phase debug information.

Returns:

this

useBackgroundColor

public SolaWithDefaults.DefaultsConfigurator useBackgroundColor(Color backgroundColor)

Updates the background color (what everything clears to each frame). Default is Color.BLACK.

Parameters:

backgroundColor - the new color the renderer clears to

Returns:

this

usePhysics

public SolaWithDefaults.DefaultsConfigurator usePhysics()

Initializes the SolaWithDefaults.solaPhysics instance. This adds several EcsSystems to the Sola.solaEcs instance.

EcsSystems added

• GravitySystem
• PhysicsSystem
• CollisionDetectionSystem
• ImpulseCollisionResolutionSystem
• ParticleSystem

Returns:

this

useGraphics

public SolaWithDefaults.DefaultsConfigurator useGraphics()

Initializes the SolaWithDefaults.solaGraphics instance. This adds several SolaEntityGraphicsModules to it and adds several EcsSystems to the Sola.solaEcs instance.

Modules added

• CircleEntityGraphicsModule
• RectangleEntityGraphicsModule
• TriangleEntityGraphicsModule
• SpriteEntityGraphicsModule
• ParticleEmitterEntityGraphicsModule
• ScreenSpaceLightMapGraphicsModule

EcsSystems added

• SpriteAnimatorSystem
• TransformAnimatorSystem
• LightFlickerSystem

Returns:

this

useLighting

public SolaWithDefaults.DefaultsConfigurator useLighting()

Adds the ScreenSpaceLightMapGraphicsModule SolaGraphicsModule with ambient color set to black.

Returns:

this

useLighting

public SolaWithDefaults.DefaultsConfigurator useLighting(Color ambientColor)

Adds the ScreenSpaceLightMapGraphicsModule SolaGraphicsModule with ambient color set.

Parameters:

ambientColor - the ambient color to use

Returns:

this

useGui

public SolaWithDefaults.DefaultsConfigurator useGui()

Initializes the GuiDocument instance with a light GuiTheme. The theme will only be applied to GuiElements that are loaded via JSON files.

Returns:

this

useGui

public SolaWithDefaults.DefaultsConfigurator useGui(GuiTheme guiTheme)

Initializes the GuiDocument instance with a desired GuiTheme.The theme will only be applied to GuiElements that are loaded via JSON files.

Parameters:

guiTheme - the theme to use

Returns:

this

useGui

public SolaWithDefaults.DefaultsConfigurator useGui(GuiTheme guiTheme,
 List<GuiElementJsonBlueprint<?,?,?>> additionalGuiElementJsonBlueprints)

Initializes the GuiDocument instance with a desired GuiTheme. Also registers additional GuiElementJsonBlueprints for parsing different kinds of elements as JSON. The theme will only be applied to GuiElements that are loaded via JSON files.

Parameters:

guiTheme - the theme to use

additionalGuiElementJsonBlueprints - addition gui element json blueprints to register for parsing

Returns:

this