codac2_Figure2D.h

Go to the documentation of this file.

 
#pragma once
 
#include <string>
#include <vector>
#include <memory>
#include "codac2_Index.h"
#include "codac2_Figure2DInterface.h"
#include "codac2_OutputFigure2D.h"
#include "codac2_Paving.h"
#include "codac2_Parallelepiped.h"
#include "codac2_Zonotope.h"
#include "codac2_PavingStyle.h"
#include "codac2_Ellipsoid.h"
#include "codac2_Polygon.h"
#include "codac2_SlicedTube.h"
#include "codac2_Ctc.h"
#include "codac2_Sep.h"
 
#define DEFAULT_FIG_NAME "Codac - default figure"
 
namespace codac2
{
  enum class GraphicOutput
  {
    VIBES = 0x01,
    IPE = 0x02
  };
 
  constexpr int operator&(GraphicOutput a, GraphicOutput b)
  { return static_cast<int>(static_cast<int>(a) & static_cast<int>(b)); }
 
  constexpr GraphicOutput operator|(GraphicOutput a, GraphicOutput b)
  { return static_cast<GraphicOutput>(static_cast<int>(a) | static_cast<int>(b)); }
 
  struct FigureAxis
  {
    Index dim_id;
    Interval limits;
    std::string label;
  };
 
  inline FigureAxis axis(Index dim_id, const Interval& limits, const std::string& label = "")
  {
    assert_release(dim_id >= 0);
    //assert_release(!limits.is_empty());
 
    std::string axis_label = label;
    if(axis_label.empty())
      axis_label = "x_" + std::to_string(dim_id);
 
    return { dim_id, limits, axis_label };
  }
 
  class DefaultFigure;
  class PavingOut;
  class PavingInOut;
  template<typename P>
  class Subpaving;

  class Figure2D : public std::enable_shared_from_this<Figure2D>
  {
    public:

      Figure2D(const std::string& name, GraphicOutput o, bool set_as_default = false);

      std::vector<std::shared_ptr<OutputFigure2D>> output_figures();

      const std::string& name() const;
      
      Index size() const;

      const std::vector<FigureAxis>& axes() const;

      Figure2D& set_axes(const FigureAxis& axis1, const FigureAxis& axis2);

      const Index& i() const;

      const Index& j() const;

      const Vector& pos() const;

      const Vector& window_size() const;

      void set_window_properties(const Vector& pos, const Vector& size);

      void center_viewbox(const Vector& c, const Vector& r);

      void clear();

      double scaled_unit() const;

      void auto_scale();

      bool is_default() const;

      void set_as_default();

      void set_tdomain(const Interval& tdomain);
 
      // Geometric shapes

      void draw_point(const Vector& c, const StyleProperties& style = StyleProperties());

      void draw_box(const IntervalVector& x, const StyleProperties& style = StyleProperties());

      void draw_circle(const Vector& c, double r, const StyleProperties& style = StyleProperties());

      void draw_ring(const Vector& c, const Interval& r, const StyleProperties& style = StyleProperties());

      void draw_line(const Vector& p1, const Vector& p2, const StyleProperties& style = StyleProperties());

      void draw_line(const Segment& e, const StyleProperties& style = StyleProperties());

      void draw_arrow(const Vector& p1, const Vector& p2, float tip_length, const StyleProperties& style = StyleProperties());

      void draw_polyline(const std::vector<Vector>& x, const StyleProperties& style = StyleProperties());

      void draw_polyline(const std::vector<Vector>& x, float tip_length, const StyleProperties& style = StyleProperties());

      void draw_polygon(const Polygon& x, const StyleProperties& style = StyleProperties());

      void draw_parallelepiped(const Parallelepiped& p, const StyleProperties& style = StyleProperties());

      void draw_zonotope(const Zonotope& z, const StyleProperties& style = StyleProperties());

      void draw_pie(const Vector& c, const Interval& r, const Interval& theta, const StyleProperties& style = StyleProperties());

      void draw_ellipse(const Vector& c, const Vector& ab, double theta, const StyleProperties& style = StyleProperties());

      void draw_ellipsoid(const Ellipsoid& e, const StyleProperties& style = StyleProperties());

