Package codechicken.lib.gui.modular.elements

Class GuiProgressIcon

java.lang.Object

codechicken.lib.gui.modular.lib.geometry.ConstrainedGeometry<GuiProgressIcon>

codechicken.lib.gui.modular.elements.GuiElement<GuiProgressIcon>

codechicken.lib.gui.modular.elements.GuiProgressIcon

All Implemented Interfaces:

BackgroundRender, ElementEvents, GuiParent<GuiProgressIcon>, TooltipHandler<GuiProgressIcon>

public class GuiProgressIcon
extends GuiElement<GuiProgressIcon>
implements BackgroundRender

This can be used to create a simple progress indicator like those used in machines like furnaces.

The background texture (if one is used) and the animated texture must be the same shape and size, They must be designed so that the animated texture can be rendered directly on top of the background texture with no offset. The animated texture should not have any empty space on ether end as the entire width of the texture is used in the animation.

Texture must be designed for left to right animation,

Created by brandon3055 on 04/09/2023

Field Summary

Fields inherited from class codechicken.lib.gui.modular.elements.GuiElement

hoverTime, initialized

Constructor Summary

Constructors

Constructor	Description
GuiProgressIcon(@NotNull GuiParent<?> parent)
GuiProgressIcon(@NotNull GuiParent<?> parent, Material animated)
GuiProgressIcon(@NotNull GuiParent<?> parent, Material background, Material animated)
GuiProgressIcon(@NotNull GuiParent<?> parent, Supplier<Material> animated)
GuiProgressIcon(@NotNull GuiParent<?> parent, Supplier<Material> background, Supplier<Material> animated)

Method Summary

Modifier and Type	Method	Description
double	getProgress()
void	renderBackground(GuiRender render, double mouseX, double mouseY, float partialTicks)	Used to render content behind this elements child elements.
GuiProgressIcon	setAnimated(Material animated)	Sets the texture that will be animated.
GuiProgressIcon	setAnimated(Supplier<Material> animated)	Sets the texture that will be animated.
GuiProgressIcon	setBackground(@Nullable Material background)	Sets the background texture, aka the "empty" texture.
GuiProgressIcon	setBackground(@Nullable Supplier<Material> background)	Sets the background texture, aka the "empty" texture.
GuiProgressIcon	setDirection(Direction direction)	Set the direction this progress icon is pointing, Default is RIGHT
GuiProgressIcon	setProgress(double progress)	Set the current progress to a fixed value.
GuiProgressIcon	setProgress(Supplier<Double> progress)	Attach a supplier that returns the current progress value for this progress icon (0 to 1)
GuiProgressIcon	setRotateToDirection(boolean rotateToDirection)	The expected default direction for a progress texture is left-to-right e.g.

Methods inherited from class codechicken.lib.gui.modular.elements.GuiElement

addChild, addJeiDropTargets, addJeiExclusions, adoptChild, applyQueuedChildUpdates, blockMouseEvents, blockMouseOver, bringChildToForeground, font, getChildren, getCombinedElementDepth, getJeiDropConsumer, getModularGui, getParent, getTooltip, getTooltipDelay, hoverTime, initElement, isDescendantOf, isEnabled, isJeiDropTarget, isJeiExcluded, isMouseOver, isOpaque, isRemoved, isTooltipEnabled, jeiExclude, mc, onScreenInit, removeChild, render, renderChild, renderOverlay, scaledScreenHeight, scaledScreenWidth, sendChildToBackground, sendChildToIndex, setEnabled, setEnabled, setEnableToolTip, setJeiDropTarget, setJeiExcluded, setOpaque, setRenderCull, setTooltip, setTooltipDelay, setZStacking, showToolTip, tick, toString, updateMouseOver, updateScreenData, zStacking

Methods inherited from class codechicken.lib.gui.modular.lib.geometry.ConstrainedGeometry

addBoundsToRect, clearConstraints, clearGeometryCache, constrain, get, getChildBounds, getEnclosingRect, getParent, getPosition, getRectangle, placeInside, placeInside, placeOutside, placeOutside, setHeight, setPos, setSize, setWidth, setXPos, setYPos, strictMode, validate, xCenter, xMax, xMin, xSize, yCenter, yMax, yMin, ySize

Methods inherited from class java.lang.Object

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

Methods inherited from interface codechicken.lib.gui.modular.lib.BackgroundRender

getBackgroundDepth

Methods inherited from interface codechicken.lib.gui.modular.lib.ElementEvents

charTyped, charTyped, keyPressed, keyPressed, keyReleased, keyReleased, mouseClicked, mouseClicked, mouseMoved, mouseReleased, mouseReleased, mouseScrolled, mouseScrolled

Methods inherited from interface codechicken.lib.gui.modular.lib.geometry.GuiParent

addChild, getValue

Methods inherited from interface codechicken.lib.gui.modular.lib.TooltipHandler

renderTooltip, setTooltip, setTooltip, setTooltip, setTooltipSingle, setTooltipSingle

Constructor Details

GuiProgressIcon

public GuiProgressIcon(@NotNull
 @NotNull GuiParent<?> parent,
 Supplier<Material> animated)

GuiProgressIcon

public GuiProgressIcon(@NotNull
 @NotNull GuiParent<?> parent,
 Material animated)

GuiProgressIcon

public GuiProgressIcon(@NotNull
 @NotNull GuiParent<?> parent,
 Supplier<Material> background,
 Supplier<Material> animated)

GuiProgressIcon

public GuiProgressIcon(@NotNull
 @NotNull GuiParent<?> parent,
 Material background,
 Material animated)

GuiProgressIcon

public GuiProgressIcon(@NotNull
 @NotNull GuiParent<?> parent)

Method Details

setRotateToDirection

public GuiProgressIcon setRotateToDirection(boolean rotateToDirection)

The expected default direction for a progress texture is left-to-right e.g. furnace arrow. The texture will then be rotated to the direction specified via setDirection(Direction) If you do not want the texture to be rotated then set this to false.

setDirection

public GuiProgressIcon setDirection(Direction direction)

Set the direction this progress icon is pointing, Default is RIGHT

setBackground

public GuiProgressIcon setBackground(@Nullable
 @Nullable Material background)

Sets the background texture, aka the "empty" texture.

setBackground

public GuiProgressIcon setBackground(@Nullable
 @Nullable Supplier<Material> background)

Sets the background texture, aka the "empty" texture.

setAnimated

public GuiProgressIcon setAnimated(Material animated)

Sets the texture that will be animated.

setAnimated

public GuiProgressIcon setAnimated(Supplier<Material> animated)

Sets the texture that will be animated.

setProgress

public GuiProgressIcon setProgress(double progress)

Set the current progress to a fixed value.

See Also:

• setProgress(Supplier)

setProgress

public GuiProgressIcon setProgress(Supplier<Double> progress)

Attach a supplier that returns the current progress value for this progress icon (0 to 1)

getProgress

public double getProgress()

renderBackground

public void renderBackground(GuiRender render,
 double mouseX,
 double mouseY,
 float partialTicks)

Description copied from interface: BackgroundRender

Used to render content behind this elements child elements. When rendering element content, always use the PoseStack available via the provided GuiRender Where applicable, always use push/pop to ensure the stack is returned to its original state after your rendering is complete.

Specified by:

renderBackground in interface BackgroundRender

Parameters:

render - Contains gui context information as well as essential render methods/utils including the PoseStack.