Drawable.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 DRAWABLE_H_
#define DRAWABLE_H_

#include <array>
#include <memory>
#include <ostream>
#include <vector>

#include "util/BBox.hpp"
#include "util/Style.hpp"

namespace trase {

class Backend;
class AnimatedBackend;

struct FrameInfo {

  int frame_above;
  float frame;
  float w1;
  float w2;

  void update(std::vector<float> &times, const float time_now) {
    frame_above = static_cast<int>(std::distance(
        times.begin(), std::lower_bound(times.begin(), times.end(), time_now)));

    if (frame_above == 0) {
      w1 = 1.f;
      w2 = 0.f;
      frame = 0.f;
    } else {
      const float delta_t = times[frame_above] - times[frame_above - 1];
      w1 = (time_now - times[frame_above - 1]) / delta_t;
      w2 = 1.f - w1;
      frame = static_cast<float>(frame_above - 1) + w1;
    }
  }
};

// forward declare all backends here
class BackendGL;
class BackendSVG;

class Drawable {
protected:
  std::vector<std::shared_ptr<Drawable>> m_children;

  Drawable *m_parent;

  bfloat2_t m_area;

  bfloat2_t m_pixels;

  float m_time_span;

  std::vector<float> m_times;

  FrameInfo m_frame_info;

  Style m_style;

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

  void resize(const bfloat2_t &parent_pixels);

  void update_time_span(float time);

  void add_frame_time(float time);

  void update_frame_info(float time);

  const FrameInfo &get_frame_info() const;

  const bfloat2_t &pixels() const { return m_pixels; }

  const bfloat2_t &area() const { return m_area; }

  bfloat2_t &area() { return m_area; }

  Style &style() noexcept;

  const float &time_span() const { return m_time_span; }

#ifdef TRASE_BACKEND_GL
  virtual void dispatch(BackendGL &figure, float time) = 0;
#endif
  virtual void dispatch(BackendSVG &file, float time) = 0;
  virtual void dispatch(BackendSVG &file) = 0;

  template <typename AnimatedBackend> void draw(AnimatedBackend &backend);

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

} // namespace trase

#define TRASE_DISPATCH(backend_type)                                           \
  void dispatch(backend_type &backend, float time) override {                  \
    draw(backend, time);                                                       \
    for (auto &i : m_children) {                                               \
      i->dispatch(backend, time);                                              \
    }                                                                          \
  }

#define TRASE_ANIMATED_DISPATCH(backend_type)                                  \
  void dispatch(backend_type &backend) override {                              \
    if (m_times.size() == 1) {                                                 \
      draw(backend, 0);                                                        \
    } else {                                                                   \
      draw(backend);                                                           \
    }                                                                          \
    for (auto &i : m_children) {                                               \
      i->dispatch(backend);                                                    \
    }                                                                          \
  }

#define TRASE_DISPATCH_SVG                                                     \
  TRASE_DISPATCH(BackendSVG)                                                   \
  TRASE_ANIMATED_DISPATCH(BackendSVG)

#ifdef TRASE_BACKEND_GL
#define TRASE_DISPATCH_GL TRASE_DISPATCH(BackendGL)
#else
#define TRASE_DISPATCH_GL
#endif

#define TRASE_DISPATCH_BACKENDS                                                \
  TRASE_DISPATCH_SVG                                                           \
  TRASE_DISPATCH_GL

#ifdef TRASE_BACKEND_GL
#include "backend/BackendGL.hpp"
#endif
#include "backend/BackendSVG.hpp"

#endif // DRAWABLE_H_