devicecontextbase.h

// Name:        devicecontextbase.h
// Author:      Laurent Pugin
// Created:     2015
// Copyright (c) Authors and others. All rights reserved.
 
#ifndef __VRV_DC_BASE_H__
#define __VRV_DC_BASE_H__
 
#include <algorithm>
#include <string>
 
//----------------------------------------------------------------------------
 
#include "attdef.h"
#include "vrvdef.h"
 
namespace vrv {
 
class Doc;
 
#define COLOR_NONE -1
#define COLOR_WHITE 255 << 16 | 255 << 8 | 255
#define COLOR_BLACK 0
#define COLOR_RED 255 << 16
#define COLOR_BLUE 255
#define COLOR_GREEN 255 << 8
#define COLOR_CYAN 255 << 8 | 255
#define COLOR_LIGHT_GREY 127 << 16 | 127 << 8 | 127
 
#undef max
#undef min
 
enum PenStyle : int8_t { PEN_SOLID = 0, PEN_DOT, PEN_LONG_DASH, PEN_SHORT_DASH, PEN_DOT_DASH };
 
enum LineCapStyle : int8_t { LINECAP_DEFAULT = 0, LINECAP_BUTT, LINECAP_ROUND, LINECAP_SQUARE };
 
enum LineJoinStyle : int8_t {
    LINEJOIN_DEFAULT = 0,
    LINEJOIN_ARCS,
    LINEJOIN_BEVEL,
    LINEJOIN_MITER,
    LINEJOIN_MITER_CLIP,
    LINEJOIN_ROUND
};
 
// ---------------------------------------------------------------------------
// Pen/Brush
// ---------------------------------------------------------------------------
 
class Pen {
public:
    Pen()
        : m_width(0)
        , m_style(PEN_SOLID)
        , m_dashLength(0)
        , m_gapLength(0)
        , m_lineCap(LINECAP_DEFAULT)
        , m_lineJoin(LINEJOIN_DEFAULT)
        , m_opacity(-1.0)
        , m_color(COLOR_NONE)
    {
    }
    Pen(int width, PenStyle style, int dashLength, int gapLength, LineCapStyle lineCap, LineJoinStyle lineJoin,
        float opacity, int color)
        : m_width(width)
        , m_style(style)
        , m_dashLength(dashLength)
        , m_gapLength(gapLength)
        , m_lineCap(lineCap)
        , m_lineJoin(lineJoin)
        , m_opacity(opacity)
        , m_color(color)
    {
    }
 
    int GetColor() const { return m_color; }
    void SetColor(int color) { m_color = color; }
    bool HasColor() const { return (m_color != COLOR_NONE); }
    int GetWidth() const { return m_width; }
    void SetWidth(int width) { m_width = width; }
    int GetDashLength() const { return m_dashLength; }
    void SetDashLength(int dashLength) { m_dashLength = dashLength; }
    int GetGapLength() const { return m_gapLength; }
    void SetGapLength(int gapLength) { m_gapLength = gapLength; }
    LineCapStyle GetLineCap() const { return m_lineCap; }
    void SetLineCap(LineCapStyle lineCap) { m_lineCap = lineCap; }
    LineJoinStyle GetLineJoin() const { return m_lineJoin; }
    void SetLineJoin(LineJoinStyle lineJoin) { m_lineJoin = lineJoin; }
    PenStyle GetStyle() const { return m_style; }
    void SetStyle(PenStyle style) { m_style = style; }
    float GetOpacity() const { return m_opacity; }
    void SetOpacity(float opacity) { m_opacity = opacity; }
    bool HasOpacity() const { return (m_opacity != -1.0); }
 
private:
    int m_width;
    PenStyle m_style;
    int m_dashLength, m_gapLength;
    LineCapStyle m_lineCap;
    LineJoinStyle m_lineJoin;
    float m_opacity;
    int m_color;
};
 
class Brush {
public:
    Brush() : m_opacity(-1.0), m_color(COLOR_NONE) {}
    Brush(float opacity, int color) : m_opacity(opacity), m_color(color) {}
 
    int GetColor() const { return m_color; }
    void SetColor(int color) { m_color = color; }
    bool HasColor() const { return (m_color != COLOR_NONE); }
    float GetOpacity() const { return m_opacity; }
    void SetOpacity(float opacity) { m_opacity = opacity; }
    bool HasOpacity() const { return (m_opacity != -1.0); }
 
private:
    float m_opacity;
    int m_color;
};
 
// ---------------------------------------------------------------------------
// FontInfo
// ---------------------------------------------------------------------------
 
class FontInfo {
public:
    FontInfo()
    {
        m_pointSize = 0;
        m_letterSpacing = 0.0;
        m_family = 0; // was wxFONTFAMILY_DEFAULT;
        m_style = FONTSTYLE_NONE;
        m_weight = FONTWEIGHT_NONE;
        m_underlined = false;
        m_supSubScript = false;
        m_faceName.clear();
        m_encoding = 0; // was wxFONTENCODING_DEFAULT;
        m_widthToHeightRatio = 1.0;
        m_smuflFont = SMUFL_NONE;
    }
    virtual ~FontInfo() {}
 
    // accessors and modifiers for the font elements
    int GetPointSize() const { return m_pointSize; }
    int GetLetterSpacing() const { return m_letterSpacing; }
    data_FONTSTYLE GetStyle() const { return m_style; }
    data_FONTWEIGHT GetWeight() const { return m_weight; }
    bool GetUnderlined() const { return m_underlined; }
    bool GetSupSubScript() const { return m_supSubScript; }
    std::string GetFaceName() const { return m_faceName; }
    int GetFamily() const { return m_family; }
    int GetEncoding() const { return m_encoding; }
    float GetWidthToHeightRatio() const { return m_widthToHeightRatio; }
    SmuflTextFont GetSmuflFont() const { return m_smuflFont; }
 