      void draw_trajectory(const SampledTraj<Vector>& x, const StyleProperties& style = StyleProperties());

      void draw_trajectory(const AnalyticTraj<VectorType>& x, const StyleProperties& style = StyleProperties());

      void draw_trajectory(const SampledTraj<Vector>& x, const StyleGradientProperties& style);

      void draw_trajectory(const AnalyticTraj<VectorType>& x, const StyleGradientProperties& style);

      void plot_trajectory(const SampledTraj<double>& x, const StyleProperties& style = StyleProperties());

      void plot_trajectories(const SampledTraj<Vector>& x);

      void plot_trajectories(const SampledTraj<Vector>& x, const StyleProperties& style);

      void draw_tube(const SlicedTube<IntervalVector>& x, const StyleProperties& style, int max_nb_slices_to_display = 5000);

      void draw_tube(const SlicedTube<IntervalVector>& x, const StyleGradientProperties& style = StyleGradientProperties(ColorMap::blue_tube()), int max_nb_slices_to_display = 5000);

      void plot_tube(const SlicedTube<Interval>& x, const StyleProperties& style = StyleProperties());

      void plot_tube(const SlicedTube<Interval>& x, const SlicedTube<Interval>& v, const StyleProperties& style = StyleProperties());
 
      // Robots

      void draw_tank(const Vector& x, float size, const StyleProperties& style = StyleProperties());

      void draw_AUV(const Vector& x, float size, const StyleProperties& style = StyleProperties());

      void draw_motor_boat(const Vector& x, float size, const StyleProperties& style = StyleProperties());
 
      // Miscellaneous

      void draw_text(const std::string& text, const Vector& ul, double scale, const StyleProperties& style = StyleProperties());

      void draw_raster(const std::string& filename, const IntervalVector& bbox, const StyleProperties& style = StyleProperties());
 
      // Pavings

      void draw_paving(const PavingOut& p,
        const PavingStyle& style = PavingStyle::default_style());

      void draw_paving(const PavingOut& p,
        const std::function<void(Figure2D&,const IntervalVector&,const StyleProperties&)>& draw_box,
        const PavingStyle& style = PavingStyle::default_style());

      void draw_paving(const PavingInOut& p,
        const PavingStyle& style = PavingStyle::default_style());

      void draw_paving(const PavingInOut& p,
        const std::function<void(Figure2D&,const IntervalVector&,const StyleProperties&)>& draw_box,
        const PavingStyle& style = PavingStyle::default_style());
  
      template<typename C>
        requires IsCtcBaseOrPtr<C,IntervalVector>
      void pave(const IntervalVector& x0, const C& c, double eps,
        const PavingStyle& style = PavingStyle::default_style());
  
      template<typename C>
        requires IsCtcBaseOrPtr<C,IntervalVector>
      void pave(const IntervalVector& x0, const C& c, double eps,
        const std::function<void(Figure2D&,const IntervalVector&,const StyleProperties&)>& draw_box,
        const PavingStyle& style = PavingStyle::default_style());
  
      template<typename S>
        requires IsSepBaseOrPtr<S>
      void pave(const IntervalVector& x0, const S& s, double eps,
        const PavingStyle& style = PavingStyle::default_style());
  
      template<typename S>
        requires IsSepBaseOrPtr<S>
      void pave(const IntervalVector& x0, const S& s, double eps,
        const std::function<void(Figure2D&,const IntervalVector&,const StyleProperties&)>& draw_box,
        const PavingStyle& style = PavingStyle::default_style());

      template<typename P>
      void draw_subpaving(const Subpaving<P>& p, const StyleProperties& style = StyleProperties())
      {
        for(const auto& pi : p.boxes())
          draw_box(pi, style);
      }
 
    protected:
 
      const std::string _name;
      Vector _pos {50,50}, _window_size {700,700};
      std::vector<FigureAxis> _axes { axis(0,{0,1}), axis(1,{0,1}) };
      std::vector<std::shared_ptr<OutputFigure2D>> _output_figures;
      Interval _tdomain;
 
      friend DefaultFigure;
  };

  class DefaultFigure
  {
    public:

