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.

Method Summary

Modifier and Type	Method and Description
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.
static Mask	wrap(Mask mask) Wrap an old-style mask and convert it to a new mask.
static Mask	wrap(Mask mask) Convert a new-style mask to an old-style mask.
static Mask	wrap(Mask mask, EditSession editSession) Deprecated. Please avoid if possible

Methods inherited from class java.lang.Object

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

Method Detail

alwaysTrue

public static Mask alwaysTrue()

Return a 3D mask that always returns true;

Returns:

a mask

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

wrap

@Deprecated
public static Mask wrap(Mask mask,
                                    EditSession editSession)

Deprecated. Please avoid if possible

Wrap an old-style mask and convert it to a new mask.

Note, however, that this is strongly not recommended because Mask.prepare(LocalSession, LocalPlayer, Vector) is not called.

Parameters:

mask - the old-style mask

editSession - the edit session to bind to

Returns:

a new-style mask

wrap

public static Mask wrap(Mask mask)

Wrap an old-style mask and convert it to a new mask.

As an EditSession is not provided in this case, one will be taken from the Request, if possible. If not possible, then the mask will return false.

Parameters:

mask - the old-style mask

Returns:

a new-style mask

wrap

public static Mask wrap(Mask mask)

Convert a new-style mask to an old-style mask.

Parameters:

mask - the new-style mask

Returns:

an old-style mask