Package xyz.gmitch215.socketmc.util.render

Class DrawingContext

java.lang.Object

xyz.gmitch215.socketmc.util.render.DrawingContext

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Function<GraphicsContext,DrawingContext.Command>>

public final class DrawingContext
extends Object
implements Serializable, Iterable<Function<GraphicsContext,DrawingContext.Command>>, Cloneable

Represents the raw graphics context used to display graphics on the screen.

This allows you to also collect the context of the current screen, as specified in GraphicsContext. The Function interfaces you specify must be serializable and cannot call anything external.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DrawingContext.Command	Represents a command in a DrawingContext.
static final class	DrawingContext.Modifier	Represents a modifier for a specific DrawingContext.Command.
static enum	DrawingContext.Type	Represents the type of drawing command to use.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BLIT	Blit
static final int	BLIT_SPRITE	Blit Sprite
static final int	DISABLE_SCISSOR	Disable Scissor
static final int	DRAW_CENTERED_STRING	Draw Centered String
static final int	DRAW_ITEMSTACK	Draw ItemStack
static final int	DRAW_STRING	Draw String
static final int	DRAW_TOOLTIP	Draw Tooltip
static final int	DRAW_WORD_WRAP	Draw Word Wrap
static final int	ENABLE_SCISSOR	Enable Scissor
static final int	FILL	Fill
static final int	FILL_GRADIENT	Fill Gradient
static final int	H_LINE	Horizontal Line
static final int	MODIFIER_APPLY_NORMAL	A custom modifier on the normal for the pose stack.
static final int	MODIFIER_APPLY_POSE	A custom modifier on the pose for the pose stack.
static final int	MODIFIER_ROTATE	Rotates an element on the XYZ axis.
static final int	MODIFIER_ROTATE_AROUND	Rotates an element on the XYZ axis around a specific coordinate.
static final int	MODIFIER_SCALE	Scales an element on the XYZ axis.
static final int	MODIFIER_TRANSLATE	Translates an element across the XYZ axis.
static final int	OUTLINE	Outline
static final int	V_LINE	Vertical Line

Method Summary

Modifier and Type	Method	Description
void	addCommand(int index, @NotNull Function<GraphicsContext,DrawingContext.Command> command)	Adds a command to the DrawingContext at the specified index.
void	addCommand(int index, @NotNull DrawingContext.Command command)	Adds a command to the DrawingContext at the specified index.
void	addCommand(@NotNull Function<GraphicsContext,DrawingContext.Command> command)	Adds a command to the DrawingContext.
void	addCommand(@NotNull DrawingContext.Command command)	Adds a command to the DrawingContext.
void	clearCommands()	Clears all commands from the DrawingContext.
@NotNull DrawingContext	clone()
boolean	equals(Object o)
@NotNull List<Function<GraphicsContext,DrawingContext.Command>>	getCommands()	Gets an immutable copy of the commands in this DrawingContext, with the current GraphicsContext information.
int	hashCode()
boolean	isLocked()	Checks if the DrawingContext is locked.
@NotNull Iterator<Function<GraphicsContext,DrawingContext.Command>>	iterator()
void	lock()	Locks the DrawingContext, making it immutable.
static @NotNull DrawingContext	of(@NotNull Collection<Function<GraphicsContext,DrawingContext.Command>> commands)	Creates a new DrawingContext from a list of commands.
static @NotNull DrawingContext	of(@NotNull Function<GraphicsContext,DrawingContext.Command> command)	Creates a new DrawingContext from a single command.
static @NotNull DrawingContext	of(@NotNull Function<GraphicsContext,DrawingContext.Command>... commands)	Creates a new DrawingContext from an array of commands.
void	removeCommand(int index)	Removes a command from the DrawingContext at the specified index.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

H_LINE

public static final int H_LINE

Horizontal Line

See Also:

• Constant Field Values

V_LINE

public static final int V_LINE

Vertical Line

See Also:

• Constant Field Values

ENABLE_SCISSOR

public static final int ENABLE_SCISSOR

Enable Scissor

See Also:

• Constant Field Values

DISABLE_SCISSOR

public static final int DISABLE_SCISSOR

Disable Scissor

See Also:

• Constant Field Values

FILL

public static final int FILL

Fill

See Also:

• Constant Field Values

FILL_GRADIENT

public static final int FILL_GRADIENT

Fill Gradient

See Also:

• Constant Field Values

DRAW_CENTERED_STRING

public static final int DRAW_CENTERED_STRING

Draw Centered String

See Also:

• Constant Field Values

DRAW_STRING

public static final int DRAW_STRING

Draw String

See Also:

• Constant Field Values

DRAW_WORD_WRAP

public static final int DRAW_WORD_WRAP

Draw Word Wrap

See Also:

• Constant Field Values

OUTLINE

public static final int OUTLINE

Outline

See Also:

• Constant Field Values

