io.github.bananapuncher714.cartographer.core.map.palette

Class MinimapPalette

java.lang.Object

io.github.bananapuncher714.cartographer.core.map.palette.MinimapPalette

public class MinimapPalette
extends java.lang.Object

Contains colors for blocks.

Author:

BananaPuncher714

Constructor Summary

Constructors

Constructor and Description
MinimapPalette() Construct a MinimapPalette with transparent black as the default color.
MinimapPalette(java.awt.Color defaultColor) Construct a MinimapPalette with the provided color.

Method Summary

Modifier and Type	Method and Description
void	addTransparentMaterial(CrossVersionMaterial material) Add a CrossVersionMaterial as transparent.
boolean	contains(CrossVersionMaterial material) Check if the material has a color registered.
java.awt.Color	getColor(CrossVersionMaterial material) Get the color of a CrossVersionMaterial as designated by this palette.
java.awt.Color	getDefaultColor() Get the default color for this palette.
int	getDefaultRGB() Get the default integer color for this palette.
java.util.Set<CrossVersionMaterial>	getMaterials() Get the CrossVersionMaterial that are registered.
byte	getMinecraftColor(CrossVersionMaterial material) Get the Minecraft color for a particular CrossVersionMaterial as designated by this palette.
int	getRGB(CrossVersionMaterial material) Get the integer color of a CrossVersionMaterial as designated by this palette.
java.util.Set<CrossVersionMaterial>	getTransparentBlocks() Get the CrossVersionMaterial that are registered as transparent.
boolean	isTransparent(CrossVersionMaterial material) Check if the material is listed as transparent by this palette.
void	setColor(CrossVersionMaterial material, java.awt.Color color) Set the color of a CrossVersionMaterial.
void	setColor(CrossVersionMaterial material, int argb) Set the color of a CrossVersionMaterial.
void	setDefaultColor(java.awt.Color color) Set the default color.
void	setDefaultColor(int argb) Set the default color.

Methods inherited from class java.lang.Object

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

Constructor Detail

MinimapPalette

public MinimapPalette()

Construct a MinimapPalette with transparent black as the default color.

MinimapPalette

public MinimapPalette(java.awt.Color defaultColor)

Construct a MinimapPalette with the provided color.

Parameters:

defaultColor - Cannot be null.

Method Detail

contains

public boolean contains(CrossVersionMaterial material)

Check if the material has a color registered.

Parameters:

material - A CrossVersionMaterial.

Returns:

If the map contains the exact CrossVersionMaterial provided.

getMinecraftColor

public byte getMinecraftColor(CrossVersionMaterial material)

Get the Minecraft color for a particular CrossVersionMaterial as designated by this palette.

Parameters:

material - Cannot be null.

Returns:

The byte representing the color as defined by MapPalette.

getColor

public java.awt.Color getColor(CrossVersionMaterial material)

Get the color of a CrossVersionMaterial as designated by this palette.

Parameters:

material - Cannot be null.

Returns:

An ARGB color.

getRGB

public int getRGB(CrossVersionMaterial material)

Get the integer color of a CrossVersionMaterial as designated by this palette.

Parameters:

material - Cannot be null.

Returns:

The default color if the material is listed as transparent, or if not found. Will attempt to get the color for the universal material of the CrossVersionMaterial provided if it exists. (Data value of -1)

setColor

public void setColor(CrossVersionMaterial material,
                     java.awt.Color color)

Set the color of a CrossVersionMaterial.

Parameters:

material - Cannot be null.

color - An ARGB color, cannot be null.

setColor

public void setColor(CrossVersionMaterial material,
                     int argb)

Set the color of a CrossVersionMaterial.

Parameters:

material - Cannot be null.

argb - An ARGB integer.

setDefaultColor

public void setDefaultColor(java.awt.Color color)

Set the default color.

Parameters:

color - An ARGB color, cannot be null.

getMaterials

public java.util.Set<CrossVersionMaterial> getMaterials()

Get the CrossVersionMaterial that are registered.

Returns:

A new set containing the CrossVersionMaterial.

getTransparentBlocks

public java.util.Set<CrossVersionMaterial> getTransparentBlocks()

Get the CrossVersionMaterial that are registered as transparent.

Returns:

The set of transparent CrossVersionMaterial for this palette.

addTransparentMaterial

public void addTransparentMaterial(CrossVersionMaterial material)

Add a CrossVersionMaterial as transparent.

Parameters:

material - Cannot be null.

isTransparent

public boolean isTransparent(CrossVersionMaterial material)

Check if the material is listed as transparent by this palette.

Parameters:

material - The CrossVersionMaterial to check.

Returns:

If the material is transparent as defined by this palette.

setDefaultColor

public void setDefaultColor(int argb)

Set the default color.

Parameters:

argb - An ARGB integer.

getDefaultColor

public java.awt.Color getDefaultColor()

Get the default color for this palette.

Returns:

An ARGB color.

getDefaultRGB

public int getDefaultRGB()

Get the default integer color for this palette.

Returns:

An ARGB integer.