com.sk89q.worldedit.function.mask.Masks Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of FastAsyncWorldEdit-Core Show documentation
Blazingly fast Minecraft world manipulation for artists, builders and everyone else.
There is a newer version: 2.9.2
Show newest version
/*
 * WorldEdit, a Minecraft world manipulation toolkit
 * Copyright (C) sk89q 
 * Copyright (C) WorldEdit team and contributors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package com.sk89q.worldedit.function.mask;

import com.sk89q.worldedit.math.BlockVector2;
import com.sk89q.worldedit.math.BlockVector3;

import javax.annotation.Nullable;

import static com.google.common.base.Preconditions.checkNotNull;

/**
 * Various utility functions related to {@link Mask} and {@link Mask2D}.
 */
public final class Masks {

    static final AlwaysTrue ALWAYS_TRUE = new AlwaysTrue();
    static final AlwaysFalse ALWAYS_FALSE = new AlwaysFalse();

    private Masks() {
    }

    /**
     * Return a 3D mask that always returns true.
     *
     * @return a mask
     */
    public static Mask alwaysTrue() {
        return ALWAYS_TRUE;
    }

    //FAWE start
    public static Mask alwaysFalse() {
        return ALWAYS_FALSE;
    }
    //FAWE end

    /**
     * Return a 2D mask that always returns true.
     *
     * @return a mask
     */
    public static Mask2D alwaysTrue2D() {
        return ALWAYS_TRUE;
    }

    //FAWE start

    /**
     * Negate the given mask.
     *
     * @param mask the mask
     * @return a new mask
     */
    public static Mask negate(final Mask mask) {
        return mask.inverse();
    }
    //FAWE end

    /**
     * Negate the given mask.
     *
     * @param mask the mask
     * @return a new mask
     */
    public static Mask2D negate(final Mask2D mask) {
        if (mask instanceof AlwaysTrue) {
            return ALWAYS_FALSE;
        } else if (mask instanceof AlwaysFalse) {
            return ALWAYS_TRUE;
        } else if (mask instanceof NegatedMask2D) {
            return ((NegatedMask2D) mask).mask;
        }

        checkNotNull(mask);
        return new NegatedMask2D(mask);
    }

    /**
     * Return a 3-dimensional version of a 2D mask.
     *
     * @param mask the mask to make 3D
     * @return a 3D mask
     */
    public static Mask asMask(final Mask2D mask) {
        return new AbstractMask() {
            @Override
            public boolean test(BlockVector3 vector) {
                return mask.test(vector.toBlockVector2());
            }

            @Nullable
            @Override
            public Mask2D toMask2D() {
                return mask;
            }

            @Override
            public Mask copy() {
                return Masks.asMask(mask.copy2D());
            }
        };
    }

    //FAWE start - protected > private
    protected static class AlwaysTrue implements Mask, Mask2D {

        //FAWE end
        @Override
        public boolean test(BlockVector3 vector) {
            return true;
        }

        @Override
        public boolean test(BlockVector2 vector) {
            return true;
        }

        @Nullable
        @Override
        public Mask2D toMask2D() {
            return this;
        }

        //FAWE start
        @Override
        public Mask tryCombine(Mask other) {
            return other;
        }

        @Override
        public Mask tryOr(Mask other) {
            return this;
        }

        // No need to properly clone an always true mask
        @Override
        public Mask copy() {
            return new AlwaysTrue();
        }

        // No need to properly clone an always true mask
        @Override
        public Mask2D copy2D() {
            return new AlwaysTrue();
        }
        //FAWE end

    }

    //FAWE start - protected > private
    protected static class AlwaysFalse implements Mask, Mask2D {

        //FAWE end
        @Override
        public boolean test(BlockVector3 vector) {
            return false;
        }

        @Override
        public boolean test(BlockVector2 vector) {
            return false;
        }

        @Nullable
        @Override
        public Mask2D toMask2D() {
            return this;
        }

        //FAWE start
        @Override
        public Mask tryCombine(Mask other) {
            return this;
        }

        @Override
        public Mask tryOr(Mask other) {
            return other;
        }

        // No need to properly clone an always false mask
        @Override
        public Mask copy() {
            return new AlwaysFalse();
        }

        // No need to properly clone an always true mask
        @Override
        public Mask2D copy2D() {
            return new AlwaysFalse();
        }
        //FAWE end

    }

    //FAWE start - protected > private
    protected static class NegatedMask implements Mask {

        //FAWE end
        protected final Mask mask;

        private NegatedMask(Mask mask) {
            this.mask = mask;
        }

        @Override
        public boolean test(BlockVector3 vector) {
            return !mask.test(vector);
        }

        @Nullable
        @Override
        public Mask2D toMask2D() {
            Mask2D mask2D = mask.toMask2D();
            if (mask2D == null) {
                return null;
            }
            return negate(mask2D);
        }

        //FAWE start
        @Override
        public Mask copy() {
            return Masks.negate(mask.copy());
        }
        //FAWE end

    }

    private static class NegatedMask2D implements Mask2D {

        private final Mask2D mask;

        private NegatedMask2D(Mask2D mask) {
            this.mask = mask;
        }

        @Override
        public boolean test(BlockVector2 vector) {
            return !mask.test(vector);
        }

        //FAWE start
        @Override
        public Mask2D copy2D() {
            return Masks.negate(mask.copy2D());
        }
        //FAWE end

    }

}