Axis.hpp

Go to the documentation of this file.

/*
Copyright (c) 2018, University of Oxford.
All rights reserved.

University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.

This file is part of trase.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/


#ifndef AXIS_H_
#define AXIS_H_

#include <array>
#include <memory>

#include "frontend/Data.hpp"
#include "frontend/Drawable.hpp"
#include "frontend/Geometry.hpp"

#include "util/Colors.hpp"
#include "util/Exception.hpp"

namespace trase {

// forward declare since Axis has some functions returning legends
class Legend;

struct TickInfo {
  std::vector<float> x_val;
  std::vector<float> y_val;
  std::vector<float> x_pos;
  std::vector<float> y_pos;

  void clear() {
    x_val.clear();
    y_val.clear();
    x_pos.clear();
    y_pos.clear();
  }
};

class Axis : public Drawable {
  Limits m_limits;

  int m_sig_digits;

  int m_nx_ticks;

  int m_ny_ticks;

  float m_tick_len;

  std::string m_xlabel;

  std::string m_ylabel;

  std::string m_title;

  TickInfo m_tick_info;

  bool m_has_legend;

public:
  Axis(Drawable *parent, const bfloat2_t &area);

  virtual ~Axis() = default;

  TRASE_DISPATCH_BACKENDS

  const Limits &limits() const { return m_limits; }

  Limits &limits() { return m_limits; }

  void xlim(std::array<float, 2> xlimits) {
    m_limits.bmin[Aesthetic::x::index] = xlimits[0];
    m_limits.bmax[Aesthetic::x::index] = xlimits[1];
  }

  void ylim(std::array<float, 2> ylimits) {
    m_limits.bmin[Aesthetic::y::index] = ylimits[0];
    m_limits.bmax[Aesthetic::y::index] = ylimits[1];
  }

  void xlabel(const char *string) { m_xlabel.assign(string); }

  void ylabel(const char *string) { m_ylabel.assign(string); }

  void title(const char *string) { m_title.assign(string); }

  std::shared_ptr<Legend> legend();

  std::shared_ptr<Geometry>
  points(const DataWithAesthetic &data,
         const Transform &transform = Transform(Identity()));

  std::shared_ptr<Geometry>
  rectangle(const DataWithAesthetic &data,
            const Transform &transform = Transform(Identity()));

  std::shared_ptr<Geometry>
  line(const DataWithAesthetic &data,
       const Transform &transform = Transform(Identity()));

  std::shared_ptr<Geometry>
  histogram(const DataWithAesthetic &data,
            const Transform &transform = Transform(BinX()));

  std::shared_ptr<Geometry> plot(int n);

  template <typename AnimatedBackend> void draw(AnimatedBackend &backend);
  template <typename Backend> void draw(Backend &backend, float time);

  template <typename Aesthetic> float from_display(float i) const {
    return Aesthetic::from_display(i, m_limits, m_pixels);
  }

  template <typename Aesthetic> float to_display(float i) const {
    return Aesthetic::to_display(i, m_limits, m_pixels);
  }

  void set_ticks(Vector<int, 2> arg) {
    m_nx_ticks = arg[0];
    m_ny_ticks = arg[1];
  }

  Vector<int, 2> get_ticks() const { return {m_nx_ticks, m_ny_ticks}; }

private:
  std::shared_ptr<Geometry> plot_impl(const std::shared_ptr<Geometry> &plot,
                                      const Transform &transform,
                                      const DataWithAesthetic &values);

  void update_tick_information();
  vint2_t calculate_num_ticks();
  void add_geometry_to_legend(const std::shared_ptr<Geometry> &geometry);
  std::shared_ptr<Legend> add_legend();

  template <typename Backend> void draw_common(Backend &backend);
  template <typename Backend> void draw_common_axis_box(Backend &backend);
  template <typename Backend> void draw_common_ticks(Backend &backend);
  template <typename Backend> void draw_common_gridlines(Backend &backend);
  template <typename Backend> void draw_common_title(Backend &backend);
  template <typename Backend> void draw_common_xlabel(Backend &backend);
  template <typename Backend> void draw_common_ylabel(Backend &backend);
};

} // namespace trase

#include "frontend/Axis.tcc"

#endif // AXIS_H_