326ea27593e4b73be12cd83470e9a73b8d32b9de
1 #ifndef __SP_ITEM_H__
2 #define __SP_ITEM_H__
4 /** \file
5 * Some things pertinent to all visible shapes: SPItem, SPItemView, SPItemCtx, SPItemClass, SPEvent.
6 */
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 */
20 #include <libnr/nr-matrix.h>
21 #include <libnr/nr-rect.h>
23 #include "display/nr-arena-forward.h"
24 #include "forward.h"
25 #include "sp-object.h"
26 #include <vector>
28 namespace Inkscape { class URIReference; }
29 class SPGuideConstraint;
31 enum {
32 SP_EVENT_INVALID,
33 SP_EVENT_NONE,
34 SP_EVENT_ACTIVATE,
35 SP_EVENT_MOUSEOVER,
36 SP_EVENT_MOUSEOUT
37 };
39 /**
40 * Event structure.
41 *
42 * \todo This is just placeholder. Plan:
43 * We do extensible event structure, that hold applicable (ui, non-ui)
44 * data pointers. So it is up to given object/arena implementation
45 * to process correct ones in meaningful way.
46 * Also, this probably goes to SPObject base class.
47 *
48 */
49 struct SPEvent {
50 unsigned int type;
51 gpointer data;
52 };
54 class SPItemView;
56 /// SPItemView
57 struct SPItemView {
58 SPItemView *next;
59 unsigned int flags;
60 unsigned int key;
61 NRArenaItem *arenaitem;
62 };
64 /* flags */
66 #define SP_ITEM_BBOX_VISUAL 1
68 #define SP_ITEM_SHOW_DISPLAY (1 << 0)
70 /**
71 * Flag for referenced views (i.e. clippaths, masks and patterns); always display
72 */
73 #define SP_ITEM_REFERENCE_FLAGS SP_ITEM_SHOW_DISPLAY
75 class SPItemCtx;
77 /// Contains transformations to document/viewport and the viewport size.
78 struct SPItemCtx {
79 SPCtx ctx;
80 /** Item to document transformation */
81 NR::Matrix i2doc;
82 /** Viewport size */
83 NRRect vp;
84 /** Item to viewport transformation */
85 NR::Matrix i2vp;
86 };
88 /** Abstract base class for all visible shapes. */
89 struct SPItem : public SPObject {
90 unsigned int sensitive : 1;
91 unsigned int stop_paint: 1;
92 double r_cx;
93 double r_cy;
95 NR::Matrix transform;
97 SPClipPathReference *clip_ref;
98 SPMaskReference *mask_ref;
100 // Used for object-avoiding connectors
101 SPAvoidRef *avoidRef;
103 SPItemView *display;
105 std::vector<SPGuideConstraint> constraints;
107 sigc::signal<void, NR::Matrix const *, SPItem *> _transformed_signal;
109 bool isLocked() const;
110 void setLocked(bool lock);
112 bool isHidden() const;
113 void setHidden(bool hidden);
115 bool isHidden(unsigned display_key) const;
117 bool isExplicitlyHidden() const;
119 void setExplicitlyHidden(bool val);
121 bool isVisibleAndUnlocked() const;
123 bool isVisibleAndUnlocked(unsigned display_key) const;
125 NR::Matrix getRelativeTransform(SPObject const *obj) const;
127 void raiseOne();
128 void lowerOne();
129 void raiseToTop();
130 void lowerToBottom();
132 NR::Rect invokeBbox(NR::Matrix const &transform) const;
134 sigc::connection connectTransformed(sigc::slot<void, NR::Matrix const *, SPItem *> slot) {
135 return _transformed_signal.connect(slot);
136 }
137 };
139 typedef std::back_insert_iterator<std::vector<NR::Point> > SnapPointsIter;
141 /// The SPItem vtable.
142 struct SPItemClass {
143 SPObjectClass parent_class;
145 /** BBox union in given coordinate system */
146 void (* bbox) (SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags);
148 /** Printing method. Assumes ctm is set to item affine matrix */
149 /* \todo Think about it, and maybe implement generic export method instead (Lauris) */
150 void (* print) (SPItem *item, SPPrintContext *ctx);
152 /** Give short description of item (for status display) */
153 gchar * (* description) (SPItem * item);
155 NRArenaItem * (* show) (SPItem *item, NRArena *arena, unsigned int key, unsigned int flags);
156 void (* hide) (SPItem *item, unsigned int key);
158 /** Write to an iterator the points that should be considered for snapping
159 * as the item's `nodes'.
160 */
161 void (* snappoints) (SPItem const *item, SnapPointsIter p);
163 /** Apply the transform optimally, and return any residual transformation */
164 NR::Matrix (* set_transform)(SPItem *item, NR::Matrix const &transform);
166 /** Emit event, if applicable */
167 gint (* event) (SPItem *item, SPEvent *event);
168 };
170 /* Flag testing macros */
172 #define SP_ITEM_STOP_PAINT(i) (SP_ITEM (i)->stop_paint)
174 /* Methods */
176 void sp_item_invoke_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const clear);
177 void sp_item_invoke_bbox_full(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags, unsigned const clear);
179 unsigned sp_item_pos_in_parent(SPItem *item);
181 gchar *sp_item_description(SPItem * item);
182 void sp_item_invoke_print(SPItem *item, SPPrintContext *ctx);
184 /** Shows/Hides item on given arena display list */
185 unsigned int sp_item_display_key_new(unsigned int numkeys);
186 NRArenaItem *sp_item_invoke_show(SPItem *item, NRArena *arena, unsigned int key, unsigned int flags);
187 void sp_item_invoke_hide(SPItem *item, unsigned int key);
189 void sp_item_snappoints(SPItem const *item, SnapPointsIter p);
191 void sp_item_adjust_pattern(SPItem *item, /* NR::Matrix const &premul, */ NR::Matrix const &postmul, bool set = false);
192 void sp_item_adjust_gradient(SPItem *item, /* NR::Matrix const &premul, */ NR::Matrix const &postmul, bool set = false);
193 void sp_item_adjust_stroke(SPItem *item, gdouble ex);
194 void sp_item_adjust_stroke_width_recursive(SPItem *item, gdouble ex);
195 void sp_item_adjust_paint_recursive(SPItem *item, NR::Matrix advertized_transform, NR::Matrix t_ancestors, bool is_pattern);
197 void sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NRMatrix const *transform, NR::Matrix const *adv = NULL);
198 void sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NR::Matrix const &transform, NR::Matrix const *adv = NULL);
200 void sp_item_set_item_transform(SPItem *item, NR::Matrix const &transform);
202 gint sp_item_event (SPItem *item, SPEvent *event);
204 /* Utility */
206 NRArenaItem *sp_item_get_arenaitem(SPItem *item, unsigned int key);
208 void sp_item_bbox_desktop(SPItem *item, NRRect *bbox) __attribute__ ((deprecated));
209 NR::Rect sp_item_bbox_desktop(SPItem *item);
211 NR::Matrix i2anc_affine(SPObject const *item, SPObject const *ancestor);
212 NR::Matrix i2i_affine(SPObject const *src, SPObject const *dest);
214 NR::Matrix sp_item_i2doc_affine(SPItem const *item);
215 NR::Matrix sp_item_i2root_affine(SPItem const *item);
217 NR::Matrix matrix_to_desktop (NR::Matrix m, SPItem const *item);
218 NR::Matrix matrix_from_desktop (NR::Matrix m, SPItem const *item);
220 /* fixme: - these are evil, but OK */
222 /* Fill *TRANSFORM with the item-to-desktop transform. See doc/coordinates.txt
223 * for a description of `Desktop coordinates'; though see also mental's comment
224 * at the top of that file.
225 *
226 * \return TRANSFORM.
227 */
228 NR::Matrix sp_item_i2d_affine(SPItem const *item);
229 NR::Matrix sp_item_i2r_affine(SPItem const *item);
230 void sp_item_set_i2d_affine(SPItem *item, NR::Matrix const &transform);
231 NR::Matrix sp_item_dt2i_affine(SPItem const *item);
232 int sp_item_repr_compare_position(SPItem *first, SPItem *second);
233 SPItem *sp_item_first_item_child (SPObject *obj);
235 #endif
237 /*
238 Local Variables:
239 mode:c++
240 c-file-style:"stroustrup"
241 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
242 indent-tabs-mode:nil
243 fill-column:99
244 End:
245 */
246 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :