kis_paint_layer.h

/*
 *  Copyright (c) 2005 Casper Boemann <cbr@boemann.dk>
 *
 *  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., 675 mass ave, cambridge, ma 02139, usa.
 */
#ifndef KIS_PAINT_LAYER_H_
#define KIS_PAINT_LAYER_H_
 
#include "kis_types.h"
#include "kis_layer.h"
#include "kis_paint_device.h"
#include "kis_colorspace.h"
class KisPaintLayer : public KisLayer, public KisLayerSupportsIndirectPainting {
    typedef KisLayer super;
 
    TQ_OBJECT
  
 
public:
    KisPaintLayer(KisImage *img, const TQString& name, TQ_UINT8 opacity, KisPaintDeviceSP dev);
    KisPaintLayer(KisImage *img, const TQString& name, TQ_UINT8 opacity);
    KisPaintLayer(KisImage *img, const TQString& name, TQ_UINT8 opacity, KisColorSpace * colorSpace);
    KisPaintLayer(const KisPaintLayer& rhs);
    virtual ~KisPaintLayer();
 
    virtual KisLayerSP clone() const;
public:
 
    // Called when the layer is made active
    virtual void activate() {}
 
    // Called when another layer is made active
    virtual void deactivate() {}
 
    virtual TQ_INT32 x() const;
    virtual void setX(TQ_INT32 x);
 
    virtual TQ_INT32 y() const;
    virtual void setY(TQ_INT32 y);
 
    virtual TQRect extent() const;
    virtual TQRect exactBounds() const;
 
    virtual void paintSelection(TQImage &img, TQ_INT32 x, TQ_INT32 y, TQ_INT32 w, TQ_INT32 h);
    virtual void paintSelection(TQImage &img, const TQRect& scaledImageRect, const TQSize& scaledImageSize, const TQSize& imageSize);
 
    virtual void paintMaskInactiveLayers(TQImage &img, TQ_INT32 x, TQ_INT32 y, TQ_INT32 w, TQ_INT32 h);
 
    virtual TQImage createThumbnail(TQ_INT32 w, TQ_INT32 h);
 
    virtual bool accept(KisLayerVisitor &v)
        {
//            kdDebug(41001) << "\tPAINT\t" << name()
//                    << " dirty: " << dirty() << "\n";
            return v.visit(this);
        }
 
 
    inline KisPaintDeviceSP paintDevice() const { return m_paintdev; }

    inline KisPaintDeviceSP paintDeviceOrMask() const {
        if (hasMask() && editMask())
            return m_mask;
        return m_paintdev;
    }
 
    // Mask Layer

    bool hasMask() const { return m_mask != 0; }
    // XXX TODO: Make these undo-able!
    KisPaintDeviceSP createMask();
    void createMaskFromPaintDevice(KisPaintDeviceSP from);
    void createMaskFromSelection(KisSelectionSP from);
    void removeMask();
    void applyMask();
    KisPaintDeviceSP getMask();
    KisSelectionSP getMaskAsSelection();

    KNamedCommand* createMaskCommand();
    KNamedCommand* maskFromSelectionCommand();
    KNamedCommand* maskToSelectionCommand();
    KNamedCommand* removeMaskCommand();
    KNamedCommand* applyMaskCommand();

    bool renderMask() const { return m_renderMask; }
    void setRenderMask(bool b);

    bool editMask() const { return m_editMask; }
    void setEditMask(bool b);

    virtual void setDirty(bool propagate = true);
    virtual void setDirty(const TQRect & rect, bool propagate = true);
 
    // KisLayerSupportsIndirectPainting
    virtual KisLayer* layer() { return this; }
signals:
    void sigMaskInfoChanged();
 
private:
    void convertMaskToSelection(const TQRect& r);
    void genericMaskCreationHelper();
    KisPaintDeviceSP m_paintdev;
    // Layer mask related:
    // XXX It would be nice to merge the next 2 devices...
    KisPaintDeviceSP m_mask; // The mask that we can edit and display easily
    KisSelectionSP m_maskAsSelection; // The mask as selection, to apply and render easily
    bool m_renderMask;
    bool m_editMask;
};
 
typedef TDESharedPtr<KisPaintLayer> KisPaintLayerSP;
 
#endif // KIS_PAINT_LAYER_H_