[deliverable/tracecompass.git] / org.eclipse.tracecompass.tmf.ui / src / org / eclipse / tracecompass / tmf / ui / widgets / timegraph / widgets / ITmfTimeGraphDrawingHelper.java

/*******************************************************************************
 * Copyright (c) 2013, 2014 École Polytechnique de Montréal
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Geneviève Bastien - Initial API and implementation
 *******************************************************************************/

package org.eclipse.tracecompass.tmf.ui.widgets.timegraph.widgets;

/**
 * This interface provides functions to convert a model element to a drawing
 * element and vice versa.
 *
 * Views who implement this interface allow access to some model-to-canvas and
 * vice-versa functions without having to expose their full functionnalities.
 *
 * @author gbastien
 */
public interface ITmfTimeGraphDrawingHelper {

    /**
     * Return the x coordinate corresponding to a time
     *
     * @param time
     *            the time
     * @return the x coordinate corresponding to the time
     */
    int getXForTime(long time);

    /**
     * Return the time corresponding to an x coordinate
     *
     * @param x
     *            the x coordinate
     * @return the time corresponding to the x coordinate
     */
    long getTimeAtX(int x);
}
Commit	Line	Data
4999a196	1	/*******************************************************************************
ed902a2b	2	* Copyright (c) 2013, 2014 École Polytechnique de Montréal
4999a196 GB	3	*
	4	* All rights reserved. This program and the accompanying materials are
	5	* made available under the terms of the Eclipse Public License v1.0 which
	6	* accompanies this distribution, and is available at
	7	* http://www.eclipse.org/legal/epl-v10.html
	8	*
	9	* Contributors:
	10	* Geneviève Bastien - Initial API and implementation
	11	*******************************************************************************/
	12
2bdf0193	13	package org.eclipse.tracecompass.tmf.ui.widgets.timegraph.widgets;
4999a196 GB	14
	15	/**
	16	* This interface provides functions to convert a model element to a drawing
	17	* element and vice versa.
	18	*
	19	* Views who implement this interface allow access to some model-to-canvas and
	20	* vice-versa functions without having to expose their full functionnalities.
	21	*
	22	* @author gbastien
4999a196 GB	23	*/
	24	public interface ITmfTimeGraphDrawingHelper {
	25
	26	/**
	27	* Return the x coordinate corresponding to a time
	28	*
	29	* @param time
	30	* the time
	31	* @return the x coordinate corresponding to the time
	32	*/
	33	int getXForTime(long time);
	34
	35	/**
	36	* Return the time corresponding to an x coordinate
	37	*
	38	* @param x
	39	* the x coordinate
	40	* @return the time corresponding to the x coordinate
	41	*/
	42	long getTimeAtX(int x);
	43	}