org.pepsoft.worldpainter.painting.Paint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of WPGUI Show documentation

There is a newer version: 2.23.2

/*
 * WorldPainter, a graphical and interactive map generator for Minecraft.
 * Copyright © 2011-2015  pepsoft.org, The Netherlands
 *
 * 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 org.pepsoft.worldpainter.painting;

import org.pepsoft.worldpainter.ColourScheme;
import org.pepsoft.worldpainter.Dimension;
import org.pepsoft.worldpainter.brushes.Brush;
import org.pepsoft.worldpainter.operations.Filter;

import java.awt.image.BufferedImage;

/**
 * Some basic and fully configured paint operation which can be applied to a dimension.
 *
 * Created by pepijn on 15-05-15.
 */
public interface Paint {
    /**
     * Get the stable and unique ID of this paint.
     */
    String getId();

    Brush getBrush();

    void setBrush(Brush brush);

    Filter getFilter();

    void setFilter(Filter filter);

    boolean isDither();

    void setDither(boolean dither);

    void apply(Dimension dimension, int x, int y, float dynamicLevel);

    void remove(Dimension dimension, int x, int y, float dynamicLevel);

    void applyPixel(Dimension dimension, int x, int y);

    void removePixel(Dimension dimension, int x, int y);

    BufferedImage getIcon(ColourScheme colourScheme);
}