Enum Class Layer

java.lang.Object

java.lang.Enum<Layer>

org.openpatch.scratch.Layer

All Implemented Interfaces:

Serializable, Comparable<Layer>, Constable

public enum Layer
extends Enum<Layer>

One of the four layers a stage draws, from back to front, after its backdrop.

Every layer holds sprites, in Scratch's order within the layer (goToFrontLayer() means the front of the sprite's own layer), and a canvas for pen strokes and stamps, created when a pen or stamp first uses it. Sprites, texts and pens are in MAIN unless they are moved with setLayer; a pen draws onto the canvas of its own layer, which for a sprite's pen is BACKGROUND, behind the sprites, as in Scratch.

this.setLayer(Layer.FOREGROUND);

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BACKGROUND	Behind the sprites of MAIN: scenery, and where pens draw by default.
FOREGROUND	In front of the sprites of MAIN.
MAIN	Where sprites are unless they are moved.
UI	In front of everything and unaffected by the camera: buttons, scores, menus.

Method Summary

Modifier and Type	Method	Description
static Layer	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Layer[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BACKGROUND

public static final Layer BACKGROUND

Behind the sprites of MAIN: scenery, and where pens draw by default.

MAIN

public static final Layer MAIN

Where sprites are unless they are moved.

FOREGROUND

public static final Layer FOREGROUND

In front of the sprites of MAIN.

UI

public static final Layer UI

In front of everything and unaffected by the camera: buttons, scores, menus. Drawn at the window's resolution, so it stays sharp. Colour sensing and isTouchingSprite between the world and the UI ignore it.

Method Details

values

public static Layer[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Layer valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null