Module technology.sola.engine

Package technology.sola.engine.debug

Class DebugGraphicsModule

java.lang.Object

technology.sola.engine.graphics.modules.SolaGraphicsModule

technology.sola.engine.graphics.modules.SolaEntityGraphicsModule<technology.sola.ecs.view.View2Entry<ColliderComponent,TransformComponent>>

technology.sola.engine.debug.DebugGraphicsModule

All Implemented Interfaces:

Comparable<SolaGraphicsModule>

@NullMarked
public class DebugGraphicsModule
extends SolaEntityGraphicsModule<technology.sola.ecs.view.View2Entry<ColliderComponent,TransformComponent>>

DebugEntityGraphicsModule is a SolaEntityGraphicsModule implementation for rendering debug information for a World. It will render broad phase debug information and colliders for Entity that have a ColliderComponent.

Field Summary

Fields

Modifier and Type	Field	Description
static final Key	KEY_BOUNDING_BOX	The Key that toggles bounding box debug rendering.
static final Key	KEY_BROAD_PHASE	The Key that toggles broad phase debug rendering.
static final Key	KEY_COLLIDER	The Key that toggles collider debug rendering.

Constructor Summary

Constructors

Constructor	Description
DebugGraphicsModule(@Nullable CollisionDetectionSystem collisionDetectionSystem, EventHub eventHub)	Creates an instance of DebugEntityGraphicsModule.

Method Summary

Modifier and Type	Method	Description
int	getOrder()	Gets the order of this graphics module.
technology.sola.ecs.view.View<technology.sola.ecs.view.View2Entry<ColliderComponent,TransformComponent>>	getViewToRender(technology.sola.ecs.World world)	Returns a View of Entity that need to be rendered via SolaEntityGraphicsModule.renderEntity(Renderer, V, TransformComponent)
boolean	isRenderingBoundingBoxes()	Whether ColliderComponent.getBoundingBox(TransformComponent) debug rendering is enabled or not.
boolean	isRenderingBroadPhase()	Whether CollisionDetectionBroadPhase debug rendering is enabled or not.
boolean	isRenderingColliders()	Whether ColliderComponent.getShape(TransformComponent) debug rendering is enabled or not.
void	render(Renderer renderer, technology.sola.ecs.World world, Matrix3D cameraScaleTransform, Matrix3D cameraTranslationTransform)	The main render method for a graphics module that is called once per frame.
void	renderEntity(Renderer renderer, technology.sola.ecs.view.View2Entry<ColliderComponent,TransformComponent> viewEntry, TransformComponent cameraModifiedEntityTransform)	Called on each Entity to render it.
void	setRenderingBoundingBoxes(boolean isEnabled)	Enable or disable ColliderComponent.getBoundingBox(TransformComponent) debug rendering.
void	setRenderingBroadPhase(boolean isEnabled)	Enable or disable CollisionDetectionBroadPhase debug rendering.
void	setRenderingColliders(boolean isEnabled)	Enabled or disable ColliderComponent.getShape(TransformComponent) debug rendering.

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

getTransformForAppliedCamera, renderEntity, renderMethod

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

compareTo, isActive, setActive

Methods inherited from class java.lang.Object

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

Field Details

KEY_BROAD_PHASE

public static final Key KEY_BROAD_PHASE

The Key that toggles broad phase debug rendering.

KEY_BOUNDING_BOX

public static final Key KEY_BOUNDING_BOX

The Key that toggles bounding box debug rendering.

KEY_COLLIDER

public static final Key KEY_COLLIDER

The Key that toggles collider debug rendering.

Constructor Details

DebugGraphicsModule

public DebugGraphicsModule(@Nullable CollisionDetectionSystem collisionDetectionSystem,
 EventHub eventHub)

Creates an instance of DebugEntityGraphicsModule.

Parameters:

collisionDetectionSystem - the CollisionDetectionSystem instance

eventHub - the EventHub instance

Method Details

getViewToRender

public technology.sola.ecs.view.View<technology.sola.ecs.view.View2Entry<ColliderComponent,TransformComponent>> getViewToRender(technology.sola.ecs.World world)

Description copied from class: SolaEntityGraphicsModule

Returns a View of Entity that need to be rendered via SolaEntityGraphicsModule.renderEntity(Renderer, V, TransformComponent)

Specified by:

getViewToRender in class SolaEntityGraphicsModule<technology.sola.ecs.view.View2Entry<ColliderComponent,TransformComponent>>

Parameters:

world - the World

Returns:

the view of entities

render

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

Description copied from class: SolaGraphicsModule

The main render method for a graphics module that is called once per frame. It will call the SolaGraphicsModule.renderMethod(Renderer, World, Matrix3D, Matrix3D) if the module is active.

Overrides:

render in class SolaGraphicsModule

Parameters:

renderer - tbe Renderer instance

world - the World instance

cameraScaleTransform - the camera's scale

cameraTranslationTransform - the camera's translation

renderEntity

public void renderEntity(Renderer renderer,
 technology.sola.ecs.view.View2Entry<ColliderComponent,TransformComponent> viewEntry,
 TransformComponent cameraModifiedEntityTransform)

Description copied from class: SolaEntityGraphicsModule

Called on each Entity to render it. A TransformComponent instance with the camera's transform applied is provided for each entity. If an entity has a LayerComponent it will be rendered to its layer.

Specified by:

renderEntity in class SolaEntityGraphicsModule<technology.sola.ecs.view.View2Entry<ColliderComponent,TransformComponent>>

Parameters:

renderer - tbe Renderer instance

viewEntry - the ViewEntry containing the Entity to render

cameraModifiedEntityTransform - a TransformComponent with the camera's transform applied to the entity's transform

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

isRenderingColliders

public boolean isRenderingColliders()

Whether ColliderComponent.getShape(TransformComponent) debug rendering is enabled or not.

Returns:

true if collider debug rendering is enabled

setRenderingColliders

public void setRenderingColliders(boolean isEnabled)

Enabled or disable ColliderComponent.getShape(TransformComponent) debug rendering.

Parameters:

isEnabled - new collider debug rendering enabled state

isRenderingBoundingBoxes

public boolean isRenderingBoundingBoxes()

Whether ColliderComponent.getBoundingBox(TransformComponent) debug rendering is enabled or not.

Returns:

true if collider bounding box debug rendering is enabled

setRenderingBoundingBoxes

public void setRenderingBoundingBoxes(boolean isEnabled)

Enable or disable ColliderComponent.getBoundingBox(TransformComponent) debug rendering.

Parameters:

isEnabled - new collider bounding box debug rendering enabled state

isRenderingBroadPhase

public boolean isRenderingBroadPhase()

Whether CollisionDetectionBroadPhase debug rendering is enabled or not.

Returns:

true if collision detection broad phase debug rendering is enabled

setRenderingBroadPhase

public void setRenderingBroadPhase(boolean isEnabled)

Enable or disable CollisionDetectionBroadPhase debug rendering.

Parameters:

isEnabled - new collision detection broad phase debug rendering enabled state