File indexing completed on 2024-05-12 15:59:36

 /*
  *  SPDX-FileCopyrightText: 2005 Bart Coppens <kde@bartcoppens.be>
  *
  *  SPDX-License-Identifier: LGPL-2.1-or-later
  */
 
 #ifndef _KO_HISTOGRAM_PRODUCER_
 #define _KO_HISTOGRAM_PRODUCER_
 
 #include <QtGlobal>
 
 #include "kritapigment_export.h"
 
 #include <KoGenericRegistry.h>
 #include <KoID.h>
 
 class QString;
 class KoChannelInfo;
 class KoColorSpace;
 
 /**
  * This class is an interface used in the generation of a histogram. It is a container of
  * data, all mathematically interesting things will calculated by an histogram.
  *
  * The default view will be the entire range each color can be in. And don't let the
  * numberOfBins return anything else then 256 unless you have a very good reason for it.
  *
  * About the views: a view is a zoom combined with a start level: the entire
  * range of a channel is 0.0 - 1.0: this is the position. Combined with a zoom, we can
  * calculate what part of a channel will fall in a bin. This gives us an interface to
  * that the views that is not dependent of the actual colorspace of the histogram.
  * The 'size' value is the size, again from 0.0 to 1.0 of the displayed range.
  *
  * For comfort of the GUI, and because it is logical, channels are accessed in the order
  * in which they are found in the channels() method. This is potentially different from
  * the order in which they are internally ordered!
  **/
 class KRITAPIGMENT_EXPORT KoHistogramProducer
 {
 public:
     KoHistogramProducer() : m_skipTransparent(true), m_skipUnselected(true) {}
     virtual ~KoHistogramProducer() {}
 
     // Methods to change the bins
 
     /** Clears the data in this producer, but keeps its other settings */
     virtual void clear() = 0;
 
     /**
      * Adds the values from the specified array of pixels to the bins -- does not
      * reset anything.
      *
      * @param pixels A pointer an array of pixeldata in the given colorspace
      * @param selectionMask a pointer to an array of bytes, where 0 is unselected and 1-255 is degree of selectedness. The array
      *                      must be just as long as the array of pixels.
      * @param nPixels The number of pixels
      * @param colorSpace the colorspace that can decode the pixel data.
      */
     virtual void addRegionToBin(const quint8 * pixels, const quint8 * selectionMask, quint32 nPixels, const KoColorSpace* colorSpace) = 0;
 
     // Methods to set what exactly is being added to the bins
     virtual void setView(qreal from, qreal width) = 0;
     virtual void setSkipTransparent(bool set) {
         m_skipTransparent = set;
     }
     virtual void setSkipUnselected(bool set) {
         m_skipUnselected = set;
     }
 
     // Methods with general information about this specific producer
     virtual const KoID& id() const = 0;
     virtual QList<KoChannelInfo *> channels() = 0;
     virtual qint32 numberOfBins() = 0;
     virtual QString positionToString(qreal pos) const = 0;
     virtual qreal viewFrom() const = 0;
     virtual qreal viewWidth() const = 0;
     virtual qreal maximalZoom() const = 0;
 
     // Methods to get information on the data we have seen
     virtual qint32 count() = 0;
     virtual qint32 getBinAt(qint32 channel, qint32 position) = 0;
     virtual qint32 outOfViewLeft(qint32 channel) = 0;
     virtual qint32 outOfViewRight(qint32 channel) = 0;
 protected:
     bool m_skipTransparent;
     bool m_skipUnselected;
 };
 
 class KRITAPIGMENT_EXPORT KoHistogramProducerFactory
 {
 public:
     explicit KoHistogramProducerFactory(const KoID &id) : m_id(id) {}
     virtual ~KoHistogramProducerFactory() {}
 
     /// Factory method, generates a new KoHistogramProducer
     virtual KoHistogramProducer *generate() = 0;
 
     /// Returns if a colorspace can be used with this producer
     virtual bool isCompatibleWith(const KoColorSpace* colorSpace, bool strict = false) const = 0;
 
     /// Returns a float in the [0.0, 1.0] range, 0.0 means this is a very generic method
     virtual float preferrednessLevelWith(const KoColorSpace* colorSpace) const = 0;
 
     virtual QString id() const {
         return m_id.id();
     }
 
     virtual QString name() const {
         return m_id.name();
     }
 protected:
     KoID m_id;
 };
 
 
 class KRITAPIGMENT_EXPORT KoHistogramProducerFactoryRegistry
         : public KoGenericRegistry<KoHistogramProducerFactory*>
 {
 public:
     KoHistogramProducerFactoryRegistry();
     ~KoHistogramProducerFactoryRegistry() override;
     static KoHistogramProducerFactoryRegistry* instance();
     /// returns a list, sorted by preference: higher preference comes first
     QList<QString> keysCompatibleWith(const KoColorSpace* colorSpace, bool isStrict=false) const;
 
 private:
     KoHistogramProducerFactoryRegistry(const KoHistogramProducerFactoryRegistry&);
     KoHistogramProducerFactoryRegistry operator=(const KoHistogramProducerFactoryRegistry&);
 };
 
 #endif // _KO_HISTOGRAM_PRODUCER