io.github.bananapuncher714.cartographer.core.api

Class WorldPixel

java.lang.Object

io.github.bananapuncher714.cartographer.core.api.WorldPixel

All Implemented Interfaces:

java.lang.Comparable<WorldPixel>

public class WorldPixel
extends java.lang.Object
implements java.lang.Comparable<WorldPixel>

Represents a region of the Minecraft world to shade.

Author:

BananaPuncher714

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Color	color An ARGB color representing the color of this region.
protected org.bukkit.Location	location The location of the minimum corner, with the priority representing the y value.
protected double	priority The priority ordering from 0 to 0xFFFFFF.
protected org.bukkit.World	world The world that this pixel is in.
protected double	x The minimum x and z coordinates of the region.
protected double	z The minimum x and z coordinates of the region.

Constructor Summary

Constructors

Constructor and Description
WorldPixel(org.bukkit.Location location, java.awt.Color color) Construct a WorldPixel with the color and location provided.
WorldPixel(org.bukkit.World world, double x, double z, java.awt.Color color) Construct a WorldPixel with the arguments provided.

Method Summary

Modifier and Type	Method and Description
int	compareTo(WorldPixel other)
java.awt.Color	getColor() Get the color of this pixel.
double	getHeight() Get the height.
org.bukkit.Location	getLocation() Get the minimum location for this pixel.
double	getPriority() Get the priority.
double	getWidth() Get the width.
org.bukkit.World	getWorld() Get the world.
double	getX() Get the minimum x coordinate.
double	getZ() Get the minimum z coordinate.
boolean	intersects(double x, double z) Check if this region intersects with the coordinates provided.
void	setColor(java.awt.Color color) Set the color of this pixel.
void	setHeight(double height) Set the height.
void	setLocation(org.bukkit.Location location) Set the minimum location for this pixel.
void	setPriority(double y) Set the priority.
void	setWidth(double width) Set the width.
void	setWorld(org.bukkit.World world) Set the world.
void	setX(double x) Set the minimum x coordinate.
void	setZ(double z) Set the minimum z coordinate.

Methods inherited from class java.lang.Object

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

Field Detail

world

protected org.bukkit.World world

The world that this pixel is in.

x

protected double x

The minimum x and z coordinates of the region.

z

protected double z

The minimum x and z coordinates of the region.

priority

protected double priority

The priority ordering from 0 to 0xFFFFFF. Lower values mean they appear behind other pixels of greater priority.

location

protected org.bukkit.Location location

The location of the minimum corner, with the priority representing the y value.

color

protected java.awt.Color color

An ARGB color representing the color of this region.

Constructor Detail

WorldPixel

public WorldPixel(org.bukkit.Location location,
                  java.awt.Color color)

Construct a WorldPixel with the color and location provided.

Parameters:

location - The y value will be used as the priority. Cannot be null.

color - The color of the region, cannot be null.

WorldPixel

public WorldPixel(org.bukkit.World world,
                  double x,
                  double z,
                  java.awt.Color color)

Construct a WorldPixel with the arguments provided.

Parameters:

world - The world of the pixel, cannot be null.

x - The x coordinate of the pixel.

z - The z coordinate of the pixel.

color - The color of the region, cannot be null.

Method Detail

intersects

public boolean intersects(double x,
                          double z)

Check if this region intersects with the coordinates provided.

Parameters:

x - The x coordinate.

z - The z coordinate.

Returns:

If the coordinate falls within or on the edge of this WorldPixel.

getWorld

public org.bukkit.World getWorld()

Get the world.

Returns:

Will not be null.

setWorld

public void setWorld(org.bukkit.World world)

Set the world.

Parameters:

world - Cannot be null.

getX

public double getX()

Get the minimum x coordinate.

Returns:

The x coordinate.

setX

public void setX(double x)

Set the minimum x coordinate.

Parameters:

x - The x coordinate.

getWidth

public double getWidth()

Get the width.

Returns:

Should not be 0.

setWidth

public void setWidth(double width)

Set the width.

Parameters:

width - Should not be 0.

getHeight

public double getHeight()

Get the height.

Returns:

Should not be 0.

setHeight

public void setHeight(double height)

Set the height.

Parameters:

height - Should not be 0.

getPriority

public double getPriority()

Get the priority. Higher values means it will be drawn higher up than other pixels.

Returns:

The priority.

setPriority

public void setPriority(double y)

Set the priority. Higher values means it will be drawn higher up than other pixels.

Parameters:

y - The priority.

getZ

public double getZ()

Get the minimum z coordinate.

Returns:

The z coordinate.

setZ

public void setZ(double z)

Set the minimum z coordinate.

Parameters:

z - The z coordinate.

getLocation

public org.bukkit.Location getLocation()

Get the minimum location for this pixel.

Returns:

Will not be null.

setLocation

public void setLocation(org.bukkit.Location location)

Set the minimum location for this pixel.

Parameters:

location - Cannot be null. Does not set priority.

getColor

public java.awt.Color getColor()

Get the color of this pixel.

Returns:

An ARGB color.

setColor

public void setColor(java.awt.Color color)

Set the color of this pixel.

Parameters:

color - An ARGB color, cannot be null.

compareTo

public int compareTo(WorldPixel other)

Specified by:

compareTo in interface java.lang.Comparable<WorldPixel>