inkscape/src/sp-pattern.h

	sp-pattern.h revision ff167176a03ecdec32a72a475341dc6cf7ff7afe
/** @file
 * SVG <pattern> implementation
 *//*
 * Author:
 *   Lauris Kaplinski <lauris@kaplinski.com>
 *   Abhishek Sharma
 *
 * Copyright (C) 2002 Lauris Kaplinski
 *
 * Released under GNU GPL, read the file 'COPYING' for more information
 */

#ifndef SEEN_SP_PATTERN_H
#define SEEN_SP_PATTERN_H

#include <list>
#include <stddef.h>
#include <glibmm/ustring.h>
#include <sigc++/connection.h>

#include "svg/svg-length.h"
#include "sp-paint-server.h"
#include "uri-references.h"
#include "viewbox.h"

class SPPatternReference;
class SPItem;

namespace Inkscape {
namespace XML {

class Node;

}
}

#define SP_PATTERN(obj) (dynamic_cast<SPPattern*>((SPObject*)obj))
#define SP_IS_PATTERN(obj) (dynamic_cast<const SPPattern*>((SPObject*)obj) != NULL)

class SPPattern : public SPPaintServer, public SPViewBox {
public:
    enum PatternUnits {
        UNITS_USERSPACEONUSE,
        UNITS_OBJECTBOUNDINGBOX
    };

    SPPattern();
    virtual ~SPPattern();

    /* Reference (href) */
    Glib::ustring href;
    SPPatternReference *ref;

    gdouble get_x() const;
    gdouble get_y() const;
    gdouble get_width() const;
    gdouble get_height() const;
    Geom::OptRect get_viewbox() const;
    SPPattern::PatternUnits get_pattern_units() const;
    SPPattern::PatternUnits get_pattern_content_units() const;
    Geom::Affine const &get_transform() const;
    SPPattern *get_root(); //TODO: const

    SPPattern *clone_if_necessary(SPItem *item, const gchar *property);
    void transform_multiply(Geom::Affine postmul, bool set);

    /**
     * @brief create a new pattern in XML tree
     * @return created pattern id
     */
    static const gchar *produce(const std::list<Inkscape::XML::Node*> &reprs,
            Geom::Rect bounds, SPDocument *document, Geom::Affine transform, Geom::Affine move);

    bool isValid() const;
    virtual cairo_pattern_t* pattern_new(cairo_t *ct, Geom::OptRect const &bbox, double opacity);

protected:
    virtual void build(SPDocument* doc, Inkscape::XML::Node* repr);
    virtual void release();
    virtual void set(unsigned int key, const gchar* value);
    virtual void update(SPCtx* ctx, unsigned int flags);
    virtual void modified(unsigned int flags);

private:
    bool _has_item_children() const;
    void _get_children(std::list<SPObject*>& l);
    SPPattern *_chain() const;

    /**
    Count how many times pattern is used by the styles of o and its descendants
    */
    guint _count_hrefs(SPObject* o) const;

    /**
    Gets called when the pattern is reattached to another <pattern>
    */
    void _on_ref_changed(SPObject *old_ref, SPObject *ref);

    /**
    Gets called when the referenced <pattern> is changed
    */
    void _on_ref_modified(SPObject *ref, guint flags);

    /* patternUnits and patternContentUnits attribute */
    PatternUnits patternUnits : 1;
    bool patternUnits_set : 1;
    PatternUnits patternContentUnits : 1;
    bool patternContentUnits_set : 1;
    /* patternTransform attribute */
    Geom::Affine patternTransform;
    bool patternTransform_set : 1;
    /* Tile rectangle */
    SVGLength x;
    SVGLength y;
    SVGLength width;
    SVGLength height;

    sigc::connection modified_connection;
};


class SPPatternReference : public Inkscape::URIReference {
public:
    SPPatternReference (SPObject *obj) : URIReference(obj) {}
    SPPattern *getObject() const {
        return reinterpret_cast<SPPattern *>(URIReference::getObject());
    }

protected:
    virtual bool _acceptObject(SPObject *obj) const {
        return SP_IS_PATTERN (obj);
    }
};

#endif // SEEN_SP_PATTERN_H

/*
  Local Variables:
  mode:c++
  c-file-style:"stroustrup"
  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
  indent-tabs-mode:nil
  fill-column:99
  End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :