Module technology.sola.engine

Package technology.sola.engine.graphics.modules

Class GuiDocumentGraphicsModule

java.lang.Object

technology.sola.engine.graphics.modules.SolaGraphicsModule

technology.sola.engine.graphics.modules.GuiDocumentGraphicsModule

All Implemented Interfaces:

Comparable<SolaGraphicsModule>

@NullMarked
public class GuiDocumentGraphicsModule
extends SolaGraphicsModule

SolaGraphicsModule for rendering a GuiDocument. This will render on top of Layers if they are present.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ORDER	The render order for this graphics module.

Constructor Summary

Constructors

Constructor	Description
GuiDocumentGraphicsModule(GuiDocument guiDocument)	Creates an instance of this graphics module.

Method Summary

Modifier and Type	Method	Description
int	getOrder()	Gets the order of this graphics module.
void	renderMethod(Renderer renderer, technology.sola.ecs.World world, Matrix3D cameraScaleTransform, Matrix3D cameraTranslationTransform)	The specific render method for a graphics module that is called once per frame if active.

Methods inherited from class technology.sola.engine.graphics.modules.SolaGraphicsModule

compareTo, isActive, render, setActive

Methods inherited from class java.lang.Object

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

Field Details

ORDER

public static final int ORDER

The render order for this graphics module.

See Also:

• Constant Field Values

Constructor Details

GuiDocumentGraphicsModule

public GuiDocumentGraphicsModule(GuiDocument guiDocument)

Creates an instance of this graphics module.

Parameters:

guiDocument - the GuiDocument to render

Method Details

renderMethod

public void renderMethod(Renderer renderer,
 technology.sola.ecs.World world,
 Matrix3D cameraScaleTransform,
 Matrix3D cameraTranslationTransform)

Description copied from class: SolaGraphicsModule

The specific render method for a graphics module that is called once per frame if active.

Specified by:

renderMethod in class SolaGraphicsModule

Parameters:

renderer - tbe Renderer instance

world - the World instance

cameraScaleTransform - the camera's scale

cameraTranslationTransform - the camera's translation

getOrder

public int getOrder()

Description copied from class: SolaGraphicsModule

Gets the order of this graphics module. A higher value means it will be rendered on top.

Overrides:

getOrder in class SolaGraphicsModule

Returns:

the order of this graphics module