• Home
• org.pepsoft.worldpainter
• WPGUI
• 2.21.1
• source code
• RadiusOperation.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.pepsoft.worldpainter.operations.RadiusOperation Maven / Gradle / Ivy

/*
 * 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 .
 */

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */

package org.pepsoft.worldpainter.operations;

import jpen.PButton;
import jpen.PButtonEvent;
import jpen.PKind;
import jpen.PKindEvent;
import org.pepsoft.worldpainter.MapDragControl;
import org.pepsoft.worldpainter.RadiusControl;
import org.pepsoft.worldpainter.WorldPainterView;
import org.pepsoft.worldpainter.brushes.Brush;

import javax.swing.*;
import java.lang.reflect.InvocationTargetException;

/**
 * An operation which uses a brush to affect an area of the dimension.
 *
 * @author pepijn
 */
public abstract class RadiusOperation extends AbstractBrushOperation {
    /**
     * Create a new {@code RadiusOperation}.
     *
     * @param name The short name of the operation. May be displayed on the operation's tool button.
     * @param description A longer description of the operation. May be displayed to the user as a tooltip.
     * @param view The WorldPainter view through which the dimension that is being edited is being displayed and on
     *             which the operation should install its listeners to register user mouse, keyboard and tablet actions.
     * @param radiusControl An object through which the operation can change the size of the brush.
     * @param mapDragControl An object through which the operation can temporarily disable map panning by dragging the
     *                       mouse.
     * @param statisticsKey The key with which use of this operation will be logged in the usage data sent back to the
     *                      developer. Should start with a reverse-DNS style identifier, optionally followed by some
     *                      basic or fundamental setting, if it has one.
     */
    public RadiusOperation(String name, String description, WorldPainterView view, RadiusControl radiusControl, MapDragControl mapDragControl, String statisticsKey) {
        super(name, description, view, statisticsKey);
        this.radiusControl = radiusControl;
        this.mapDragControl = mapDragControl;
    }

    /**
     * Create a new {@code RadiusOperation}.
     *
     * @param name The short name of the operation. May be displayed on the operation's tool button.
     * @param description A longer description of the operation. May be displayed to the user as a tooltip.
     * @param view The WorldPainter view through which the dimension that is being edited is being displayed and on
     *             which the operation should install its listeners to register user mouse, keyboard and tablet actions.
     * @param radiusControl An object through which the operation can change the size of the brush.
     * @param mapDragControl An object through which the operation can temporarily disable map panning by dragging the
     *                       mouse.
     * @param statisticsKey The key with which use of this operation will be logged in the usage data sent back to the
     *                      developer. Should start with a reverse-DNS style identifier, optionally followed by some
     *                      basic or fundamental setting, if it has one.
     * @param iconName The base name of the icon for the operation.
     */
    public RadiusOperation(String name, String description, WorldPainterView view, RadiusControl radiusControl, MapDragControl mapDragControl, String statisticsKey, String iconName) {
        super(name, description, view, statisticsKey, iconName);
        this.radiusControl = radiusControl;
        this.mapDragControl = mapDragControl;
    }

    /**
     * Create a new {@code RadiusOperation}.
     *
     * @param name The short name of the operation. May be displayed on the operation's tool button.
     * @param description A longer description of the operation. May be displayed to the user as a tooltip.
     * @param view The WorldPainter view through which the dimension that is being edited is being displayed and on
     *             which the operation should install its listeners to register user mouse, keyboard and tablet actions.
     * @param radiusControl An object through which the operation can change the size of the brush.
     * @param mapDragControl An object through which the operation can temporarily disable map panning by dragging the
     *                       mouse.
     * @param delay The delay in ms between each invocation of {@link #tick(int, int, boolean, boolean, float)} while
     *              this operation is being applied by the user.
     * @param statisticsKey The key with which use of this operation will be logged in the usage data sent back to the
     *                      developer. Should start with a reverse-DNS style identifier, optionally followed by some
     *                      basic or fundamental setting, if it has one.
     */
    public RadiusOperation(String name, String description, WorldPainterView view, RadiusControl radiusControl, MapDragControl mapDragControl, int delay, String statisticsKey) {
        super(name, description, view, delay, statisticsKey);
        this.radiusControl = radiusControl;
        this.mapDragControl = mapDragControl;
    }

