inkscape/src/sp-mask.h

	sp-mask.h revision bd9c691d934ed2c727b54c8d3a658cbcddc97754
#ifndef SEEN_SP_MASK_H
#define SEEN_SP_MASK_H

/*
 * SVG <mask> implementation
 *
 * Authors:
 *   Lauris Kaplinski <lauris@kaplinski.com>
 *   Abhishek Sharma
 *
 * Copyright (C) 2003 authors
 *
 * Released under GNU GPL, read the file 'COPYING' for more information
 */

#include <2geom/rect.h>
#include "sp-object-group.h"
#include "uri-references.h"
#include "xml/node.h"

#define SP_TYPE_MASK (sp_mask_get_type ())
#define SP_MASK(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), SP_TYPE_MASK, SPMask))
#define SP_MASK_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), SP_TYPE_MASK, SPMaskClass))
#define SP_IS_MASK(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), SP_TYPE_MASK))
#define SP_IS_MASK_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), SP_TYPE_MASK))

class SPMask;
class SPMaskClass;
class SPMaskView;

class CMask;

namespace Inkscape {

class Drawing;
class DrawingItem;

} // namespace Inkscape


class SPMask : public SPObjectGroup {
public:
    CMask* cmask;

    unsigned int maskUnits_set : 1;
    unsigned int maskUnits : 1;

    unsigned int maskContentUnits_set : 1;
    unsigned int maskContentUnits : 1;

    SPMaskView *display;
};

struct SPMaskClass {
    SPObjectGroupClass parent_class;
};

class CMask : public CObjectGroup {
public:
    CMask(SPMask* mask);
    virtual ~CMask();

    virtual void onBuild(SPDocument* doc, Inkscape::XML::Node* repr);
    virtual void onRelease();

    virtual void onChildAdded(Inkscape::XML::Node* child, Inkscape::XML::Node* ref);

    virtual void onSet(unsigned int key, const gchar* value);

    virtual void onUpdate(SPCtx* ctx, unsigned int flags);
    virtual void onModified(unsigned int flags);

    virtual Inkscape::XML::Node* onWrite(Inkscape::XML::Document* doc, Inkscape::XML::Node* repr, guint flags);

protected:
    SPMask* spmask;
};

GType sp_mask_get_type (void);

class SPMaskReference : public Inkscape::URIReference {
public:
    SPMaskReference(SPObject *obj) : URIReference(obj) {}
    SPMask *getObject() const {
        return static_cast<SPMask *>(URIReference::getObject());
    }
protected:
    /**
     * If the owner element of this reference (the element with <... mask="...">)
     * is a child of the mask it refers to, return false.
     * \return false if obj is not a mask or if obj is a parent of this
     *         reference's owner element.  True otherwise.
     */
    virtual bool _acceptObject(SPObject *obj) const {
        if (!SP_IS_MASK(obj)) {
            return false;
        }
        SPObject * const owner = this->getOwner();
        if (obj->isAncestorOf(owner)) {
      //XML Tree being used directly here while it shouldn't be...
      Inkscape::XML::Node * const owner_repr = owner->getRepr();
      //XML Tree being used directly here while it shouldn't be...
      Inkscape::XML::Node * const obj_repr = obj->getRepr();
            gchar const * owner_name = NULL;
            gchar const * owner_mask = NULL;
            gchar const * obj_name = NULL;
            gchar const * obj_id = NULL;
            if (owner_repr != NULL) {
                owner_name = owner_repr->name();
                owner_mask = owner_repr->attribute("mask");
            }
            if (obj_repr != NULL) {
                obj_name = obj_repr->name();
                obj_id = obj_repr->attribute("id");
            }
            g_warning("Ignoring recursive mask reference "
                      "<%s mask=\"%s\"> in <%s id=\"%s\">",
                      owner_name, owner_mask,
                      obj_name, obj_id);
            return false;
        }
        return true;
    }
};

Inkscape::DrawingItem *sp_mask_show (SPMask *mask, Inkscape::Drawing &drawing, unsigned int key);
void sp_mask_hide (SPMask *mask, unsigned int key);

void sp_mask_set_bbox (SPMask *mask, unsigned int key, Geom::OptRect const &bbox);

const gchar *sp_mask_create (GSList *reprs, SPDocument *document, Geom::Affine const* applyTransform);

#endif // SEEN_SP_MASK_H