562 lines
22 KiB
C++
562 lines
22 KiB
C++
//=============================================================================
|
|
// MuseScore
|
|
// Music Composition & Notation
|
|
//
|
|
// Copyright (C) 2002-2017 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 __ELEMENT_H__
|
|
#define __ELEMENT_H__
|
|
|
|
#include "spatium.h"
|
|
#include "fraction.h"
|
|
#include "scoreElement.h"
|
|
#include "shape.h"
|
|
|
|
namespace Ms {
|
|
|
|
/**
|
|
\file
|
|
Definition of classes Element, ElementList.
|
|
*/
|
|
|
|
#ifndef VOICES
|
|
#define VOICES 4
|
|
#endif
|
|
|
|
class XmlReader;
|
|
class XmlWriter;
|
|
enum class SymId;
|
|
enum class P_ID;
|
|
enum class SubStyle;
|
|
|
|
//---------------------------------------------------------
|
|
// Grip
|
|
//---------------------------------------------------------
|
|
|
|
enum class Grip : int {
|
|
NO_GRIP = -1,
|
|
START = 0, END = 1, // arpeggio etc.
|
|
MIDDLE = 2, APERTURE = 3, // Line
|
|
/*START, END , */
|
|
BEZIER1 = 2, SHOULDER = 3, BEZIER2 = 4, DRAG = 5, // Slur
|
|
GRIPS = 6 // number of grips for slur
|
|
};
|
|
|
|
//---------------------------------------------------------
|
|
// ElementFlag
|
|
//---------------------------------------------------------
|
|
|
|
enum class ElementFlag {
|
|
DROP_TARGET = 0x00000001,
|
|
SELECTABLE = 0x00000002,
|
|
MOVABLE = 0x00000004,
|
|
SEGMENT = 0x00000008,
|
|
HAS_TAG = 0x00000010, // true if this is a layered element
|
|
ON_STAFF = 0x00000020, // parent is Segment() type
|
|
SELECTED = 0x00000040,
|
|
GENERATED = 0x00000080,
|
|
VISIBLE = 0x00000100,
|
|
AUTOPLACE = 0x00000200,
|
|
SYSTEM = 0x00000400,
|
|
|
|
// measure flags
|
|
REPEAT_END = 0x00000800,
|
|
REPEAT_START = 0x00001000,
|
|
REPEAT_JUMP = 0x00002000,
|
|
IRREGULAR = 0x00004000,
|
|
LINE_BREAK = 0x00008000,
|
|
PAGE_BREAK = 0x00010000,
|
|
SECTION_BREAK = 0x00020000,
|
|
NO_BREAK = 0x00040000,
|
|
HEADER = 0x00080000,
|
|
TRAILER = 0x00100000, // also used in segment
|
|
KEYSIG = 0x00200000,
|
|
// segment flags
|
|
ENABLED = 0x00400000, // used for segments
|
|
EMPTY = 0x00800000,
|
|
WRITTEN = 0x01000000,
|
|
};
|
|
|
|
typedef QFlags<ElementFlag> ElementFlags;
|
|
Q_DECLARE_OPERATORS_FOR_FLAGS(ElementFlags);
|
|
|
|
//---------------------------------------------------------
|
|
// DropData
|
|
//---------------------------------------------------------
|
|
|
|
struct DropData {
|
|
MuseScoreView* view;
|
|
QPointF pos;
|
|
QPointF dragOffset;
|
|
Element* element;
|
|
Qt::KeyboardModifiers modifiers;
|
|
Fraction duration;
|
|
|
|
bool control() const { return modifiers & Qt::ControlModifier; }
|
|
DropData();
|
|
};
|
|
|
|
//---------------------------------------------------------
|
|
// EditData
|
|
// used in editDrag
|
|
//---------------------------------------------------------
|
|
|
|
struct EditData {
|
|
MuseScoreView* view;
|
|
Qt::KeyboardModifiers modifiers;
|
|
|
|
Grip curGrip;
|
|
QPointF startMove;
|
|
QPointF pos;
|
|
QPointF lastPos;
|
|
QPointF delta;
|
|
bool hRaster;
|
|
bool vRaster;
|
|
};
|
|
|
|
//-------------------------------------------------------------------
|
|
// @@ Element
|
|
/// \brief Base class of score layout elements
|
|
///
|
|
/// The Element class is the virtual base class of all
|
|
/// score layout elements.
|
|
//
|
|
// @P bbox rect bounding box relative to pos and userOff (read only)
|
|
// @P color color element drawing color
|
|
// @P generated bool true if the element has been generated by layout
|
|
// @P pagePos point position in page coordinated (read only)
|
|
// @P parent Element the parent element in drawing hierarchy
|
|
// @P placement enum (Element.ABOVE, Element.BELOW)
|
|
// @P pos point position relative to parent
|
|
// @P selected bool true if the element is currently selected
|
|
// @P track int the track the elment belongs to
|
|
// @P userOff point manual offset to position determined by layout
|
|
// @P visible bool
|
|
//-------------------------------------------------------------------
|
|
|
|
class Element : public ScoreElement {
|
|
Q_GADGET
|
|
Q_ENUMS(Placement)
|
|
|
|
Q_PROPERTY(QRectF bbox READ scriptBbox )
|
|
Q_PROPERTY(QColor color READ color WRITE undoSetColor)
|
|
Q_PROPERTY(bool generated READ generated WRITE setGenerated)
|
|
Q_PROPERTY(QPointF pagePos READ scriptPagePos)
|
|
Q_PROPERTY(Ms::Element* parent READ parent WRITE setParent)
|
|
Q_PROPERTY(Ms::Element::Placement placement READ placement WRITE undoSetPlacement)
|
|
Q_PROPERTY(QPointF pos READ scriptPos WRITE scriptSetPos)
|
|
Q_PROPERTY(bool selected READ selected WRITE setSelected)
|
|
Q_PROPERTY(qreal spatium READ spatium)
|
|
Q_PROPERTY(int track READ track WRITE setTrack)
|
|
// Q_PROPERTY(Ms::ElementType type READ type)
|
|
Q_PROPERTY(QPointF userOff READ scriptUserOff WRITE scriptSetUserOff)
|
|
Q_PROPERTY(bool visible READ visible WRITE undoSetVisible)
|
|
|
|
Element* _parent { 0 };
|
|
mutable ElementFlags _flags {
|
|
ElementFlag::ENABLED | ElementFlag::EMPTY | ElementFlag::AUTOPLACE | ElementFlag::SELECTABLE
|
|
| ElementFlag::VISIBLE
|
|
}; // used for segments
|
|
|
|
protected:
|
|
mutable int _z;
|
|
QColor _color; ///< element color attribute
|
|
|
|
public:
|
|
enum class Placement : char {
|
|
ABOVE, BELOW
|
|
};
|
|
|
|
private:
|
|
Placement _placement;
|
|
int _track; ///< staffIdx * VOICES + voice
|
|
qreal _mag; ///< standard magnification (derived value)
|
|
QPointF _pos; ///< Reference position, relative to _parent.
|
|
QPointF _userOff; ///< offset from normal layout position:
|
|
QPointF _readPos;
|
|
mutable QRectF _bbox; ///< Bounding box relative to _pos + _userOff
|
|
///< valid after call to layout()
|
|
uint _tag; ///< tag bitmask
|
|
|
|
protected:
|
|
QPointF _startDragPosition; ///< used during drag
|
|
|
|
public:
|
|
Element(Score* s = 0);
|
|
Element(const Element&);
|
|
virtual ~Element() {}
|
|
|
|
Element &operator=(const Element&) = delete;
|
|
//@ create a copy of the element
|
|
Q_INVOKABLE virtual Ms::Element* clone() const = 0;
|
|
virtual Element* linkedClone();
|
|
|
|
Element* parent() const { return _parent; }
|
|
void setParent(Element* e) { _parent = e; }
|
|
Element* findMeasure();
|
|
|
|
qreal spatium() const;
|
|
|
|
inline void setFlag(ElementFlag f, bool v) { if (v) _flags |= f; else _flags &= ~ElementFlags(f); }
|
|
inline void setFlag(ElementFlag f, bool v) const { if (v) _flags |= f; else _flags &= ~ElementFlags(f); }
|
|
inline bool flag(ElementFlag f) const { return _flags & f; }
|
|
inline void setFlags(ElementFlags f) { _flags |= f; }
|
|
inline void clearFlags(ElementFlags f) { _flags &= ~f; }
|
|
inline ElementFlags flags() const { return _flags; }
|
|
|
|
bool selected() const { return flag(ElementFlag::SELECTED); }
|
|
virtual void setSelected(bool f) { setFlag(ElementFlag::SELECTED, f); }
|
|
|
|
bool visible() const { return flag(ElementFlag::VISIBLE); }
|
|
virtual void setVisible(bool f) { setFlag(ElementFlag::VISIBLE, f); }
|
|
|
|
Placement placement() const { return _placement; }
|
|
void setPlacement(Placement val) { _placement = val; }
|
|
void undoSetPlacement(Placement val);
|
|
bool placeBelow() const { return _placement == Placement::BELOW; }
|
|
bool placeAbove() const { return _placement == Placement::ABOVE; }
|
|
|
|
bool generated() const { return flag(ElementFlag::GENERATED); }
|
|
void setGenerated(bool val) { setFlag(ElementFlag::GENERATED, val); }
|
|
|
|
const QPointF& ipos() const { return _pos; }
|
|
virtual const QPointF pos() const { return _pos + _userOff; }
|
|
virtual qreal x() const { return _pos.x() + _userOff.x(); }
|
|
virtual qreal y() const { return _pos.y() + _userOff.y(); }
|
|
void setPos(qreal x, qreal y) { _pos.rx() = x, _pos.ry() = y; }
|
|
void setPos(const QPointF& p) { _pos = p; }
|
|
qreal& rxpos() { return _pos.rx(); }
|
|
qreal& rypos() { return _pos.ry(); }
|
|
virtual void move(const QPointF& s) { _pos += s; }
|
|
|
|
virtual QPointF pagePos() const; ///< position in page coordinates
|
|
virtual QPointF canvasPos() const; ///< position in canvas coordinates
|
|
qreal pageX() const;
|
|
qreal canvasX() const;
|
|
|
|
const QPointF& userOff() const { return _userOff; }
|
|
virtual void setUserOff(const QPointF& o) { _userOff = o; }
|
|
void setUserXoffset(qreal v) { _userOff.setX(v); }
|
|
void setUserYoffset(qreal v) { _userOff.setY(v); }
|
|
|
|
qreal& rUserXoffset() { return _userOff.rx(); }
|
|
qreal& rUserYoffset() { return _userOff.ry(); }
|
|
|
|
// function versions for scripts: use coords in spatium units rather than raster
|
|
// and route pos changes to userOff
|
|
QRectF scriptBbox() const;
|
|
virtual QPointF scriptPagePos() const;
|
|
virtual QPointF scriptPos() const;
|
|
void scriptSetPos(const QPointF& p);
|
|
QPointF scriptUserOff() const;
|
|
void scriptSetUserOff(const QPointF& o);
|
|
|
|
bool isNudged() const { return !(_readPos.isNull() && _userOff.isNull()); }
|
|
const QPointF& readPos() const { return _readPos; }
|
|
void setReadPos(const QPointF& p) { _readPos = p; }
|
|
virtual void adjustReadPos();
|
|
|
|
virtual const QRectF& bbox() const { return _bbox; }
|
|
virtual QRectF& bbox() { return _bbox; }
|
|
virtual qreal height() const { return bbox().height(); }
|
|
virtual void setHeight(qreal v) { _bbox.setHeight(v); }
|
|
virtual qreal width() const { return bbox().width(); }
|
|
virtual void setWidth(qreal v) { _bbox.setWidth(v); }
|
|
QRectF abbox() const { return bbox().translated(pagePos()); }
|
|
QRectF pageBoundingRect() const { return bbox().translated(pagePos()); }
|
|
QRectF canvasBoundingRect() const { return bbox().translated(canvasPos()); }
|
|
virtual void setbbox(const QRectF& r) const { _bbox = r; }
|
|
virtual void addbbox(const QRectF& r) const { _bbox |= r; }
|
|
bool contains(const QPointF& p) const;
|
|
bool intersects(const QRectF& r) const;
|
|
virtual Shape shape() const { return Shape(bbox()); }
|
|
virtual qreal baseLine() const { return -height(); }
|
|
|
|
virtual int subtype() const { return -1; } // for select gui
|
|
|
|
virtual void draw(QPainter*) const {}
|
|
void drawAt(QPainter*p, const QPointF& pt) const { p->translate(pt); draw(p); p->translate(-pt);}
|
|
|
|
virtual void writeProperties(XmlWriter& xml) const;
|
|
virtual bool readProperties(XmlReader&);
|
|
|
|
virtual void write(XmlWriter&) const;
|
|
virtual void read(XmlReader&);
|
|
|
|
virtual QRectF drag(EditData*);
|
|
virtual void endDrag() {}
|
|
virtual QLineF dragAnchor() const { return QLineF(); }
|
|
|
|
virtual bool isEditable() const { return !flag(ElementFlag::GENERATED); }
|
|
virtual void startEdit(MuseScoreView*, const QPointF&);
|
|
virtual bool edit(MuseScoreView*, Grip, int key, Qt::KeyboardModifiers, const QString& s);
|
|
virtual void editDrag(const EditData&);
|
|
virtual void endEditDrag(const EditData&) {}
|
|
virtual void endEdit() {}
|
|
virtual void updateGrips(Grip*, QVector<QRectF>&) const {}
|
|
virtual bool nextGrip(Grip*) const;
|
|
virtual int grips() const { return 0; }
|
|
virtual bool prevGrip(Grip*) const;
|
|
virtual QPointF gripAnchor(Grip) const { return QPointF(); }
|
|
virtual void setGrip(Grip, const QPointF&);
|
|
virtual QPointF getGrip(Grip) const;
|
|
|
|
int track() const { return _track; }
|
|
virtual void setTrack(int val) { _track = val; }
|
|
|
|
int z() const;
|
|
void setZ(int val) { _z = val; }
|
|
|
|
int staffIdx() const { return _track >> 2; }
|
|
virtual int vStaffIdx() const { return staffIdx(); }
|
|
int voice() const { return _track & 3; }
|
|
void setVoice(int v) { _track = (_track / VOICES) * VOICES + v; }
|
|
Staff* staff() const;
|
|
Part* part() const;
|
|
|
|
virtual void add(Element*);
|
|
virtual void remove(Element*);
|
|
virtual void change(Element* o, Element* n);
|
|
|
|
virtual void layout() {}
|
|
virtual void spatiumChanged(qreal /*oldValue*/, qreal /*newValue*/);
|
|
virtual void localSpatiumChanged(qreal /*oldValue*/, qreal /*newValue*/);
|
|
|
|
// debug functions
|
|
virtual void dump() const;
|
|
virtual Q_INVOKABLE QString subtypeName() const;
|
|
//@ Returns the human-readable name of the element type
|
|
//@ Returns the name of the element type
|
|
virtual Q_INVOKABLE QString _name() const { return QString(name()); }
|
|
void dumpQPointF(const char*) const;
|
|
|
|
virtual QColor color() const { return _color; }
|
|
QColor curColor() const;
|
|
QColor curColor(const Element* proxy) const;
|
|
virtual void setColor(const QColor& c) { _color = c; }
|
|
void undoSetColor(const QColor& c);
|
|
void undoSetVisible(bool v);
|
|
|
|
static ElementType readType(XmlReader& node, QPointF*, Fraction*);
|
|
|
|
QByteArray mimeData(const QPointF&) const;
|
|
/**
|
|
Return true if this element accepts a drop at canvas relative \a pos
|
|
of given element \a type and \a subtype.
|
|
|
|
Reimplemented by elements that accept drops. Used to change cursor shape while
|
|
dragging to indicate drop targets.
|
|
*/
|
|
virtual bool acceptDrop(const DropData&) const { return false; }
|
|
|
|
/**
|
|
Handle a dropped element at canvas relative \a pos of given element
|
|
\a type and \a subtype. Returns dropped element if any.
|
|
The ownership of element in DropData is transfered to the called
|
|
element (if not used, element has to be deleted).
|
|
The returned element will be selected if not in note edit mode.
|
|
|
|
Reimplemented by elements that accept drops.
|
|
*/
|
|
virtual Element* drop(const DropData&) { return 0;}
|
|
|
|
/**
|
|
delivers mouseEvent to element in edit mode
|
|
returns true if mouse event is accepted by element
|
|
*/
|
|
virtual bool mousePress(const QPointF&, QMouseEvent*) { return false; }
|
|
|
|
mutable bool itemDiscovered; ///< helper flag for bsp
|
|
|
|
virtual void scanElements(void* data, void (*func)(void*, Element*), bool all=true);
|
|
|
|
virtual void reset(); // reset all properties & position to default
|
|
|
|
virtual qreal mag() const { return _mag; }
|
|
void setMag(qreal val) { _mag = val; }
|
|
qreal magS() const;
|
|
|
|
bool isPrintable() const;
|
|
virtual bool isSpanner() const { return false; }
|
|
virtual bool isSpannerSegment() const { return false; }
|
|
|
|
qreal point(const Spatium sp) const { return sp.val() * spatium(); }
|
|
|
|
virtual int tick() const; // utility, searches for segment / segment parent
|
|
virtual int rtick() const; // utility, searches for segment / segment parent
|
|
|
|
//
|
|
// check element for consistency; return false if element
|
|
// is not valid
|
|
//
|
|
virtual bool check() const { return true; }
|
|
|
|
QPointF startDragPosition() const { return _startDragPosition; }
|
|
void setStartDragPosition(const QPointF& v) { _startDragPosition = v; }
|
|
|
|
static Ms::Element* create(Ms::ElementType type, Score*);
|
|
static Element* name2Element(const QStringRef&, Score*);
|
|
|
|
virtual bool systemFlag() const { return flag(ElementFlag::SYSTEM); }
|
|
void setSystemFlag(bool v) const { setFlag(ElementFlag::SYSTEM, v); }
|
|
|
|
bool header() const { return flag(ElementFlag::HEADER); }
|
|
void setHeader(bool v) { setFlag(ElementFlag::HEADER, v); }
|
|
|
|
bool trailer() const { return flag(ElementFlag::TRAILER); }
|
|
void setTrailer(bool val) { setFlag(ElementFlag::TRAILER, val); }
|
|
|
|
bool selectable() const { return flag(ElementFlag::SELECTABLE); }
|
|
void setSelectable(bool val) { setFlag(ElementFlag::SELECTABLE, val); }
|
|
|
|
bool dropTarget() const { return flag(ElementFlag::DROP_TARGET); }
|
|
void setDropTarget(bool v) const { setFlag(ElementFlag::DROP_TARGET, v); }
|
|
|
|
virtual bool isMovable() const { return flag(ElementFlag::MOVABLE); }
|
|
bool isSegmentFlag() const { return flag(ElementFlag::SEGMENT); }
|
|
|
|
bool enabled() const { return flag(ElementFlag::ENABLED); }
|
|
void setEnabled(bool val) { setFlag(ElementFlag::ENABLED, val); }
|
|
|
|
uint tag() const { return _tag; }
|
|
void setTag(uint val) { _tag = val; }
|
|
|
|
bool autoplace() const { return flag(ElementFlag::AUTOPLACE); }
|
|
void setAutoplace(bool v) { setFlag(ElementFlag::AUTOPLACE, v); }
|
|
|
|
virtual QVariant getProperty(P_ID) const override;
|
|
virtual bool setProperty(P_ID, const QVariant&) override;
|
|
virtual QVariant propertyDefault(P_ID) const override;
|
|
virtual void initSubStyle(SubStyle);
|
|
|
|
bool custom(P_ID) const;
|
|
bool readProperty(const QStringRef&, XmlReader&, P_ID);
|
|
virtual bool isUserModified() const;
|
|
|
|
virtual void styleChanged() {}
|
|
|
|
void drawSymbol(SymId id, QPainter* p, const QPointF& o = QPointF()) const;
|
|
void drawSymbol(SymId id, QPainter* p, const QPointF& o, int n) const;
|
|
void drawSymbols(const std::vector<SymId>&, QPainter* p, const QPointF& o = QPointF()) const;
|
|
qreal symHeight(SymId id) const;
|
|
qreal symWidth(SymId id) const;
|
|
qreal symWidth(const std::vector<SymId>&) const;
|
|
QRectF symBbox(SymId id) const;
|
|
QRectF symBbox(const std::vector<SymId>&) const;
|
|
QPointF symStemDownNW(SymId id) const;
|
|
QPointF symStemUpSE(SymId id) const;
|
|
QPointF symCutOutNE(SymId id) const;
|
|
QPointF symCutOutNW(SymId id) const;
|
|
QPointF symCutOutSE(SymId id) const;
|
|
QPointF symCutOutSW(SymId id) const;
|
|
qreal symAdvance(SymId id) const;
|
|
std::vector<SymId> toTimeSigString(const QString& s) const;
|
|
bool symIsValid(SymId id) const;
|
|
|
|
bool concertPitch() const;
|
|
|
|
virtual Element* nextElement(); //< Used for navigation
|
|
virtual Element* prevElement(); //< next-element and prev-element command
|
|
|
|
virtual QString accessibleInfo() const; //< used to populate the status bar
|
|
virtual QString screenReaderInfo() const { //< by default returns accessibleInfo, but can be overriden
|
|
return accessibleInfo();
|
|
}
|
|
// if the screen-reader needs a special string (see note for example)
|
|
virtual QString accessibleExtraInfo() const { // used to return info that will be appended to accessibleInfo
|
|
return QString(); // and passed only to the screen-reader
|
|
}
|
|
|
|
virtual void triggerLayout() const;
|
|
|
|
};
|
|
|
|
//---------------------------------------------------------
|
|
// ElementList
|
|
//---------------------------------------------------------
|
|
|
|
class ElementList : public std::vector<Element*> {
|
|
public:
|
|
ElementList() {}
|
|
bool remove(Element*);
|
|
void replace(Element* old, Element* n);
|
|
void write(XmlWriter&) const;
|
|
void write(XmlWriter&, const char* name) const;
|
|
};
|
|
|
|
//---------------------------------------------------------
|
|
// @@ Line
|
|
//---------------------------------------------------------
|
|
|
|
class Line : public Element {
|
|
Q_GADGET
|
|
|
|
qreal _width;
|
|
qreal _len;
|
|
|
|
protected:
|
|
bool vertical;
|
|
|
|
public:
|
|
Line(Score*);
|
|
Line(Score*, bool vertical);
|
|
Line &operator=(const Line&);
|
|
|
|
virtual Line* clone() const override { return new Line(*this); }
|
|
virtual ElementType type() const override { return ElementType::LINE; }
|
|
virtual void layout() override;
|
|
|
|
virtual void draw(QPainter*) const override;
|
|
void writeProperties(XmlWriter& xml) const;
|
|
bool readProperties(XmlReader&);
|
|
|
|
qreal len() const { return _len; }
|
|
qreal lineWidth() const { return _width; }
|
|
void setLen(qreal v) { _len = v; }
|
|
void setLineWidth(qreal v) { _width = v; }
|
|
|
|
virtual void spatiumChanged(qreal /*oldValue*/, qreal /*newValue*/) override;
|
|
};
|
|
|
|
//---------------------------------------------------------
|
|
// @@ Compound
|
|
//---------------------------------------------------------
|
|
|
|
class Compound : public Element {
|
|
Q_GADGET
|
|
|
|
QList<Element*> elements;
|
|
|
|
protected:
|
|
const QList<Element*>& getElements() const { return elements; }
|
|
|
|
public:
|
|
Compound(Score*);
|
|
Compound(const Compound&);
|
|
virtual ElementType type() const = 0;
|
|
|
|
virtual void draw(QPainter*) const;
|
|
virtual void addElement(Element*, qreal x, qreal y);
|
|
void clear();
|
|
virtual void setSelected(bool f);
|
|
virtual void setVisible(bool);
|
|
virtual void layout();
|
|
};
|
|
|
|
extern bool elementLessThan(const Element* const, const Element* const);
|
|
extern void collectElements(void* data, Element* e);
|
|
|
|
|
|
} // namespace Ms
|
|
|
|
Q_DECLARE_METATYPE(Ms::ElementType);
|
|
Q_DECLARE_METATYPE(Ms::Element::Placement);
|
|
|
|
#endif
|
|
|