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
035/**
036 *      An interface for objects that want to listen for animation events
037 *      from an {@link AnimatedVisualisationProvider}. The object must implement the callback
038 *      method that animated visualisations will call when they are ready
039 *      to provide an update. It is not necessary that the provider actually
040 *      produce the visualisation before calling this callback, simply that
041 *      the animation is proceeding and should the listener wish they may
042 *      call the {@link VisualisationImageProvider#updateVis()} method and
043 *      then the {@link VisualisationImageProvider#getVisualisationImage()} method
044 *      to retrieve the latest image.
045 *
046 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
047 *  @created 25 Jun 2013
048 *      @version $Author$, $Revision$, $Date$
049 */
050public interface AnimatedVisualisationListener
051{
052        /**
053         *      Called by the {@link AnimatedVisualisationProvider} when
054         *      a new visualisation is available to drawn (but hasn't been
055         *      drawn yet).
056         *      @param avp The source of the event
057         */
058        public void newVisualisationAvailable( AnimatedVisualisationProvider avp );
059}