      static std::shared_ptr<Figure2D> selected_fig()
      {
        if(_selected_fig == nullptr)
          _selected_fig = _default_fig;
        return _selected_fig;
      }

      static void set(std::shared_ptr<Figure2D> fig)
      {
        _selected_fig = fig;
      }
      
      static Figure2D& set_axes(const FigureAxis& axis1, const FigureAxis& axis2)
      {
        auto_init();
        return selected_fig()->set_axes(axis1,axis2);
      }
      
      static void set_window_properties(const Vector& pos, const Vector& size)
      {
        auto_init();
        selected_fig()->set_window_properties(pos,size);
      }

      static void auto_scale()
      {
        auto_init();
        selected_fig()->auto_scale();
      }

      static void clear()
      {
        auto_init();
        selected_fig()->clear();
      }
 
      // Geometric shapes

      static void draw_point(const Vector& c, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_point(c,style);
      }

      static void draw_box(const IntervalVector& x, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_box(x,style);
      }

      static void draw_circle(const Vector& c, double r, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_circle(c,r,style);
      }

      static void draw_ring(const Vector& c, const Interval& r, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_ring(c,r,style);
      }

      static void draw_line(const Vector& p1, const Vector& p2, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_line(p1,p2,style);
      }

      static void draw_line(const Segment& e, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_line(e,style);
      }

      static void draw_arrow(const Vector& p1, const Vector& p2, float tip_length, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_arrow(p1,p2,tip_length,style);
      }

      static void draw_polyline(const std::vector<Vector>& x, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_polyline(x,style);
      }

      static void draw_polyline(const std::vector<Vector>& x, float tip_length, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_polyline(x,tip_length,style);
      }

      static void draw_polygon(const Polygon& x, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_polygon(x,style);
      }

      static void draw_parallelepiped(const Parallelepiped& p, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_parallelepiped(p,style);
      }

      static void draw_zonotope(const Zonotope& z, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_zonotope(z,style);
      }

      static void draw_pie(const Vector& c, const Interval& r, const Interval& theta, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_pie(c,r,theta,style);
      }

      static void draw_ellipse(const Vector& c, const Vector& ab, double theta, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_ellipse(c,ab,theta,style);
      }

      static void draw_ellipsoid(const Ellipsoid& e, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_ellipsoid(e,style);
      }

      static void draw_trajectory(const SampledTraj<Vector>& x, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_trajectory(x,style);
      }

      static void draw_trajectory(const AnalyticTraj<VectorType>& x, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_trajectory(x,style);
      }

      static void draw_trajectory(const SampledTraj<Vector>& x, const StyleGradientProperties& style)
      {
        auto_init();
        selected_fig()->draw_trajectory(x,style);
      }

      static void draw_trajectory(const AnalyticTraj<VectorType>& x, const StyleGradientProperties& style)
      {
        auto_init();
        selected_fig()->draw_trajectory(x,style);
      }

      static void plot_trajectory(const SampledTraj<double>& x, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->plot_trajectory(x,style);
      }

      static void plot_trajectories(const SampledTraj<Vector>& x, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->plot_trajectories(x,style);
      }

      static void draw_tube(const SlicedTube<IntervalVector>& x, const StyleProperties& style)
      {
        auto_init();
        selected_fig()->draw_tube(x,style);
      }

      static void draw_tube(const SlicedTube<IntervalVector>& x, const StyleGradientProperties& style = StyleGradientProperties(ColorMap::blue_tube()))
      {
        auto_init();
        selected_fig()->draw_tube(x,style);
      }

      static void plot_tube(const SlicedTube<Interval>& x, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->plot_tube(x,style);
      }

      static void plot_tube(const SlicedTube<Interval>& x, const SlicedTube<Interval>& v, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->plot_tube(x,v,style);
      }
 
      // Robots

      static void draw_tank(const Vector& x, float size, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_tank(x,size,style);
      }

      static void draw_AUV(const Vector& x, float size, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_AUV(x,size,style);
      }

      static void draw_motor_boat(const Vector& x, float size, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_motor_boat(x,size,style);
      }
 
      // Miscellaneous

      static void draw_text(const std::string& text, const Vector& ul, double scale, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_text(text,ul,scale,style);
      }

