Module technology.sola.engine

Package technology.sola.engine.graphics.gui.elements

Class SpriteGuiElement

java.lang.Object

technology.sola.engine.graphics.gui.GuiElement<BaseStyles,SpriteGuiElement>

technology.sola.engine.graphics.gui.elements.SpriteGuiElement

@NullMarked
public class SpriteGuiElement
extends GuiElement<BaseStyles,SpriteGuiElement>

SpriteGuiElement is a GuiElement that renders a sprite from a SpriteSheet in a GUI. It does not render child elements.

Field Summary

Fields inherited from class technology.sola.engine.graphics.gui.GuiElement

children, contentBounds, styleContainer

Constructor Summary

Constructors

Constructor	Description
SpriteGuiElement()

Method Summary

Modifier and Type	Method	Description
SpriteGuiElement	appendChildren(GuiElement<?,?>... children)	ImageGuiElement does not render children so this method will do nothing.
@Nullable GuiElementDimensions	calculateContentDimensions()	Calculates content dimensions for this element.
@Nullable String	getAssetId()
@Nullable String	getSpriteId()
boolean	isFocusable()	ImageGuiElement is not focusable so this will return false.
SpriteGuiElement	removeChild(GuiElement<?,?> child)	ImageGuiElement does not render children so this method will do nothing.
void	renderContent(Renderer renderer)	Method to render the main content of the gui element (not borders, backgrounds, etc.).
SpriteGuiElement	self()
SpriteGuiElement	setAssetId(String assetId)	Sets the id of the SpriteSheet asset to be rendered.
SpriteGuiElement	setSpriteId(String spriteId)	Sets the id of the sprite within the SpriteSheet to be rendered.

Methods inherited from class technology.sola.engine.graphics.gui.GuiElement

addStyle, addStyle, addStyles, events, findElementById, findElementsByType, findFocussedChildIndex, getAssetLoaderProvider, getBounds, getContentBounds, getFocusableChildren, getId, getParent, invalidateLayout, isActive, isAttached, isFocussed, isHovered, isLayoutChanged, render, renderChildren, requestFocus, setId, setVirtualKeyboardVisible, styles

Methods inherited from class java.lang.Object

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

Constructor Details

SpriteGuiElement

public SpriteGuiElement()

Method Details

renderContent

public void renderContent(Renderer renderer)

Description copied from class: GuiElement

Method to render the main content of the gui element (not borders, backgrounds, etc.).

Specified by:

renderContent in class GuiElement<BaseStyles,SpriteGuiElement>

Parameters:

renderer - the Renderer instance

calculateContentDimensions

public @Nullable GuiElementDimensions calculateContentDimensions()

Description copied from class: GuiElement

Calculates content dimensions for this element. If its dimensions are derived from only its children then it should return null.

Specified by:

calculateContentDimensions in class GuiElement<BaseStyles,SpriteGuiElement>

Returns:

the dimensions of the content of this element or null if only children dimensions matter

self

public SpriteGuiElement self()

Specified by:

self in class GuiElement<BaseStyles,SpriteGuiElement>

Returns:

A correctly typed reference to this GuiElement

isFocusable

public boolean isFocusable()

ImageGuiElement is not focusable so this will return false.

Overrides:

isFocusable in class GuiElement<BaseStyles,SpriteGuiElement>

Returns:

false

appendChildren

public SpriteGuiElement appendChildren(GuiElement<?,?>... children)

ImageGuiElement does not render children so this method will do nothing.

Overrides:

appendChildren in class GuiElement<BaseStyles,SpriteGuiElement>

Parameters:

children - the child elements that will not be added

Returns:

this

removeChild

public SpriteGuiElement removeChild(GuiElement<?,?> child)

ImageGuiElement does not render children so this method will do nothing.

Overrides:

removeChild in class GuiElement<BaseStyles,SpriteGuiElement>

Parameters:

child - the child element that will not be removed

Returns:

this

getAssetId

public @Nullable String getAssetId()

Returns:

the id of the SpriteSheet asset to be rendered

setAssetId

public SpriteGuiElement setAssetId(String assetId)

Sets the id of the SpriteSheet asset to be rendered.

Parameters:

assetId - the new asset id of the image

Returns:

this

getSpriteId

public @Nullable String getSpriteId()

Returns:

the id of the sprite within the SpriteSheet to be rendered.

setSpriteId

public SpriteGuiElement setSpriteId(String spriteId)

Sets the id of the sprite within the SpriteSheet to be rendered.

Parameters:

spriteId - the sprite id to be rendered

Returns:

this