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.timeline;
034
035import java.awt.Dimension;
036
037import org.openimaj.vis.DataUnitsTransformer;
038import org.openimaj.vis.VisualisationImageProvider;
039
040/**
041 *      An object that can be drawn into a timeline needs to be able to provide
042 *      the start and end time of its data, and also be able to accept a size
043 *      at which it should draw itself. The object should draw itself in the
044 *      given image size with the start and end times fitting in the image exactly.
045 *      This allows the {@link Timeline} visualisation to scale the object as necessary
046 *      and allow it to align with the time ruler.
047 *
048 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
049 *  @created 19 Jun 2013
050 *      @version $Author$, $Revision$, $Date$
051 */
052public interface TimelineObject extends VisualisationImageProvider
053{
054        /**
055         *      The timeline object will need to know how to convert between
056         *      time and pixels, and the {@link DataUnitsTransformer} given here
057         *      should be able to do that. Use it to paint the image.
058         *      @param dpt
059         */
060        public void setDataPixelTransformer( DataUnitsTransformer<Float[],double[],int[]> dpt );
061
062        /**
063         *      Returns the start time of the timeline object in the timeline.
064         *      @return The start time
065         */
066        public long getStartTimeMilliseconds();
067
068        /**
069         *      Set the start time of this object
070         *      @param l The start time in milliseconds
071         */
072        public void setStartTimeMilliseconds( long l );
073
074        /**
075         *      Returns the end time of the timeline object in the timeline.
076         *      @return The end time.
077         */
078        public long getEndTimeMilliseconds();
079
080        /**
081         *      The timeline object needs to be able to suggest a size, if it
082         *      needs a particular amount. It's not guaranteed it will get this size,
083         *      but it may ask for it by implementing this method.
084         *      @return A {@link Dimension}
085         */
086        public Dimension getPreferredSize();
087
088        /**
089         *      Returns the size that this object wishes to be.
090         *      @return The size the object wishes to be.
091         */
092        public Dimension getRequiredSize();
093}