shape.h

Go to the documentation of this file.

//=============================================================================
//  MuseScore
//  Music Composition & Notation
//
//  Copyright (C) 2016 Werner Schweer
//
//  This program is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License version 2
//  as published by the Free Software Foundation and appearing in
//  the file LICENCE.GPL
//=============================================================================

#ifndef __SHAPE_H__
#define __SHAPE_H__

namespace Ms {

#ifndef NDEBUG
// #define DEBUG_SHAPES    // enable shape debugging
#endif

class Segment;

//---------------------------------------------------------
//   ShapeElement
//---------------------------------------------------------

struct ShapeElement : public QRectF {
#ifndef NDEBUG
      const char* text;
      void dump() const;
      ShapeElement(const QRectF& f, const char* t = 0) : QRectF(f), text(t) {}
#else
      ShapeElement(const QRectF& f) : QRectF(f) {}
#endif
      };

//---------------------------------------------------------
//   Shape
//---------------------------------------------------------

class Shape : public std::vector<ShapeElement> {
// class Shape : std::vector<ShapeElement> {
   public:
      enum HorizontalSpacingType {
            SPACING_GENERAL = 0,
            SPACING_LYRICS,
            SPACING_HARMONY,
            };

      Shape() {}
#ifndef NDEBUG
      Shape(const QRectF& r, const char* s = 0) { add(r, s); }
#else
      Shape(const QRectF& r) { add(r); }
#endif
      void add(const Shape& s)            { insert(end(), s.begin(), s.end()); }
#ifndef NDEBUG
      void add(const QRectF& r, const char* t = 0);
#else
      void add(const QRectF& r)           { push_back(r); }
#endif
      void remove(const QRectF&);
      void remove(const Shape&);

      void addHorizontalSpacing(HorizontalSpacingType type, qreal left, qreal right);

      void translate(const QPointF&);
      void translateX(qreal);
      void translateY(qreal);
      Shape translated(const QPointF&) const;

      qreal minHorizontalDistance(const Shape&) const;
      qreal minVerticalDistance(const Shape&) const;
      qreal topDistance(const QPointF&) const;
      qreal bottomDistance(const QPointF&) const;
      qreal left() const;
      qreal right() const;
      qreal top() const;
      qreal bottom() const;

      size_t size() const { return std::vector<ShapeElement>::size();  }
      bool empty() const  { return std::vector<ShapeElement>::empty(); }
      void clear()        { std::vector<ShapeElement>::clear();        }

      bool contains(const QPointF&) const;
      bool intersects(const QRectF& rr) const;
      bool intersects(const Shape&) const;
      void paint(QPainter&) const;

#ifndef NDEBUG
      void dump(const char*) const;
#endif
      };

//---------------------------------------------------------
//   intersects
//---------------------------------------------------------

inline static bool intersects(qreal a, qreal b, qreal c, qreal d)
      {
      // return (a >= c && a < d) || (b >= c && b < d) || (a < c && b >= b);
      // return (std::max(a,b) > std::min(c,d)) && (std::min(a,b) < std::max(c,d));
      // if we can assume a <= b and c <= d
      if (a == b || c == d)   // zero height
            return false;
      return (b > c) && (a < d);
      }

#ifdef DEBUG_SHAPES
extern void testShapes();
#endif

} // namespace Ms

#endif