Module technology.sola.engine

Package technology.sola.engine.graphics

Class SolaGraphics

java.lang.Object

technology.sola.engine.graphics.SolaGraphics

@NullMarked
public class SolaGraphics
extends Object

SolaGraphics provides default rendering capabilities while also allowing for adding new rendering capabilities via SolaGraphicsModules.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SolaGraphics.Builder	Builder for SolaGraphics.

Method Summary

Modifier and Type	Method	Description
void	addGraphicsModules(SolaGraphicsModule... graphicsModules)	Adds SolaGraphicsModules to be rendered.
<T extends SolaGraphicsModule> T	getGraphicsModule(Class<T> solaGraphicsModuleClass)	Gets a SolaGraphicsModule that has been added or else null.
SpriteAnimatorSystem	getSpriteAnimatorSystem()
TransformAnimatorSystem	getTransformAnimatorSystem()
GuiDocument	guiDocument()	The GuiDocument instance for this Sola.
void	render(Renderer renderer)	Renders all SolaGraphicsModules that have been added.
Vector2D	screenToWorldCoordinate(Vector2D screenCoordinate)	Using the camera's transform, this method calculates the World coordinate based on the screen's coordinate system.

Methods inherited from class java.lang.Object

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

Method Details

addGraphicsModules

public void addGraphicsModules(SolaGraphicsModule... graphicsModules)

Adds SolaGraphicsModules to be rendered.

Parameters:

graphicsModules - the modules to add

getGraphicsModule

public <T extends SolaGraphicsModule> T getGraphicsModule(Class<T> solaGraphicsModuleClass)

Gets a SolaGraphicsModule that has been added or else null.

Type Parameters:

T - the type of graphics module

Parameters:

solaGraphicsModuleClass - the class of the SolaGraphicsModule

Returns:

the graphics module

render

public void render(Renderer renderer)

Renders all SolaGraphicsModules that have been added. Passes each the current camera's translation and scale.

Parameters:

renderer - the Renderer instance

screenToWorldCoordinate

public Vector2D screenToWorldCoordinate(Vector2D screenCoordinate)

Using the camera's transform, this method calculates the World coordinate based on the screen's coordinate system.

Parameters:

screenCoordinate - the coordinate of the screen to map

Returns:

the coordinate mapped to the World's coordinate system

guiDocument

public GuiDocument guiDocument()

The GuiDocument instance for this Sola. Call SolaGraphics.Builder.withGui(MouseInput) to configure.

Returns:

GuiDocument instance

getSpriteAnimatorSystem

public SpriteAnimatorSystem getSpriteAnimatorSystem()

Returns:

the SpriteAnimatorSystem

getTransformAnimatorSystem

public TransformAnimatorSystem getTransformAnimatorSystem()

Returns:

the TransformAnimatorSystem