Package codechicken.lib.gui.modular.elements

Class GuiRectangle

java.lang.Object

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

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

codechicken.lib.gui.modular.elements.GuiRectangle

All Implemented Interfaces:

BackgroundRender, ElementEvents, GuiParent<GuiRectangle>, TooltipHandler<GuiRectangle>

public class GuiRectangle
extends GuiElement<GuiRectangle>
implements BackgroundRender

Used to draw a simple rectangle on the screen. Can specify separate (or no) border colours and fill colours. Can also render using the "shadedRectangle" render type.

Created by brandon3055 on 28/08/2023

Field Summary

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

hoverTime, initialized

Constructor Summary

Constructors

Constructor	Description
GuiRectangle(@NotNull GuiParent<?> parent)

Method Summary

Modifier and Type	Method	Description
GuiRectangle	border(int border)
GuiRectangle	border(Supplier<Integer> border)
GuiRectangle	borderWidth(double borderWidth)
GuiRectangle	borderWidth(Supplier<Double> borderWidth)
GuiRectangle	fill(int fill)
GuiRectangle	fill(Supplier<Integer> fill)
double	getBorderWidth()
static GuiRectangle	invertedSlot(@NotNull GuiParent<?> parent)	Creates a rectangle that mimics the appearance of a vanilla inventory slot, except inverted Uses shadedRect to create the 3D "popped out" appearance
static GuiRectangle	planeButton(@NotNull GuiParent<?> parent)	Creates a rectangle similar in appearance to a vanilla button, but with no texture and no black border.
GuiRectangle	rectangle(int fill, int border)
GuiRectangle	rectangle(Supplier<Integer> fill, Supplier<Integer> border)
void	renderBackground(GuiRender render, double mouseX, double mouseY, float partialTicks)	Used to render content behind this elements child elements.
GuiRectangle	setShadeBottomRight(Supplier<Integer> shadeBottomRight)
GuiRectangle	setShadeCorners(Supplier<Integer> shadeCorners)
GuiRectangle	setShadeCornersAuto()
GuiRectangle	setShadeTopLeft(Supplier<Integer> shadeTopLeft)
GuiRectangle	shadedRect(int topLeft, int bottomRight, int fill)
GuiRectangle	shadedRect(int topLeft, int bottomRight, int cornerMix, int fill)
GuiRectangle	shadedRect(Supplier<Integer> topLeft, Supplier<Integer> bottomRight, Supplier<Integer> fill)
GuiRectangle	shadedRect(Supplier<Integer> topLeft, Supplier<Integer> bottomRight, Supplier<Integer> cornerMix, Supplier<Integer> fill)
static GuiRectangle	toolTipBackground(@NotNull GuiParent<?> parent)
static GuiRectangle	toolTipBackground(@NotNull GuiParent<?> parent, int backgroundColour, int borderColourTop, int borderColourBottom)
static GuiRectangle	toolTipBackground(@NotNull GuiParent<?> parent, int backgroundColourTop, int backgroundColourBottom, int borderColourTop, int borderColourBottom)
static GuiRectangle	vanillaSlot(@NotNull GuiParent<?> parent)	Creates a rectangle that mimics the appearance of a vanilla inventory slot.

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

GuiRectangle

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

Parameters:

parent - parent GuiParent.

Method Details

vanillaSlot

public static GuiRectangle vanillaSlot(@NotNull
 @NotNull GuiParent<?> parent)

Creates a rectangle that mimics the appearance of a vanilla inventory slot. Uses shadedRect to create the 3D "inset" look.

invertedSlot

public static GuiRectangle invertedSlot(@NotNull
 @NotNull GuiParent<?> parent)

Creates a rectangle that mimics the appearance of a vanilla inventory slot, except inverted Uses shadedRect to create the 3D "popped out" appearance

planeButton

public static GuiRectangle planeButton(@NotNull
 @NotNull GuiParent<?> parent)

Creates a rectangle similar in appearance to a vanilla button, but with no texture and no black border.

toolTipBackground

public static GuiRectangle toolTipBackground(@NotNull
 @NotNull GuiParent<?> parent)

toolTipBackground

public static GuiRectangle toolTipBackground(@NotNull
 @NotNull GuiParent<?> parent,
 int backgroundColour,
 int borderColourTop,
 int borderColourBottom)

toolTipBackground

public static GuiRectangle toolTipBackground(@NotNull
 @NotNull GuiParent<?> parent,
 int backgroundColourTop,
 int backgroundColourBottom,
 int borderColourTop,
 int borderColourBottom)

border

public GuiRectangle border(int border)

border

public GuiRectangle border(Supplier<Integer> border)

fill

public GuiRectangle fill(int fill)

fill

public GuiRectangle fill(Supplier<Integer> fill)

rectangle

public GuiRectangle rectangle(int fill,
 int border)

rectangle

public GuiRectangle rectangle(Supplier<Integer> fill,
 Supplier<Integer> border)

shadedRect

public GuiRectangle shadedRect(int topLeft,
 int bottomRight,
 int fill)

shadedRect

public GuiRectangle shadedRect(Supplier<Integer> topLeft,
 Supplier<Integer> bottomRight,
 Supplier<Integer> fill)

shadedRect

public GuiRectangle shadedRect(int topLeft,
 int bottomRight,
 int cornerMix,
 int fill)

shadedRect

public GuiRectangle shadedRect(Supplier<Integer> topLeft,
 Supplier<Integer> bottomRight,
 Supplier<Integer> cornerMix,
 Supplier<Integer> fill)

setShadeTopLeft

public GuiRectangle setShadeTopLeft(Supplier<Integer> shadeTopLeft)

setShadeBottomRight

public GuiRectangle setShadeBottomRight(Supplier<Integer> shadeBottomRight)

setShadeCorners

public GuiRectangle setShadeCorners(Supplier<Integer> shadeCorners)

setShadeCornersAuto

public GuiRectangle setShadeCornersAuto()

borderWidth

public GuiRectangle borderWidth(double borderWidth)

borderWidth

public GuiRectangle borderWidth(Supplier<Double> borderWidth)

getBorderWidth

public double getBorderWidth()

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.