it.unibo.alchemist.boundary.swingui.effect.api.Effect Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2010-2022, Danilo Pianini and contributors
 * listed, for each module, in the respective subproject's build.gradle.kts file.
 *
 * This file is part of Alchemist, and is distributed under the terms of the
 * GNU General Public License, with a linking exception,
 * as described in the file LICENSE in the Alchemist distribution's top directory.
 */
package it.unibo.alchemist.boundary.swingui.effect.api;

import it.unibo.alchemist.boundary.ui.api.Wormhole2D;
import it.unibo.alchemist.model.Environment;
import it.unibo.alchemist.model.Node;
import it.unibo.alchemist.model.Position2D;

import java.awt.Color;
import java.awt.Graphics2D;
import java.awt.Point;
import java.io.Serializable;


/**
 */
@Deprecated
public interface Effect extends Serializable {

    /**
     * Applies the effect.
     * 
     * @param graphic
     *            Graphics2D to use
     * @param node
     *            the node to draw
     * @param x
     *            x screen position
     * @param y
     *            y screen position
     * @deprecated use {@link #apply(Graphics2D, Node, Environment, Wormhole2D)} instead.
     */
    @Deprecated
    default void apply(final Graphics2D graphic, final Node node, final int x, final int y) {
        // deprecated, defaults to nothing.
    }

    /**
     * Applies the effect.
     *
     * @param       concentration type
     * @param       position type
     * @param g        graphics
     * @param n        node
     * @param environment      environment
     * @param wormhole the wormhole used to map environment's coords to screen coords
     */
    @SuppressWarnings("deprecation")
    default > void apply(
            final Graphics2D g,
            final Node n,
            final Environment environment,
            final Wormhole2D wormhole
    ) {
        final Point viewPoint = wormhole.getViewPoint(environment.getPosition(n));
        apply(g, n, viewPoint.x, viewPoint.y); // preserve backward compatibility
    }

    /**
     * @return a color which resembles the color of this effect
     */
    Color getColorSummary();

    @Override // Should override hashCode() method
    int hashCode();

    @Override // Should override equals() method
    boolean equals(Object obj);
}