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;
034
035import java.awt.Dimension;
036
037import org.openimaj.image.MBFImage;
038
039/**
040 *      An interface for objects that can provide a static image of a visualisation
041 *      through the {@link #getVisualisationImage()}. If you need to force a redraw
042 *      (or an initial draw) of the visualisation, you may call {@link #updateVis()}.
043 *
044 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
045 *  @created 25 Jun 2013
046 *      @version $Author$, $Revision$, $Date$
047 */
048public interface VisualisationImageProvider
049{
050        /**
051         *      Force a redraw of the visualisation image.
052         */
053        public void updateVis();
054
055        /**
056         *      Return the static visualisation image.
057         *      @return The visualisation image.
058         */
059        public MBFImage getVisualisationImage();
060
061        /**
062         *      Set the required size of the visualisation image.
063         *      @param d The dimensions
064         */
065        public void setRequiredSize( Dimension d );
066}