001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030/**
031 *
032 */
033package org.openimaj.vis.general;
034
035import org.openimaj.image.Image;
036import org.openimaj.vis.general.XYPlotVisualisation.LocatedObject;
037
038/**
039 *      An interface for classes that are able to plot items into a visualisation
040 *      using an {@link AxesRenderer2D} to determine the position.
041 *
042 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
043 *      @param <O> The type of object to be plotted
044 *      @param <Q> The type of pixel that the image needs to be
045 *      @param <I> The type of image being plotted to
046 *  @created 3 Jun 2013
047 */
048public interface ItemPlotter<O,Q,I extends Image<Q,I>>
049{
050        /**
051         *      Called just before a render of the visualisation is about to start.
052         *      This can be used to prepare context objects for the plotObject method.
053         */
054        public abstract void renderRestarting();
055
056        /**
057         *      Plots a specific object to the visualisation using the {@link AxesRenderer2D} to
058         *      provide the position of the object. Should side affect the given image.
059         *
060         *      @param visImage The image to draw to
061         *      @param object The object
062         *      @param renderer The axes renderer
063         */
064        public abstract void plotObject( I visImage,
065                        LocatedObject<O> object, AxesRenderer2D<Q,I> renderer );
066}