io.github.bananapuncher714.cartographer.core.api

Enum ZoomScale

java.lang.Object

java.lang.Enum<ZoomScale>

io.github.bananapuncher714.cartographer.core.api.ZoomScale

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ZoomScale>

Deprecated.

public enum ZoomScale
extends java.lang.Enum<ZoomScale>

Zoom scales for the map renderer. More scales may be added in the future. TODO Make this not an enum, and let maps freely assign whatever scales they want

Author:

BananaPuncher714

Enum Constant Summary

Enum Constants

Enum Constant and Description
EIGHT Deprecated.
EIGHTH Deprecated.
FOUR Deprecated.
FOURTH Deprecated.
HALF Deprecated.
ONE Deprecated.
SIXTEEN Deprecated.
SIXTEENTH Deprecated.
SIXTY_FOURTH Deprecated.
THIRTY_SECONDTH Deprecated.
TWO Deprecated.

Method Summary

Modifier and Type	Method and Description
double	getBlocksPerPixel() Deprecated. The amount of blocks per pixel that would be shown on the Minimap.
static ZoomScale	getScale(double scale) Deprecated. Get the closest ZoomScale to the value provided.
static ZoomScale	getScaleFromBukkit(org.bukkit.map.MapView.Scale scale) Deprecated. Convert Bukkit's map scaling to a zoom scale.
boolean	isLeastZoomed() Deprecated. Check if the zoom scale is the most zoomed out.
boolean	isMostZoomed() Deprecated. Check if the zoom scale is the most zoomed in.
ZoomScale	unzoom(boolean circular) Deprecated. Get the next ZoomScale.
static ZoomScale	valueOf(java.lang.String name) Deprecated. Returns the enum constant of this type with the specified name.
static ZoomScale[]	values() Deprecated. Returns an array containing the constants of this enum type, in the order they are declared.
ZoomScale	zoom(boolean circular) Deprecated. Get the previous ZoomScale.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SIXTY_FOURTH

public static final ZoomScale SIXTY_FOURTH

Deprecated.

THIRTY_SECONDTH

public static final ZoomScale THIRTY_SECONDTH

Deprecated.

SIXTEENTH

public static final ZoomScale SIXTEENTH

Deprecated.

EIGHTH

public static final ZoomScale EIGHTH

Deprecated.

FOURTH

public static final ZoomScale FOURTH

Deprecated.

HALF

public static final ZoomScale HALF

Deprecated.

ONE

public static final ZoomScale ONE

Deprecated.

TWO

public static final ZoomScale TWO

Deprecated.

FOUR

public static final ZoomScale FOUR

Deprecated.

EIGHT

public static final ZoomScale EIGHT

Deprecated.

SIXTEEN

public static final ZoomScale SIXTEEN

Deprecated.

Method Detail

values

public static ZoomScale[] values()

Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ZoomScale c : ZoomScale.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ZoomScale valueOf(java.lang.String name)

Deprecated.

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getBlocksPerPixel

public double getBlocksPerPixel()

Deprecated.

The amount of blocks per pixel that would be shown on the Minimap.

Returns:

The amount of blocks that would be required to equal the width of a pixel.

zoom

public ZoomScale zoom(boolean circular)

Deprecated.

Get the previous ZoomScale.

Parameters:

circular - Whether or not to wrap around from the end of the ZoomScale list.

Returns:

Will return the same ZoomScale if not circular and has reached the end of the list.

unzoom

public ZoomScale unzoom(boolean circular)

Deprecated.

Get the next ZoomScale.

Parameters:

circular - Whether or not to wrap around from the beginning of the ZoomScale list.

Returns:

Will return the same ZoomScale if not circular and has reached the end of the list.

getScale

public static ZoomScale getScale(double scale)

Deprecated.

Get the closest ZoomScale to the value provided.

Parameters:

scale - Scale in blocks-per-pixel.

Returns:

The closest ZoomScale, may be larger or lower than the scale provided.

isLeastZoomed

public boolean isLeastZoomed()

Deprecated.

Check if the zoom scale is the most zoomed out.

Returns:

If the blocks per pixel is the largest value.

isMostZoomed

public boolean isMostZoomed()

Deprecated.

Check if the zoom scale is the most zoomed in.

Returns:

If the blocks per pixel is smallest value.

getScaleFromBukkit

public static ZoomScale getScaleFromBukkit(org.bukkit.map.MapView.Scale scale)

Deprecated.

Convert Bukkit's map scaling to a zoom scale.

Parameters:

scale - Minecraft's default map scaling

Returns:

Returns ZoomScale.ONE by default.