Package com.sk89q.worldedit.function.mask

Class Masks

java.lang.Object

com.sk89q.worldedit.function.mask.Masks

public final class Masks
extends Object

Various utility functions related to Mask and Mask2D.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	Masks.AlwaysFalse
protected static class	Masks.AlwaysTrue
protected static final record	Masks.NegatedMask

Method Summary

Modifier and Type	Method	Description
static Mask	alwaysFalse()
static Mask	alwaysTrue()	Return a 3D mask that always returns true.
static Mask2D	alwaysTrue2D()	Return a 2D mask that always returns true.
static Mask	asMask(Mask2D mask)	Return a 3-dimensional version of a 2D mask.
static Mask	negate(Mask mask)	Negate the given mask.
static Mask2D	negate(Mask2D mask)	Negate the given mask.

Methods inherited from class java.lang.Object

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

Method Details

alwaysTrue

public static Mask alwaysTrue()

Return a 3D mask that always returns true.

Returns:

a mask

alwaysFalse

public static Mask alwaysFalse()

alwaysTrue2D

public static Mask2D alwaysTrue2D()

Return a 2D mask that always returns true.

Returns:

a mask

negate

public static Mask negate(Mask mask)

Negate the given mask.

Parameters:

mask - the mask

Returns:

a new mask

negate

public static Mask2D negate(Mask2D mask)

Negate the given mask.

Parameters:

mask - the mask

Returns:

a new mask

asMask

public static Mask asMask(Mask2D mask)

Return a 3-dimensional version of a 2D mask.

Parameters:

mask - the mask to make 3D

Returns:

a 3D mask