svg-length.h

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0-or-later
#ifndef SEEN_SP_SVG_LENGTH_H
#define SEEN_SP_SVG_LENGTH_H
 
#include <string>
#include <optional>
 
class SVGLength {
public:
    SVGLength();
 
    enum Unit {
        NONE,
        PX,
        PT,
        PC,
        MM,
        CM,
        INCH,
        EM,
        EX,
        PERCENT,
        LAST_UNIT = PERCENT
    };
 
    // The object's value is valid / exists in SVG.
    bool _set;
 
    // The unit of value.
    Unit unit;
 
    // The value of this SVGLength as found in the SVG.
    float value;
 
    // The value in pixels (value * pixels/unit).
    float computed;
 
    float operator=(float v) {
        _set = true;
        unit = NONE;
        value = computed = v;
        return v;
    }
 
    bool operator==(const SVGLength& rhs) const {
        if (rhs.unit == unit) {
            if (unit == SVGLength::PERCENT)
                return value == rhs.value;
            return computed == rhs.computed;
        }
        return false;
    }
    bool operator!=(const SVGLength& rhs) const {
        return !(*this == rhs);
    }
 
    operator bool() const { return _set; }
 
    bool read(char const *str);
    void readOrUnset(char const *str, Unit u = NONE, float v = 0, float c = 0);
    bool readAbsolute(char const *str);
    std::string getUnit() const;
    bool isAbsolute();
 
    std::string write() const;
    std::string toString(const std::string &unit, double doc_scale, std::optional<unsigned int> precision = {}, bool add_unit = true) const;
    double toValue(const std::string &out_unit) const;
    bool fromString(const std::string &input, const std::string &unit, std::optional<double> scale = {});
 
    // To set 'v' use '='
    void set(Unit u, float v); // Sets computed value based on u and v.
    void set(Unit u, float v, float c); // Sets all three values.
    void unset(Unit u = NONE, float v = 0, float c = 0);
    void scale(double scale); // Scales length (value, computed), leaving unit alone.
    void update(double em, double ex, double scale); // Updates computed value
};
 
char const *sp_svg_length_get_css_units(SVGLength::Unit unit);
bool svg_length_absolute_unit(SVGLength::Unit unit);
 
namespace Inkscape {
char const *refX_named_to_percent(char const *str);
char const *refY_named_to_percent(char const *str);
} // namespace Inkscape
 
#endif // SEEN_SP_SVG_LENGTH_H
 
/*
  Local Variables:
  mode:c++
  c-file-style:"stroustrup"
  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
  indent-tabs-mode:nil
  fill-column:99
  End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8 :