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/**
037 *      An interface for classes that can transform data units into renderer units
038 *      based on the definition of the data axis in space.
039 *
040 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
041 *  @created 26 Jun 2013
042 *      @version $Author$, $Revision$, $Date$
043 *      @param <Q> Colour representation for the axis renderer
044 *      @param <D> The type of the data units
045 *      @param <U> The type of the converted units
046 */
047public interface DataUnitsTransformer<Q,D,U>
048{
049        /**
050         *      Force a precalculation of the variables required for
051         *      the pixel transformation.
052         */
053        public void precalc();
054
055        /**
056         *      For a given coordinate in the units of the data, will calculate
057         *      the render coordinates
058         * @param units The unit to convert to render coordinates
059         *
060         *      @return Render coordinates
061         */
062        public U calculatePosition( D units );
063
064        /**
065         *      Calculates the data unit coordinate at the given render coordinates
066         * @param position The data rendered position to convert
067         *
068         *      @return the data units on the given axis
069         */
070        public D calculateUnitsAt( U position );
071
072        /**
073         *      Given a specific data dimension, calculates a render dimension.
074         *
075         *      @param dimension The units/data dimension
076         *      @return The scaled dimension
077         */
078        public U scaleDimension( D dimension );
079}