vpPlot.h

/****************************************************************************
 *
 * This file is part of the ViSP software.
 * Copyright (C) 2005 - 2017 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * ("GPL") version 2 as published by the Free Software Foundation.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See http://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * Plot curves.
 *
 * Authors:
 * Nicolas Melchior
 *
 *****************************************************************************/

#ifndef vpPlot_H
#define vpPlot_H

#include <visp3/core/vpConfig.h>
#include <visp3/core/vpDisplay.h>
#include <visp3/gui/vpPlotGraph.h>

#if defined(VISP_HAVE_DISPLAY)

class VISP_EXPORT vpPlot
{
  public:
    vpImage<unsigned char> I;
  
  private:
    vpDisplay *display;
    
    unsigned int graphNbr;
    vpPlotGraph* graphList;
    
    unsigned int margei;
    unsigned int margej;
    
    float factori;
    float factorj;
    
//private:
//#ifndef DOXYGEN_SHOULD_SKIP_THIS
//    vpPlot(const vpPlot &)
//      : I(), display(NULL), graphNbr(0), graphList(NULL), margei(0), margej(0),
//        factori(0), factorj(0)
//    {
//      throw vpException(vpException::functionNotImplementedError, "Not implemented!");
//    }
//    vpPlot &operator=(const vpPlot &){
//      throw vpException(vpException::functionNotImplementedError, "Not implemented!");
//      return *this;
//    }
//#endif

public:
    vpPlot();
    vpPlot(const unsigned int nbGraph,
       const unsigned int height=700, 
       const unsigned int width=700, 
     const int x=-1, const int y=-1, const std::string &title="");
    ~vpPlot();
    void getPixelValue(const bool block);
    void init(const unsigned int nbGraph,
          const unsigned int height=700, 
          const unsigned int width=700, 
        const int x=-1, const int y=-1, const std::string &title="");
    void initGraph (unsigned int graphNum, unsigned int curveNbr);
    
    void initRange (const unsigned int graphNum, double xmin, double xmax, double ymin, double ymax);
    void initRange (const unsigned int graphNum, double xmin, double xmax, double ymin, double ymax, double zmin, double zmax);
    void navigate (void);

    void plot (const unsigned int graphNum, const unsigned int curveNum, const double x, const double y);
    void plot(const unsigned int graphNum, const double x, const vpColVector &v_y);
    void plot(const unsigned int graphNum, const double x, const vpRowVector &v_y);
    void plot(const unsigned int graphNum, const double x, const vpPoseVector &v_y);
    void plot(const unsigned int graphNum, const double x, const vpTranslationVector &v_y);
    void plot(const unsigned int graphNum, const double x, const vpRotationVector &v_y);
    vpMouseButton::vpMouseButtonType plot (const unsigned int graphNum, const unsigned int curveNum, const double x, const double y, const double z);
    vpMouseButton::vpMouseButtonType plot(const unsigned int graphNum, const double x, const vpColVector &v_y, const vpColVector &v_z);

    void resetPointList (const unsigned int graphNum);
    void resetPointList (const unsigned int graphNum, const unsigned int curveNum);

    void saveData(const unsigned int graphNum, const std::string &dataFile, const std::string &title_prefix="");
    void setColor (const unsigned int graphNum, const unsigned int curveNum, vpColor color);
    void setGraphThickness (const unsigned int graphNum, const unsigned int thickness);
    void setGridThickness (const unsigned int graphNum, const unsigned int thickness);
    void setFont(const std::string &font)
    {
      if (display->isInitialised())
        vpDisplay::setFont(I, font.c_str());
    }
    void setLegend (const unsigned int graphNum, const unsigned int curveNum, const std::string &legend);
    void setTitle (const unsigned int graphNum, const std::string &title);
    void setUnitX (const unsigned int graphNum, const std::string &unitx);
    void setUnitY (const unsigned int graphNum, const std::string &unity);
    void setUnitZ (const unsigned int graphNum, const std::string &unitz);
    void setThickness (const unsigned int graphNum, const unsigned int curveNum, const unsigned int thickness);
    
  private:
    void initNbGraph (unsigned int nbGraph);
    void displayGrid();
};
#endif

#endif