/***************************************************************************
 * Copyright (C) gempa GmbH                                                *
 * All rights reserved.                                                    *
 * Contact: gempa GmbH (seiscomp-dev@gempa.de)                             *
 *                                                                         *
 * GNU Affero General Public License Usage                                 *
 * This file may be used under the terms of the GNU Affero                 *
 * Public License version 3.0 as published by the Free Software Foundation *
 * and appearing in the file LICENSE included in the packaging of this     *
 * file. Please review the following information to ensure the GNU Affero  *
 * Public License version 3.0 requirements will be met:                    *
 * https://www.gnu.org/licenses/agpl-3.0.html.                             *
 *                                                                         *
 * Other Usage                                                             *
 * Alternatively, this file may be used in accordance with the terms and   *
 * conditions contained in a signed written agreement between you and      *
 * gempa GmbH.                                                             *
 ***************************************************************************/


#ifndef SEISCOMP_GUI_PLOT_PLOT_H
#define SEISCOMP_GUI_PLOT_PLOT_H


#include <QObject>
#include <QPoint>

#include <seiscomp/gui/qt.h>
#include <seiscomp/gui/plot/axis.h>


class QRect;
class QPainter;


namespace Seiscomp {
namespace Gui {


class Graph;
class AbstractLegend;


class SC_GUI_API Plot : public QObject {
	// ----------------------------------------------------------------------
	//  X'truction
	// ----------------------------------------------------------------------
	public:
		//! C'tor
		Plot(QObject *parent=0);


	// ----------------------------------------------------------------------
	//  Public interface
	// ----------------------------------------------------------------------
	public:
		/**
		 * @brief Adds a graph to the plot. The graph is managed by the plot.
		 * @param keyAxis The axis to use for keys. If nullptr is passed then
		 *                the default xAxis is being used.
		 * @param valueAxis The axis to use for values. If nullptr is passed then
		 *                  the default yAxis is being used.
		 * @return The graph pointer or nullptr in case of error.
		 */
		Graph *addGraph(Axis *keyAxis = nullptr, Axis *valueAxis = nullptr);

		/**
		 * @brief Adds a graph instance to the plot. This function was added
		 *        with API version 11.0.0.
		 * @param graph The graph instance. The ownership is transferred to
		 *              the plot.
		 */
		void addGraph(Graph *graph);

		/**
		 * @brief Adds an additional plot axis. This method was added with
		 *        API 12.
		 * @param position The position of the new axis
		 * @return The axis instance which is a child of this plot
		 */
		Axis *addAxis(Axis::AxisPosition position);

		/**
		 * @brief Sets a legend instance for which the draw method is called
		 *        at every plot update. This function was added with API
		 *        version 11.0.0.
		 * @param legend The legend instance. The ownership goes to the plot.
		 */
		void setLegend(AbstractLegend *legend);

		/**
		 * @brief Updates all axis ranges according to the bounds of the
		 *        attached graphs.
		 */
		void updateRanges();

		/**
		 * @brief Renders the plot into the given rect
		 * @param painter The painter used to draw the plot
		 * @param rect The target rectangle in screen coordinates
		 */
		void draw(QPainter &painter, const QRect &rect);

		/**
		 * @brief Checks whether point is inside the plot area. This function
		 *        was added with API version 11.0.0.
		 * @param p The point in pixels
		 * @return true if inside, false otherwise
		 */
		bool isInsidePlot(const QPoint &p) const;

		/**
		 * @brief Returns the rectangle of the actual data plot without
		 *        the axis rectangle. This function was added with API
		 *        version 11.0.0.
		 * @return QRect
		 */
		const QRect &plotRect() const;


	// ----------------------------------------------------------------------
	//  Public Members
	// ----------------------------------------------------------------------
	public:
		Axis *xAxis;   //!< bottom axis
		Axis *yAxis;   //!< left axis
		Axis *xAxis2;  //!< top axis
		Axis *yAxis2;  //!< right axis


	protected:
		typedef QList<Graph*> Graphs;
		Graphs          _graphs;
		AbstractLegend *_legend;
		QVector<Axis*>  _extraXAxis1; //!< additional bottom x axes
		QVector<Axis*>  _extraXAxis2; //!< additional top x axes
		QVector<Axis*>  _extraYAxis1; //!< additional left y axes
		QVector<Axis*>  _extraYAxis2; //!< additional right y axes
		QRect           _plotRect; //!< The plot rectangle of the last draw
};


inline bool Plot::isInsidePlot(const QPoint &p) const {
	return _plotRect.contains(p);
}

inline const QRect &Plot::plotRect() const {
	return _plotRect;
}


}
}


#endif