io.jbotsim.ui.painting.BackgroundPainter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jbotsim-ui-common Show documentation

Platform-independent UI classes for JBotSim.

There is a newer version: 1.2.0

/*
 * Copyright 2008 - 2019, Arnaud Casteigts and the JBotSim contributors 
 *
 *
 * This file is part of JBotSim.
 *
 * JBotSim is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JBotSim 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with JBotSim.  If not, see .
 *
 */
package io.jbotsim.ui.painting;

import io.jbotsim.core.Topology;

/**
 * The {@link BackgroundPainter} is an element which is used to be called while trying to draw a background.
 */
public interface BackgroundPainter {
    /**
     * Provides a way to draw things on the background.
     *
     * @param uiComponent the graphical object to be drawn on.
     * @param tp the {@link Topology} to pick information from.
     */
    void paintBackground(UIComponent uiComponent, Topology tp);
}