Module technology.sola.engine

Package technology.sola.engine.defaults.graphics.modules

Class SpriteEntityGraphicsModule

java.lang.Object

technology.sola.engine.defaults.graphics.modules.SolaGraphicsModule

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

technology.sola.engine.defaults.graphics.modules.SpriteEntityGraphicsModule

All Implemented Interfaces:

Comparable<SolaGraphicsModule>

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

SpriteEntityGraphicsModule is a SolaEntityGraphicsModule implementation for rendering Entity that have a TransformComponent and SpriteComponent.

Constructor Summary

Constructors

Constructor	Description
SpriteEntityGraphicsModule(AssetLoader<SpriteSheet> spriteSheetAssetLoader)	Creates an instance of SpriteEntityGraphicsModule.

Method Summary

Modifier and Type	Method	Description
technology.sola.ecs.view.View<technology.sola.ecs.view.View2Entry<SpriteComponent,TransformComponent>>	getViewToRender(technology.sola.ecs.World world)	Returns a View of Entity that need to be rendered via SolaEntityGraphicsModule.renderEntity(Renderer, V, TransformComponent)
void	renderEntity(Renderer renderer, technology.sola.ecs.view.View2Entry<SpriteComponent,TransformComponent> viewEntry, TransformComponent cameraModifiedEntityTransform)	Called on each Entity to render it.

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

getTransformForAppliedCamera, renderEntity, renderMethod

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

compareTo, getOrder, isActive, render, setActive

Methods inherited from class java.lang.Object

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

Constructor Details

SpriteEntityGraphicsModule

public SpriteEntityGraphicsModule(AssetLoader<SpriteSheet> spriteSheetAssetLoader)

Creates an instance of SpriteEntityGraphicsModule.

Parameters:

spriteSheetAssetLoader - the AssetLoader instance for SpriteSheets

Method Details

getViewToRender

public technology.sola.ecs.view.View<technology.sola.ecs.view.View2Entry<SpriteComponent,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<SpriteComponent,TransformComponent>>

Parameters:

world - the World

Returns:

the view of entities

renderEntity

public void renderEntity(Renderer renderer,
 technology.sola.ecs.view.View2Entry<SpriteComponent,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<SpriteComponent,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