/*
 * WorldEdit, a Minecraft world manipulation toolkit
 * Copyright (C) sk89q <http://www.sk89q.com>
 * 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 <https://www.gnu.org/licenses/>.
 */

package com.sk89q.worldedit.function.visitor;

import com.sk89q.worldedit.extent.Extent;
import com.sk89q.worldedit.function.RegionFunction;
import com.sk89q.worldedit.function.mask.Mask;
import com.sk89q.worldedit.math.BlockVector3;

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

/**
 * An implementation of an {@link BreadthFirstSearch} that uses a mask to
 * determine where a block should be visited.
 */
public class RecursiveVisitor extends BreadthFirstSearch {

    private final Mask mask;

    /**
     * Create a new recursive visitor.
     *
     * @param mask     the mask
     * @param function the function
     */
    public RecursiveVisitor(Mask mask, RegionFunction function) {
        this(mask, function, Integer.MAX_VALUE, 0, 255, null);
        //FAWE end
    }

    //FAWE start - int depth, min/max y

    /**
     * Create a new recursive visitor.
     *
     * @param mask     the mask
     * @param function the function
     * @param maxDepth the maximum number of iterations
     * @param minY     minimum allowable y to visit. Inclusive.
     * @param maxY     maximum allowable y to visit. Inclusive.
     */
    public RecursiveVisitor(Mask mask, RegionFunction function, int maxDepth, int minY, int maxY) {
        this(mask, function, maxDepth, minY, maxY, null);
    }

    //FAWE start - int depth, min/max y

    /**
     * Create a new recursive visitor.
     *
     * @param mask     the mask
     * @param function the function
     * @param maxDepth the maximum number of iterations
     * @param minY     minimum allowable y to visit. Inclusive.
     * @param maxY     maximum allowable y to visit. Inclusive.
     * @param extent   the extent for preloading
     */
    public RecursiveVisitor(Mask mask, RegionFunction function, int maxDepth, int minY, int maxY, Extent extent) {
        super(function, maxDepth, minY, maxY, extent);
        checkNotNull(mask);
        this.mask = mask;
    }
    //FAWE end

    @Override
    protected boolean isVisitable(BlockVector3 from, BlockVector3 to) {
        return mask.test(to);
    }

}