BLIT

public static final int BLIT

Blit

See Also:

• Constant Field Values

BLIT_SPRITE

public static final int BLIT_SPRITE

Blit Sprite

See Also:

• Constant Field Values

DRAW_TOOLTIP

public static final int DRAW_TOOLTIP

Draw Tooltip

See Also:

• Constant Field Values

DRAW_ITEMSTACK

public static final int DRAW_ITEMSTACK

Draw ItemStack

See Also:

• Constant Field Values

MODIFIER_SCALE

public static final int MODIFIER_SCALE

Scales an element on the XYZ axis.

See Also:

• Constant Field Values

MODIFIER_TRANSLATE

public static final int MODIFIER_TRANSLATE

Translates an element across the XYZ axis.

See Also:

• Constant Field Values

MODIFIER_ROTATE

public static final int MODIFIER_ROTATE

Rotates an element on the XYZ axis.

See Also:

• Constant Field Values

MODIFIER_ROTATE_AROUND

public static final int MODIFIER_ROTATE_AROUND

Rotates an element on the XYZ axis around a specific coordinate.

See Also:

• Constant Field Values

MODIFIER_APPLY_POSE

public static final int MODIFIER_APPLY_POSE

A custom modifier on the pose for the pose stack.

See Also:

• Constant Field Values

MODIFIER_APPLY_NORMAL

public static final int MODIFIER_APPLY_NORMAL

A custom modifier on the normal for the pose stack.

See Also:

• Constant Field Values

Method Details

getCommands

@NotNull
public @NotNull List<Function<GraphicsContext,DrawingContext.Command>> getCommands()

Gets an immutable copy of the commands in this DrawingContext, with the current GraphicsContext information.

Returns:

DrawingContext Commands

addCommand

public void addCommand(@NotNull
 @NotNull DrawingContext.Command command)
                throws IllegalArgumentException

Adds a command to the DrawingContext.

Parameters:

command - the command to add

Throws:

IllegalArgumentException - if the command is null

addCommand

public void addCommand(@NotNull
 @NotNull Function<GraphicsContext,DrawingContext.Command> command)
                throws IllegalArgumentException

Adds a command to the DrawingContext.

Parameters:

command - the command to add

Throws:

IllegalArgumentException - if the command is null

addCommand

public void addCommand(int index,
 @NotNull
 @NotNull DrawingContext.Command command)
                throws IllegalArgumentException

Adds a command to the DrawingContext at the specified index.

Parameters:

index - the index to add the command at

command - the command to add

Throws:

IllegalArgumentException - if the command is null

addCommand

public void addCommand(int index,
 @NotNull
 @NotNull Function<GraphicsContext,DrawingContext.Command> command)
                throws IllegalArgumentException

Adds a command to the DrawingContext at the specified index.

Parameters:

index - the index to add the command at

command - the command to add

Throws:

IllegalArgumentException - if the command is null

removeCommand

public void removeCommand(int index)

Removes a command from the DrawingContext at the specified index.

Parameters:

index - the index to remove the command at

clearCommands

public void clearCommands()

Clears all commands from the DrawingContext.

isLocked

public boolean isLocked()

Checks if the DrawingContext is locked. If true, this DrawingContext cannot be modified.

Returns:

true if the DrawingContext is locked, false otherwise

lock

public void lock()
          throws IllegalStateException

Locks the DrawingContext, making it immutable.

Throws:

IllegalStateException - if the DrawingContext is already locked

clone

@NotNull
public @NotNull DrawingContext clone()

Overrides:

clone in class Object

iterator

@NotNull
public @NotNull Iterator<Function<GraphicsContext,DrawingContext.Command>> iterator()

Specified by:

iterator in interface Iterable<Function<GraphicsContext,DrawingContext.Command>>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

of

@NotNull
public static @NotNull DrawingContext of(@NotNull
 @NotNull Function<GraphicsContext,DrawingContext.Command> command)
                                  throws IllegalArgumentException

Creates a new DrawingContext from a single command.

Parameters:

command - the command to use

Returns:

A new DrawingContext

Throws:

IllegalArgumentException - if the command is null

of

@NotNull
public static @NotNull DrawingContext of(@NotNull
 @NotNull Collection<Function<GraphicsContext,DrawingContext.Command>> commands)
                                  throws IllegalArgumentException

Creates a new DrawingContext from a list of commands.

Parameters:

commands - the commands to use

Returns:

A new DrawingContext

Throws:

IllegalArgumentException - if the commands are null

of

@NotNull
@SafeVarargs
public static @NotNull DrawingContext of(@NotNull
 @NotNull Function<GraphicsContext,DrawingContext.Command>... commands)
                                  throws IllegalArgumentException

Creates a new DrawingContext from an array of commands.

Parameters:

commands - the commands to use

Returns:

A new DrawingContext

Throws:

IllegalArgumentException - if the commands are null