CSubstractiveColorModel.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ACF-Commercial
#pragma once
 
 
// ACF includes
#include <iser/ISerializable.h>
#include <iser/CArchiveTag.h>
#include <icmm/CSubstractiveColorModelBase.h>
#include <ibase/TContainer.h>
#include <imod/TModelWrap.h>
#include <imod/CModelUpdateBridge.h>
 
 
namespace icmm
{
 
 
class CSubstractiveColorModel:
                     public CSubstractiveColorModelBase,
                     public ibase::CObservableListBase,
                     virtual public iser::ISerializable
{
public:
       typedef CSubstractiveColorModelBase BaseClass;
       typedef CObservableListBase BaseClass2;
 
       CSubstractiveColorModel();
       CSubstractiveColorModel(const ColorantIds& colorantIds);
       CSubstractiveColorModel(const CSubstractiveColorModel& other);
       CSubstractiveColorModel(const ISubstractiveColorModel& other);
 
       CSubstractiveColorModel& operator=(const CSubstractiveColorModel& other);
 
       bool operator==(const CSubstractiveColorModel& ref) const;
       bool operator!=(const CSubstractiveColorModel& ref) const;
 
       bool ContainsColorant(const ColorantId& colorantId) const;
 
       bool InsertColorant(const ColorantId& colorantId, ColorantUsage usage, int index = -1);
 
       bool RemoveColorant(const ColorantId& colorantId);
 
       bool SetColorantUsage(const ColorantId& colorantId, ColorantUsage usage);
 
       bool SetColorantId(const ColorantId& colorantId, const ColorantId& newColorantId);
 
       bool AppendColorModel(const ISubstractiveColorModel& other);
 
       bool HasProcessColorants() const;
 
       bool HasEcg() const;
 
       bool HasSpot() const;
 
       ColorantIds GetProcessColorants() const;
 
       ColorantIds GetEcgColorants() const;
 
       ColorantIds GetSpotColorants() const;
 
       // reimplemented ISubstractiveColorModel
       virtual std::unique_ptr<ISubstractiveColorModel> CreateSubspaceModel(const QStringList& colorantIds) const override;
 
       // reimplemented (icmm::IColorantList)
       virtual ColorantIds GetColorantIds() const override;
       virtual ColorantUsage GetColorantUsage(const ColorantId& colorantId) const override;
 
       // reimplemented (iser::ISerializable)
       virtual bool Serialize(iser::IArchive& archive) override;
 
       // reimplemented (istd::IChangeable)
       virtual int GetSupportedOperations() const override;
       virtual bool CopyFrom(const istd::IChangeable& object, CompatibilityMode mode = CM_WITHOUT_REFS) override;
       virtual istd::TUniqueInterfacePtr<istd::IChangeable> CloneMe(CompatibilityMode mode = CM_WITHOUT_REFS) const override;
 
       static std::unique_ptr<ISubstractiveColorModel> CreateSubspaceModelFrom(const CSubstractiveColorModelBase& model, const QStringList& colorantIds);
 
protected:
       struct ColorantInfo
       {
              ColorantId id;
              ColorantUsage usage = CU_NONE;
 
              inline bool operator==(const ColorantInfo& ref) const
              {
                     return (ref.id == id) && (ref.usage == usage);
              }
 
              inline bool operator!=(const ColorantInfo& ref)  const
              {
                     return !operator==(ref);
              }
       };
 
       typedef ibase::TContainer<ColorantInfo> ColorantInfoList;
 
protected:
       static icmm::ColorantUsage GetDefaultUsageFromColorantName(const ColorantId& colorantId);
       static ColorantId GetEcgGreen();
       static ColorantId GetEcgOrange();
       static ColorantId GetEcgViolet();
       static ColorantId GetEcgRed();
       static ColorantId GetEcgBlue();
 
       int FindColorantIndex(const ColorantId& colorantId) const;
       bool SerializeColorantInfo(
                            iser::IArchive& archive,
                            ColorantInfo& colorantInfo,
                            const iser::CArchiveTag* parentTagPtr) const;
 
private:
       imod::TModelWrap<ColorantInfoList> m_colorants;
       imod::CModelUpdateBridge m_bridge;
};
 
 
} // namespace icmm