      static void draw_raster(const std::string& filename, const IntervalVector& bbox, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_raster(filename,bbox,style);
      }
 
      // Pavings
 
    protected:
 
      static void init_axes_paving(const IntervalVector& x)
      {
        _default_fig->set_window_properties({100,100}, {800,800});
        _default_fig->set_axes(axis(0,x[0],"x_1"), axis(1,x[1],"x_2"));
        _default_fig->auto_scale();
      }
 
    public:

      static void draw_paving(const PavingOut& p,
        const PavingStyle& style = PavingStyle::default_style())
      {
        if(auto_init())
          init_axes_paving(p.tree()->hull());
        selected_fig()->draw_paving(p, style);
      }

      static void draw_paving(const PavingOut& p,
        const std::function<void(Figure2D&,const IntervalVector&,const StyleProperties&)>& draw_box,
        const PavingStyle& style = PavingStyle::default_style())
      {
        if(auto_init())
          init_axes_paving(p.tree()->hull());
        selected_fig()->draw_paving(p, draw_box, style);
      }

      static void draw_paving(const PavingInOut& p,
        const PavingStyle& style = PavingStyle::default_style())
      {
        if(auto_init())
          init_axes_paving(p.tree()->hull());
        selected_fig()->draw_paving(p, style);
      }

      static void draw_paving(const PavingInOut& p,
        const std::function<void(Figure2D&,const IntervalVector&,const StyleProperties&)>& draw_box,
        const PavingStyle& style = PavingStyle::default_style())
      {
        if(auto_init())
          init_axes_paving(p.tree()->hull());
        selected_fig()->draw_paving(p, draw_box, style);
      }

      template<typename C>
        requires IsCtcBaseOrPtr<C,IntervalVector>
      static void pave(const IntervalVector& x0, const C& c, double eps,
        const PavingStyle& style = PavingStyle::default_style())
      {
        if(auto_init())
          init_axes_paving(x0);
        selected_fig()->pave(x0, c, eps, style);
      }
  
      template<typename C>
        requires IsCtcBaseOrPtr<C,IntervalVector>
      static void pave(const IntervalVector& x0, const C& c, double eps,
        const std::function<void(Figure2D&,const IntervalVector&,const StyleProperties&)>& draw_box,
        const PavingStyle& style = PavingStyle::default_style())
      {
        if(auto_init())
          init_axes_paving(x0);
        selected_fig()->pave(x0, c, eps, draw_box, style);
      }
  
      template<typename S>
        requires IsSepBaseOrPtr<S>
      static void pave(const IntervalVector& x0, const S& s, double eps,
        const PavingStyle& style = PavingStyle::default_style())
      {
        if(auto_init())
          init_axes_paving(x0);
        selected_fig()->pave(x0, s, eps, style);
      }
  
      template<typename S>
        requires IsSepBaseOrPtr<S>
      static void pave(const IntervalVector& x0, const S& s, double eps,
        const std::function<void(Figure2D&,const IntervalVector&,const StyleProperties&)>& draw_box,
        const PavingStyle& style = PavingStyle::default_style())
      {
        if(auto_init())
          init_axes_paving(x0);
        selected_fig()->pave(x0, s, eps, draw_box, style);
      }

      template<typename P>
      static void draw_subpaving(const Subpaving<P>& p, const StyleProperties& style = StyleProperties())
      {
        auto_init();
        selected_fig()->draw_subpaving(p, style);
      }
 
 
    protected:
 
      static bool auto_init()
      {
        if(!_default_fig && !_selected_fig)
        {
          _default_fig = std::make_shared<Figure2D>(DEFAULT_FIG_NAME, GraphicOutput::VIBES);
          _default_fig->set_window_properties({20.,20.}, {800.,800.});
          _default_fig->set_axes(axis(0,{-10,10}),axis(1,{-10,10}));
          _selected_fig = _default_fig;
          return true;
        }
 
        return false;
      }
 
      friend Figure2D;
 
      static std::shared_ptr<Figure2D> _default_fig;
      static std::shared_ptr<Figure2D> _selected_fig;
  };
}
 
#include "codac2_Figure2D_pave.h"