    /**
     * Create a new {@code RadiusOperation}.
     *
     * @param name The short name of the operation. May be displayed on the operation's tool button.
     * @param description A longer description of the operation. May be displayed to the user as a tooltip.
     * @param view The WorldPainter view through which the dimension that is being edited is being displayed and on
     *             which the operation should install its listeners to register user mouse, keyboard and tablet actions.
     * @param radiusControl An object through which the operation can change the size of the brush.
     * @param mapDragControl An object through which the operation can temporarily disable map panning by dragging the
     *                       mouse.
     * @param delay The delay in ms between each invocation of {@link #tick(int, int, boolean, boolean, float)} while
     *              this operation is being applied by the user.
     * @param statisticsKey The key with which use of this operation will be logged in the usage data sent back to the
     *                      developer. Should start with a reverse-DNS style identifier, optionally followed by some
     *                      basic or fundamental setting, if it has one.
     * @param iconName The base name of the icon for the operation.
     */
    public RadiusOperation(String name, String description, WorldPainterView view, RadiusControl radiusControl, MapDragControl mapDragControl, int delay, String statisticsKey, String iconName) {
        super(name, description, view, delay, statisticsKey, iconName);
        this.radiusControl = radiusControl;
        this.mapDragControl = mapDragControl;
    }

    public final int getEffectiveRadius() {
        return (getBrush() != null) ? getBrush().getEffectiveRadius() : radius;
    }

    public final void setRadius(int radius) {
        if (radius < 0) {
            throw new IllegalArgumentException();
        }
        this.radius = radius;
        final Brush brush = getBrush();
        if (brush != null) {
            brush.setRadius(radius);
            brushChanged(brush);
        }
    }

    public final float getStrength(int centerX, int centerY, int x, int y) {
        return filterEnabled
            ? filter.modifyStrength(x, y, getBrush().getStrength(x - centerX, y - centerY))
            : getBrush().getStrength(x - centerX, y - centerY);
    }

    public final float getFullStrength(int centerX, int centerY, int x, int y) {
        return filterEnabled
            ? filter.modifyStrength(x, y, getBrush().getFullStrength(x - centerX, y - centerY))
            : getBrush().getFullStrength(x - centerX, y - centerY);
    }
    
    @Override
    public void penKindEvent(PKindEvent pke) {
        final PKind.Type type = pke.kind.getType();
        if ((type != PKind.Type.ERASER) && (type != PKind.Type.STYLUS)) {
            SwingUtilities.invokeLater(() -> mapDragControl.setMapDraggingInhibited(false));
        }
        super.penKindEvent(pke);
    }
    
    @Override
    public void penButtonEvent(PButtonEvent pbe) {
        PKind.Type penKindType = pbe.pen.getKind().getType();
        final PButton.Type buttonType = pbe.button.getType();
        if (pbe.button.value
                && ((penKindType == PKind.Type.STYLUS) || (penKindType == PKind.Type.ERASER))
                && ((buttonType == PButton.Type.CENTER) || (buttonType == PButton.Type.RIGHT))) {
            try {
                SwingUtilities.invokeAndWait(() -> {
                    // Stylus button pressed
                    if (buttonType == PButton.Type.CENTER) {
                        radiusControl.decreaseRadius(1);
                    } else {
                        radiusControl.increaseRadius(1);
                    }
                    // It should not be too late to do this, since this
                    // event is being dispatched synchronously:
                    if (! mapDragControl.isMapDraggingInhibited()) {
                        mapDragControl.setMapDraggingInhibited(true);
                    }
                });
            } catch (InterruptedException e) {
                throw new RuntimeException("Thread interrupted while processing radius event", e);
            } catch (InvocationTargetException e) {
                throw new RuntimeException("Exception thrown while processing radius event", e);
            }
        } else {
            super.penButtonEvent(pbe);
        }
    }

    public Filter getFilter() {
        return filter;
    }

    public void setFilter(Filter filter) {
        this.filter = filter;
        filterEnabled = (filter != null);
    }

    @Override
    protected void deactivate() {
        mapDragControl.setMapDraggingInhibited(false);
        super.deactivate();
    }

    protected void brushChanged(Brush newBrush) {
        super.brushChanged(newBrush);
        if (newBrush != null) {
            newBrush.setRadius(radius);
        }
    }

    private final RadiusControl radiusControl;
    private final MapDragControl mapDragControl;
    private int radius;
    private boolean filterEnabled;
    private Filter filter = null;
}