kis_histogram_producer.h

/*
 *  Copyright (c) 2005 Bart Coppens <kde@bartcoppens.be>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
 
#ifndef _KIS_HISTOGRAM_PRODUCER_
#define _KIS_HISTOGRAM_PRODUCER_
 
#include <tqglobal.h>
#include <ksharedptr.h>
 
#include <kis_colorspace.h>
 
#include "kis_generic_registry.h"
 
class KisRectIteratorPixel;
class TQString;
class KisChannelInfo;

class KisHistogramProducer : public TDEShared {
public:
    KisHistogramProducer() : m_skipTransparent(true), m_skipUnselected(true) {}
    virtual ~KisHistogramProducer() {}
 
    // Methods to change the bins

    virtual void clear() = 0;

    virtual void addRegionToBin(TQ_UINT8 * pixels, TQ_UINT8 * selectionMask, TQ_UINT32 nPixels, KisColorSpace* colorSpace) = 0;
 
    // Methods to set what exactly is being added to the bins
    virtual void setView(double from, double 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 KisID& id() const = 0;
    virtual TQValueVector<KisChannelInfo *> channels() = 0;
    virtual TQ_INT32 numberOfBins() = 0;
    virtual TQString positionToString(double pos) const = 0;
    virtual double viewFrom() const = 0;
    virtual double viewWidth() const = 0;
    virtual double maximalZoom() const = 0;
 
    // Methods to get information on the data we have seen
    virtual TQ_INT32 count() = 0;
    virtual TQ_INT32 getBinAt(TQ_INT32 channel, TQ_INT32 position) = 0;
    virtual TQ_INT32 outOfViewLeft(TQ_INT32 channel) = 0;
    virtual TQ_INT32 outOfViewRight(TQ_INT32 channel) = 0;
protected:
    bool m_skipTransparent;
    bool m_skipUnselected;
};
 
typedef TDESharedPtr<KisHistogramProducer> KisHistogramProducerSP;
 
class KisHistogramProducerFactory {
public:
    KisHistogramProducerFactory(const KisID& id) : m_id(id) {}
    virtual ~KisHistogramProducerFactory() {}
    virtual KisHistogramProducerSP generate() = 0;
    virtual bool isCompatibleWith(KisColorSpace* colorSpace) const = 0;
    virtual float preferrednessLevelWith(KisColorSpace* colorSpace) const = 0;
    virtual const KisID& id() const { return m_id; }
protected:
    KisID m_id;
};
 
class KisHistogramProducerFactoryRegistry
    : public KisGenericRegistry<KisHistogramProducerFactory*> {
public:
    virtual ~KisHistogramProducerFactoryRegistry();
    static KisHistogramProducerFactoryRegistry* instance();
    KisIDList listKeysCompatibleWith(KisColorSpace* colorSpace) const;
 
private:
   KisHistogramProducerFactoryRegistry();
   KisHistogramProducerFactoryRegistry(const KisHistogramProducerFactoryRegistry&);
   KisHistogramProducerFactoryRegistry operator=(const KisHistogramProducerFactoryRegistry&);
 
   static KisHistogramProducerFactoryRegistry* m_singleton;
};
 
#endif // _KIS_HISTOGRAM_PRODUCER