src/sp-item.h

   1 #ifndef __SP_ITEM_H__
   2 #define __SP_ITEM_H__
   3
   4 /** \file
   5  * Some things pertinent to all visible shapes: SPItem, SPItemView, SPItemCtx, SPItemClass, SPEvent.
   6  */
   7
   8 /*
   9  * Authors:
  10  *   Lauris Kaplinski <lauris@kaplinski.com>
  11  *   bulia byak <buliabyak@users.sf.net>
  12  *
  13  * Copyright (C) 1999-2005 authors
  14  * Copyright (C) 2001-2002 Ximian, Inc.
  15  * Copyright (C) 2004 Monash University
  16  *
  17  * Released under GNU GPL, read the file 'COPYING' for more information
  18  */
  19 #include <vector>
  20
  21 #include "display/nr-arena-forward.h"
  22 #include "sp-object.h"
  23 #include <libnr/nr-matrix.h>
  24 #include <libnr/nr-rect.h>
  25
  26 class SPGuideConstraint;
  27 struct SPClipPathReference;
  28 struct SPMaskReference;
  29 struct SPAvoidRef;
  30 struct SPPrintContext;
  31 namespace Inkscape { class URIReference; }
  32
  33 enum {
  34     SP_EVENT_INVALID,
  35     SP_EVENT_NONE,
  36     SP_EVENT_ACTIVATE,
  37     SP_EVENT_MOUSEOVER,
  38     SP_EVENT_MOUSEOUT
  39 };
  40
  41 /**
  42  * Event structure.
  43  *
  44  * \todo This is just placeholder. Plan:
  45  * We do extensible event structure, that hold applicable (ui, non-ui)
  46  * data pointers. So it is up to given object/arena implementation
  47  * to process correct ones in meaningful way.
  48  * Also, this probably goes to SPObject base class.
  49  *
  50  */
  51 struct SPEvent {
  52     unsigned int type;
  53     gpointer data;
  54 };
  55
  56 class SPItemView;
  57
  58 /// SPItemView
  59 struct SPItemView {
  60     SPItemView *next;
  61     unsigned int flags;
  62     unsigned int key;
  63     NRArenaItem *arenaitem;
  64 };
  65
  66 /* flags */
  67
  68 #define SP_ITEM_BBOX_VISUAL 1
  69
  70 #define SP_ITEM_SHOW_DISPLAY (1 << 0)
  71
  72 /**
  73  * Flag for referenced views (i.e. clippaths, masks and patterns); always display
  74  */
  75 #define SP_ITEM_REFERENCE_FLAGS SP_ITEM_SHOW_DISPLAY
  76
  77 class SPItemCtx;
  78
  79 /// Contains transformations to document/viewport and the viewport size.
  80 struct SPItemCtx {
  81     SPCtx ctx;
  82     /** Item to document transformation */
  83     NR::Matrix i2doc;
  84     /** Viewport size */
  85     NRRect vp;
  86     /** Item to viewport transformation */
  87     NR::Matrix i2vp;
  88 };
  89
  90 /** Abstract base class for all visible shapes. */
  91 struct SPItem : public SPObject {
  92     unsigned int sensitive : 1;
  93     unsigned int stop_paint: 1;
  94     double transform_center_x;
  95     double transform_center_y;
  96
  97     NR::Matrix transform;
  98
  99     SPClipPathReference *clip_ref;
 100     SPMaskReference *mask_ref;
 101
 102     // Used for object-avoiding connectors
 103     SPAvoidRef *avoidRef;
 104
 105     SPItemView *display;
 106
 107     std::vector<SPGuideConstraint> constraints;
 108
 109     sigc::signal<void, NR::Matrix const *, SPItem *> _transformed_signal;
 110
 111     void init();
 112     bool isLocked() const;
 113     void setLocked(bool lock);
 114
 115     bool isHidden() const;
 116     void setHidden(bool hidden);
 117
 118     bool isEvaluated() const;
 119     void setEvaluated(bool visible);
 120     void resetEvaluated();
 121
 122     bool isHidden(unsigned display_key) const;
 123
 124     bool isExplicitlyHidden() const;
 125
 126     void setExplicitlyHidden(bool val);
 127
 128     void setCenter(NR::Point object_centre);
 129     void unsetCenter();
 130     bool isCenterSet();
 131     NR::Point getCenter();
 132
 133     bool isVisibleAndUnlocked() const;
 134
 135     bool isVisibleAndUnlocked(unsigned display_key) const;
 136
 137     NR::Matrix getRelativeTransform(SPObject const *obj) const;
 138
 139     void raiseOne();
 140     void lowerOne();
 141     void raiseToTop();
 142     void lowerToBottom();
 143
 144     NR::Rect invokeBbox(NR::Matrix const &transform) const;
 145
 146     sigc::connection connectTransformed(sigc::slot<void, NR::Matrix const *, SPItem *> slot)  {
 147         return _transformed_signal.connect(slot);
 148     }
 149
 150 private:
 151     enum EvaluatedStatus
 152     {
 153         StatusUnknown, StatusCalculated, StatusSet
 154     };
 155
 156     mutable bool _is_evaluated;
 157     mutable EvaluatedStatus _evaluated_status;
 158 };
 159
 160 typedef std::back_insert_iterator<std::vector<NR::Point> > SnapPointsIter;
 161
 162 /// The SPItem vtable.
 163 struct SPItemClass {
 164     SPObjectClass parent_class;
 165
 166     /** BBox union in given coordinate system */
 167     void (* bbox) (SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags);
 168
 169     /** Printing method. Assumes ctm is set to item affine matrix */
 170     /* \todo Think about it, and maybe implement generic export method instead (Lauris) */
 171     void (* print) (SPItem *item, SPPrintContext *ctx);
 172
 173     /** Give short description of item (for status display) */
 174     gchar * (* description) (SPItem * item);
 175
 176     NRArenaItem * (* show) (SPItem *item, NRArena *arena, unsigned int key, unsigned int flags);
 177     void (* hide) (SPItem *item, unsigned int key);
 178
 179     /** Write to an iterator the points that should be considered for snapping
 180      * as the item's `nodes'.
 181      */
 182     void (* snappoints) (SPItem const *item, SnapPointsIter p);
 183
 184     /** Apply the transform optimally, and return any residual transformation */
 185     NR::Matrix (* set_transform)(SPItem *item, NR::Matrix const &transform);
 186
 187     /** Emit event, if applicable */
 188     gint (* event) (SPItem *item, SPEvent *event);
 189 };
 190
 191 /* Flag testing macros */
 192
 193 #define SP_ITEM_STOP_PAINT(i) (SP_ITEM (i)->stop_paint)
 194
 195 /* Methods */
 196
 197 void sp_item_invoke_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const clear);
 198 void sp_item_invoke_bbox_full(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags, unsigned const clear);
 199
 200 unsigned sp_item_pos_in_parent(SPItem *item);
 201
 202 gchar *sp_item_description(SPItem * item);
 203 void sp_item_invoke_print(SPItem *item, SPPrintContext *ctx);
 204
 205 /** Shows/Hides item on given arena display list */
 206 unsigned int sp_item_display_key_new(unsigned int numkeys);
 207 NRArenaItem *sp_item_invoke_show(SPItem *item, NRArena *arena, unsigned int key, unsigned int flags);
 208 void sp_item_invoke_hide(SPItem *item, unsigned int key);
 209
 210 void sp_item_snappoints(SPItem const *item, SnapPointsIter p);
 211
 212 void sp_item_adjust_pattern(SPItem *item, /* NR::Matrix const &premul, */ NR::Matrix const &postmul, bool set = false);
 213 void sp_item_adjust_gradient(SPItem *item, /* NR::Matrix const &premul, */ NR::Matrix const &postmul, bool set = false);
 214 void sp_item_adjust_stroke(SPItem *item, gdouble ex);
 215 void sp_item_adjust_stroke_width_recursive(SPItem *item, gdouble ex);
 216 void sp_item_adjust_paint_recursive(SPItem *item, NR::Matrix advertized_transform, NR::Matrix t_ancestors, bool is_pattern);
 217
 218 void sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NRMatrix const *transform, NR::Matrix const *adv = NULL);
 219 void sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NR::Matrix const &transform, NR::Matrix const *adv = NULL);
 220
 221 void sp_item_set_item_transform(SPItem *item, NR::Matrix const &transform);
 222
 223 gint sp_item_event (SPItem *item, SPEvent *event);
 224
 225 /* Utility */
 226
 227 NRArenaItem *sp_item_get_arenaitem(SPItem *item, unsigned int key);
 228
 229 void sp_item_bbox_desktop(SPItem *item, NRRect *bbox) __attribute__ ((deprecated));
 230 NR::Rect sp_item_bbox_desktop(SPItem *item);
 231
 232 NR::Matrix i2anc_affine(SPObject const *item, SPObject const *ancestor);
 233 NR::Matrix i2i_affine(SPObject const *src, SPObject const *dest);
 234
 235 NR::Matrix sp_item_i2doc_affine(SPItem const *item);
 236 NR::Matrix sp_item_i2root_affine(SPItem const *item);
 237
 238 NR::Matrix matrix_to_desktop (NR::Matrix m, SPItem const *item);
 239 NR::Matrix matrix_from_desktop (NR::Matrix m, SPItem const *item);
 240
 241 /* fixme: - these are evil, but OK */
 242
 243 /* Fill *TRANSFORM with the item-to-desktop transform.  See doc/coordinates.txt
 244  * for a description of `Desktop coordinates'; though see also mental's comment
 245  * at the top of that file.
 246  *
 247  * \return TRANSFORM.
 248  */
 249 NR::Matrix sp_item_i2d_affine(SPItem const *item);
 250 NR::Matrix sp_item_i2r_affine(SPItem const *item);
 251 void sp_item_set_i2d_affine(SPItem *item, NR::Matrix const &transform);
 252 NR::Matrix sp_item_dt2i_affine(SPItem const *item);
 253 int sp_item_repr_compare_position(SPItem *first, SPItem *second);
 254 SPItem *sp_item_first_item_child (SPObject *obj);
 255
 256 #endif
 257
 258 /*
 259   Local Variables:
 260   mode:c++
 261   c-file-style:"stroustrup"
 262   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 263   indent-tabs-mode:nil
 264   fill-column:99
 265   End:
 266 */
 267 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :