PdfColor.h

// SPDX-FileCopyrightText: 2005 Dominik Seichter <domseichter@web.de>
// SPDX-License-Identifier: LGPL-2.0-or-later OR MPL-2.0
 
#ifndef PDF_COLOR_H
#define PDF_COLOR_H
 
#include "PdfName.h"
#include "PdfArray.h"
 
namespace PoDoFo {
 
using PdfColorRaw = std::array<double, 6>;
 
class PODOFO_API PdfColor final
{
public:
    PdfColor();
 
    explicit PdfColor(double gray);
 
    PdfColor(double red, double green, double blue);
 
    PdfColor(double cyan, double magenta, double yellow, double black);
 
    PdfColor(const PdfColor& rhs) = default;
 
public:
    static bool TryCreateFromObject(const PdfObject& obj, PdfColor& color);
    static PdfColor CreateFromObject(const PdfObject& obj);
 
    static PdfColor CreateTransparent();
 
public:
    bool IsGrayScale() const;
 
    bool IsRGB() const;
 
    bool IsCMYK() const;
 
    bool IsTransparent() const;
 
    inline PdfColorSpaceType GetColorSpace() const { return m_ColorSpace; }
 
    double GetGrayScale() const;
 
    double GetRed() const;
 
    double GetGreen() const;
 
    double GetBlue() const;
 
    double GetCyan() const;
 
    double GetMagenta() const;
 
    double GetYellow() const;
 
    double GetBlack() const;
 
    PdfColor ConvertToGrayScale() const;
 
    PdfColor ConvertToRGB() const;
 
    PdfColor ConvertToCMYK() const;
 
    PdfArray ToArray() const;
 
    static PdfColor CreateFromString(const std::string_view& name);
 
public:
    unsigned char GetComponentCount() const { return m_ComponentCount; }
 
    const PdfColorRaw& GetRawColor() const { return m_RawColor; }
 
    PdfColor& operator=(const PdfColor& rhs) = default;
 
    bool operator==(const PdfColor& rhs) const;
 
    bool operator!=(const PdfColor& rhs) const;
 
private:
    PdfColor(bool isTransparent, PdfColorSpaceType colorSpace, unsigned char componentCount, const PdfColorRaw& data);
 
    static bool tryCreateFromArray(const PdfArray& arr, PdfColor& color);
 
private:
    bool m_IsTransparent;
    PdfColorSpaceType m_ColorSpace;
    unsigned char m_ComponentCount;
    PdfColorRaw m_RawColor;
};
 
};
 
#endif // PDF_COLOR_H