Outline.h

Go to the documentation of this file.

 
// ###########################################################################################################################################################################################################################################################################################################################
 
#pragma once
 
// OpenTwin header
#include "OTCore/Serializable.h"
#include "OTGui/Painter2D.h"
#include "OTGui/OTGuiAPIExport.h"
 
namespace ot {
 
    class OutlineF;
 
    enum LineStyle {
        NoLine,
        SolidLine,
        DashLine,
        DotLine,
        DashDotLine,
        DashDotDotLine
    };
 
    enum LineCapStyle {
        FlatCap,
        SquareCap,
        RoundCap
    };
 
    enum LineJoinStyle {
        MiterJoin,
        BevelJoin,
        RoundJoin,
        SvgMiterJoin
    };
    
    OT_GUI_API_EXPORT std::string toString(LineStyle _style);
    OT_GUI_API_EXPORT LineStyle stringToLineStyle(const std::string& _style);
 
    OT_GUI_API_EXPORT std::string toString(LineCapStyle _cap);
    OT_GUI_API_EXPORT LineCapStyle stringToCapStyle(const std::string& _cap);
 
    OT_GUI_API_EXPORT std::string toString(LineJoinStyle _join);
    OT_GUI_API_EXPORT LineJoinStyle stringToJoinStyle(const std::string& _join);
 
    class OT_GUI_API_EXPORT Outline : public ot::Serializable {
    public:
        Outline();
 
        Outline(const Color& _color);
 
        Outline(Painter2D* _painter);
 
        Outline(int _width, const Color& _color);
 
        Outline(int _width, Painter2D* _painter);
 
        Outline(const Outline& _other);
 
        ~Outline();
 
        Outline& operator = (const Outline& _other);
 
        virtual void addToJsonObject(ot::JsonValue& _object, ot::JsonAllocator& _allocator) const override;
 
        virtual void setFromJsonObject(const ot::ConstJsonObject& _object) override;
 
        void setColor(const Color& _color);
 
        void setPainter(Painter2D* _painter);
 
        constexpr inline const Painter2D* painter(void) const { return m_painter; };
 
        Painter2D* takePainter(void);
 
        constexpr inline void setWidth(int _w) { m_width = _w; };
 
        constexpr inline int width(void) const { return m_width; };
 
        constexpr inline void setStyle(LineStyle _style) { m_style = _style; };
 
        constexpr inline LineStyle style(void) const { return m_style; };
 
        constexpr inline void setCap(LineCapStyle _cap) { m_cap = _cap; };
 
        constexpr inline LineCapStyle cap(void) const { return m_cap; };
 
        constexpr inline void setJoinStyle(LineJoinStyle _join) { m_join = _join; };
 
        constexpr inline LineJoinStyle joinStyle(void) const { return m_join; };
 
        OutlineF toOutlineF(void) const;
 
    private:
        Painter2D* m_painter; 
        int m_width; 
        LineStyle m_style; 
        LineCapStyle m_cap; 
        LineJoinStyle m_join; 
    };
 
    // ###########################################################################################################################################################################################################################################################################################################################
 
    // ###########################################################################################################################################################################################################################################################################################################################
 
    // ###########################################################################################################################################################################################################################################################################################################################
 
    class OT_GUI_API_EXPORT OutlineF : public ot::Serializable {
    public:
        OutlineF();
 
        OutlineF(const Color& _color);
 
        OutlineF(Painter2D* _painter);
 
        OutlineF(double _width, const Color& _color);
 
        OutlineF(double _width, Painter2D* _painter);
 
        OutlineF(const OutlineF& _other);
 
        ~OutlineF();
 
        OutlineF& operator = (const OutlineF& _other);
 
        virtual void addToJsonObject(ot::JsonValue& _object, ot::JsonAllocator& _allocator) const override;
 
        virtual void setFromJsonObject(const ot::ConstJsonObject& _object) override;
 
        void setColor(const Color& _color);
 
        void setPainter(Painter2D* _painter);
 
        constexpr inline const Painter2D* painter(void) const { return m_painter; };
 
        Painter2D* takePainter(void);
 
        constexpr inline void setWidth(double _w) { m_width = _w; };
 
        constexpr inline double width(void) const { return m_width; };
 
        constexpr inline void setStyle(LineStyle _style) { m_style = _style; };
 
        constexpr inline LineStyle style(void) const { return m_style; };
 
        constexpr inline void setCap(LineCapStyle _cap) { m_cap = _cap; };
 
        constexpr inline LineCapStyle cap(void) const { return m_cap; };
 
        constexpr inline void setJoinStyle(LineJoinStyle _join) { m_join = _join; };
 
        constexpr inline LineJoinStyle joinStyle(void) const { return m_join; };
 
        Outline toOutline(void) const;
 
    private:
        Painter2D* m_painter; 
        double m_width; 
        LineStyle m_style; 
        LineCapStyle m_cap; 
        LineJoinStyle m_join; 
    };
 
}