    void SetPointSize(int pointSize) { m_pointSize = pointSize; }
    void SetLetterSpacing(double letterSpacing) { m_letterSpacing = letterSpacing; }
    void SetStyle(data_FONTSTYLE style) { m_style = style; }
    void SetWeight(data_FONTWEIGHT weight) { m_weight = weight; }
    void SetUnderlined(bool underlined) { m_underlined = underlined; }
    void SetSupSubScript(bool supSubScript) { m_supSubScript = supSubScript; }
    void SetFaceName(const std::string &faceName) { m_faceName = faceName; }
    void SetFamily(int family) { m_family = family; }
    void SetEncoding(int encoding) { m_encoding = encoding; }
    void SetWidthToHeightRatio(float ratio) { m_widthToHeightRatio = ratio; }
    void SetSmuflFont(SmuflTextFont smuflFont) { m_smuflFont = smuflFont; }
    void SetSmuflWithFallback(bool fallback) { m_smuflFont = (fallback) ? SMUFL_FONT_FALLBACK : SMUFL_FONT_SELECTED; }
 
private:
    int m_pointSize;
    int m_letterSpacing;
    int m_family;
    data_FONTSTYLE m_style;
    data_FONTWEIGHT m_weight;
    bool m_underlined;
    bool m_supSubScript;
    std::string m_faceName;
    int m_encoding;
    float m_widthToHeightRatio;
    SmuflTextFont m_smuflFont;
};
 
// ---------------------------------------------------------------------------
// Point
// ---------------------------------------------------------------------------
 
class Point {
public:
    int x, y;
 
    Point() : x(0), y(0) {}
    Point(int xx, int yy) : x(xx), y(yy) {}
 
    // no copy ctor or assignment operator - the defaults are ok
 
    // comparison
    bool operator==(const Point &p) const { return x == p.x && y == p.y; }
    bool operator!=(const Point &p) const { return !(*this == p); }
 
    // arithmetic operations (component wise)
    Point operator+(const Point &p) const { return { x + p.x, y + p.y }; }
    Point operator-(const Point &p) const { return { x - p.x, y - p.y }; }
 
    Point &operator+=(const Point &p)
    {
        x += p.x;
        y += p.y;
        return *this;
    }
    Point &operator-=(const Point &p)
    {
        x -= p.x;
        y -= p.y;
        return *this;
    }
 
    Point operator-() const { return { -x, -y }; }
 
    static Point Min(const Point &p1, const Point &p2)
    {
        int x = std::min(p1.x, p2.x);
        int y = std::min(p1.y, p2.y);
        return { x, y };
    }
 
    static Point Max(const Point &p1, const Point &p2)
    {
        int x = std::max(p1.x, p2.x);
        int y = std::max(p1.y, p2.y);
        return { x, y };
    }
};
 
// ---------------------------------------------------------------------------
// BezierCurve
// ---------------------------------------------------------------------------
 
class BezierCurve {
public:
    Point p1; // start point
    Point c1, c2; // control points
    Point p2; // end point
 
    // no copy ctor or assignment operator - the defaults are ok
 
    BezierCurve() {}
    BezierCurve(const Point &p1, const Point &c1, const Point &c2, const Point &p2) : p1(p1), c1(c1), c2(c2), p2(p2) {}
 
    // Helper to rotate all points within bezier curve around \@rotationPoint by \@angle
    void Rotate(float angle, const Point &rotationPoint);
 
    void SetControlOffset(int offset) { m_leftControlOffset = m_rightControlOffset = offset; }
    void SetLeftControlOffset(int offset) { m_leftControlOffset = offset; }
    void SetRightControlOffset(int offset) { m_rightControlOffset = offset; }
    int GetLeftControlOffset() const { return m_leftControlOffset; }
    int GetRightControlOffset() const { return m_rightControlOffset; }
 
    void SetControlHeight(int height) { m_leftControlHeight = m_rightControlHeight = height; }
    void SetLeftControlHeight(int height) { m_leftControlHeight = height; }
    void SetRightControlHeight(int height) { m_rightControlHeight = height; }
    int GetLeftControlHeight() const { return m_leftControlHeight; }
    int GetRightControlHeight() const { return m_rightControlHeight; }
 
    void SetControlSides(bool leftAbove, bool rightAbove);
    bool IsLeftControlAbove() const { return m_leftControlAbove; }
    bool IsRightControlAbove() const { return m_rightControlAbove; }
 
    void CalcInitialControlPointParams();
    void CalcInitialControlPointParams(const Doc *doc, float angle, int staffSize);
 
    void UpdateControlPointParams();
    void UpdateControlPoints();
 
    std::pair<double, double> EstimateCurveParamForControlPoints() const;
 
private:
    // Control point X-axis offset for both start/end points
    int m_leftControlOffset = 0;
    int m_rightControlOffset = 0;
    int m_leftControlHeight = 0;
    int m_rightControlHeight = 0;
    bool m_leftControlAbove = true;
    bool m_rightControlAbove = true;
 
    // no copy ctor or assignment operator - the defaults are ok
};
 
// ---------------------------------------------------------------------------
// TextExtend
// ---------------------------------------------------------------------------
 
class TextExtend {
public:
    int m_width, m_height, m_leftBearing, m_ascent, m_descent, m_advX;
 
    TextExtend() : m_width(0), m_height(0), m_leftBearing(0), m_ascent(0), m_descent(0), m_advX(0) {}
 
    // no copy ctor or assignment operator - the defaults are ok
};
 
} // namespace vrv
 
#endif // __AX_DC_BASE_H__