ColorSpace.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFColorSpace
#define PDFTRON_H_CPPPDFColorSpace
 
#include <C/PDF/TRN_ColorSpace.h>
#include <Common/Common.h>
#include <PDF/Function.h>
 
namespace pdftron { 
    namespace PDF {
 

class ColorPt
{
public:

    explicit ColorPt(double x = 0, double y = 0, double z = 0, double w = 0);
    ColorPt(const ColorPt& co);
    ~ColorPt();
 
    ColorPt& operator= (const ColorPt& co);
    bool operator== (const ColorPt& co) const;

    void Set(double x = 0, double y = 0, double z = 0, double w = 0);

    void Set(int colorant_index, double colorant_value);

    double Get(int colorant_index) const;

    void SetColorantNum(int num);

     void Destroy();
 
// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
    TRN_ColorPt m_c;
#endif
// @endcond
};
 
 
class ColorSpace
{
public:
 
    // Common ColorSpace methods ----------------------------------------------------

     static ColorSpace CreateDeviceGray();

     static ColorSpace CreateDeviceRGB();

     static ColorSpace CreateDeviceCMYK();

     static ColorSpace CreatePattern();

    static ColorSpace CreateICC(SDF::SDFDoc& doc, const UString& filepath);
    static ColorSpace CreateICC(SDF::SDFDoc& doc, Filters::Filter stm);
    static ColorSpace CreateICC(SDF::SDFDoc& doc, const UChar* buf, size_t buf_sz);

     ColorSpace (SDF::Obj color_space = 0);
     ColorSpace(const ColorSpace& c);
     ColorSpace& operator=(const ColorSpace& c);

     ~ColorSpace();
    
    enum Type
    {
        e_device_gray,
        e_device_rgb,
        e_device_cmyk,
        e_cal_gray,
        e_cal_rgb,
        e_lab,
        e_icc,
        e_indexed,
        e_pattern,
        e_separation,
        e_device_n,
        e_null
    };
 
    // Common Static/Global methods ----------------------------------------------------
 
#ifndef SWIG 
     static int GetComponentNum(Type cs_type, SDF::Obj cs);
 
     static Type GetType(SDF::Obj cs);
#endif
 
     Type GetType() const;

     SDF::Obj GetSDFObj ();
 
     int GetComponentNum();

     void InitColor(ColorPt& out_colorants);

     void InitComponentRanges(std::vector<double>& out_decode_low, std::vector<double>& out_decode_range);

     ColorPt Convert2Gray(const ColorPt& in_color);
 
#ifndef SWIG
     void Convert2Gray(const ColorPt& in_color, ColorPt& out_color);
#endif

     ColorPt Convert2RGB(const ColorPt& in_color);
 
#ifndef SWIG
     void Convert2RGB(const ColorPt& in_color, ColorPt& out_color);
#endif

     ColorPt Convert2CMYK(const ColorPt& in_color);
 
#ifndef SWIG
     void Convert2CMYK(const ColorPt& in_color, ColorPt& out_color);
#endif

     ColorSpace GetAlternateColorSpace();

     ColorSpace GetBaseColorSpace();
 
    // Indexed color space methods --------------------------------------------------

     int GetHighVal();
 
#ifndef SWIG
     const UChar* GetLookupTable();
#endif

     ColorPt GetBaseColor(UChar color_idx);
 
#ifndef SWIG
     void GetBaseColor(UChar color_idx, ColorPt& out_color);
#endif
 
    // Separation of DeviceN color space methods ------------------------------------

     bool IsNone();
 
    // Separation color space methods -----------------------------------------------

     bool IsAll();

     Function GetTintFunction();

     void Destroy();
 
// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
    ColorSpace(TRN_ColorSpace impl);
    TRN_ColorSpace mp_cs;
#endif
// @endcond
};
 
 
#include <Impl/ColorSpace.inl>
 
    };  // namespace PDF
};  // namespace pdftron
 
#endif