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 * Johan Engelen <j.b.c.engelen@ewi.utwente.nl>
13 *
14 * Copyright (C) 1999-2006 authors
15 * Copyright (C) 2001-2002 Ximian, Inc.
16 * Copyright (C) 2004 Monash University
17 *
18 * Released under GNU GPL, read the file 'COPYING' for more information
19 */
20 #include <vector>
22 #include "display/nr-arena-forward.h"
23 #include "sp-object.h"
24 #include <libnr/nr-matrix.h>
25 #include <libnr/nr-rect.h>
27 class SPGuideConstraint;
28 struct SPClipPathReference;
29 struct SPMaskReference;
30 struct SPAvoidRef;
31 struct SPPrintContext;
32 namespace Inkscape { class URIReference; }
34 enum {
35 SP_EVENT_INVALID,
36 SP_EVENT_NONE,
37 SP_EVENT_ACTIVATE,
38 SP_EVENT_MOUSEOVER,
39 SP_EVENT_MOUSEOUT
40 };
42 /**
43 * Event structure.
44 *
45 * \todo This is just placeholder. Plan:
46 * We do extensible event structure, that hold applicable (ui, non-ui)
47 * data pointers. So it is up to given object/arena implementation
48 * to process correct ones in meaningful way.
49 * Also, this probably goes to SPObject base class.
50 *
51 */
52 struct SPEvent {
53 unsigned int type;
54 gpointer data;
55 };
57 class SPItemView;
59 /// SPItemView
60 struct SPItemView {
61 SPItemView *next;
62 unsigned int flags;
63 unsigned int key;
64 NRArenaItem *arenaitem;
65 };
67 /* flags */
69 #define SP_ITEM_BBOX_VISUAL 1
71 #define SP_ITEM_SHOW_DISPLAY (1 << 0)
73 /**
74 * Flag for referenced views (i.e. markers, clippaths, masks and patterns);
75 currently unused, does the same as DISPLAY
76 */
77 #define SP_ITEM_REFERENCE_FLAGS (1 << 1)
79 class SPItemCtx;
81 /// Contains transformations to document/viewport and the viewport size.
82 struct SPItemCtx {
83 SPCtx ctx;
84 /** Item to document transformation */
85 NR::Matrix i2doc;
86 /** Viewport size */
87 NRRect vp;
88 /** Item to viewport transformation */
89 NR::Matrix i2vp;
90 };
92 /** Abstract base class for all visible shapes. */
93 struct SPItem : public SPObject {
94 enum BBoxType {
95 // legacy behavior: includes crude stroke, markers; excludes long miters, blur margin; is known to be wrong for caps
96 APPROXIMATE_BBOX,
97 // includes only the bare path bbox, no stroke, no nothing
98 GEOMETRIC_BBOX,
99 // includes everything: correctly done stroke (with proper miters and caps), markers, filter margins (e.g. blur)
100 RENDERING_BBOX
101 };
103 unsigned int sensitive : 1;
104 unsigned int stop_paint: 1;
105 double transform_center_x;
106 double transform_center_y;
108 NR::Matrix transform;
110 SPClipPathReference *clip_ref;
111 SPMaskReference *mask_ref;
113 // Used for object-avoiding connectors
114 SPAvoidRef *avoidRef;
116 SPItemView *display;
118 std::vector<SPGuideConstraint> constraints;
120 sigc::signal<void, NR::Matrix const *, SPItem *> _transformed_signal;
122 void init();
123 bool isLocked() const;
124 void setLocked(bool lock);
126 bool isHidden() const;
127 void setHidden(bool hidden);
129 bool isEvaluated() const;
130 void setEvaluated(bool visible);
131 void resetEvaluated();
133 bool isHidden(unsigned display_key) const;
135 bool isExplicitlyHidden() const;
137 void setExplicitlyHidden(bool val);
139 void setCenter(NR::Point object_centre);
140 void unsetCenter();
141 bool isCenterSet();
142 NR::Point getCenter() const;
144 bool isVisibleAndUnlocked() const;
146 bool isVisibleAndUnlocked(unsigned display_key) const;
148 NR::Matrix getRelativeTransform(SPObject const *obj) const;
150 void raiseOne();
151 void lowerOne();
152 void raiseToTop();
153 void lowerToBottom();
155 NR::Maybe<NR::Rect> getBounds(NR::Matrix const &transform, BBoxType type=APPROXIMATE_BBOX, unsigned int dkey=0) const;
157 sigc::connection _clip_ref_connection;
158 sigc::connection _mask_ref_connection;
160 sigc::connection connectTransformed(sigc::slot<void, NR::Matrix const *, SPItem *> slot) {
161 return _transformed_signal.connect(slot);
162 }
164 private:
165 enum EvaluatedStatus
166 {
167 StatusUnknown, StatusCalculated, StatusSet
168 };
170 mutable bool _is_evaluated;
171 mutable EvaluatedStatus _evaluated_status;
172 };
174 typedef std::back_insert_iterator<std::vector<NR::Point> > SnapPointsIter;
176 /// The SPItem vtable.
177 struct SPItemClass {
178 SPObjectClass parent_class;
180 /** BBox union in given coordinate system */
181 void (* bbox) (SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags);
183 /** Printing method. Assumes ctm is set to item affine matrix */
184 /* \todo Think about it, and maybe implement generic export method instead (Lauris) */
185 void (* print) (SPItem *item, SPPrintContext *ctx);
187 /** Give short description of item (for status display) */
188 gchar * (* description) (SPItem * item);
190 NRArenaItem * (* show) (SPItem *item, NRArena *arena, unsigned int key, unsigned int flags);
191 void (* hide) (SPItem *item, unsigned int key);
193 /** Write to an iterator the points that should be considered for snapping
194 * as the item's `nodes'.
195 */
196 void (* snappoints) (SPItem const *item, SnapPointsIter p);
198 /** Apply the transform optimally, and return any residual transformation */
199 NR::Matrix (* set_transform)(SPItem *item, NR::Matrix const &transform);
201 /** Emit event, if applicable */
202 gint (* event) (SPItem *item, SPEvent *event);
203 };
205 /* Flag testing macros */
207 #define SP_ITEM_STOP_PAINT(i) (SP_ITEM (i)->stop_paint)
209 /* Methods */
211 void sp_item_invoke_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const clear, SPItem::BBoxType type = SPItem::APPROXIMATE_BBOX);
212 void sp_item_invoke_bbox_full(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags, unsigned const clear);
214 unsigned sp_item_pos_in_parent(SPItem *item);
216 gchar *sp_item_description(SPItem * item);
217 void sp_item_invoke_print(SPItem *item, SPPrintContext *ctx);
219 /** Shows/Hides item on given arena display list */
220 unsigned int sp_item_display_key_new(unsigned int numkeys);
221 NRArenaItem *sp_item_invoke_show(SPItem *item, NRArena *arena, unsigned int key, unsigned int flags);
222 void sp_item_invoke_hide(SPItem *item, unsigned int key);
224 void sp_item_snappoints(SPItem const *item, bool includeItemCenter, SnapPointsIter p);
226 void sp_item_adjust_pattern(SPItem *item, /* NR::Matrix const &premul, */ NR::Matrix const &postmul, bool set = false);
227 void sp_item_adjust_gradient(SPItem *item, /* NR::Matrix const &premul, */ NR::Matrix const &postmul, bool set = false);
228 void sp_item_adjust_stroke(SPItem *item, gdouble ex);
229 void sp_item_adjust_stroke_width_recursive(SPItem *item, gdouble ex);
230 void sp_item_adjust_paint_recursive(SPItem *item, NR::Matrix advertized_transform, NR::Matrix t_ancestors, bool is_pattern);
232 void sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NRMatrix const *transform, NR::Matrix const *adv = NULL);
233 void sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NR::Matrix const &transform, NR::Matrix const *adv = NULL, bool compensate = true);
235 void sp_item_set_item_transform(SPItem *item, NR::Matrix const &transform);
237 gint sp_item_event (SPItem *item, SPEvent *event);
239 /* Utility */
241 NRArenaItem *sp_item_get_arenaitem(SPItem *item, unsigned int key);
243 void sp_item_bbox_desktop(SPItem *item, NRRect *bbox, SPItem::BBoxType type = SPItem::APPROXIMATE_BBOX) __attribute__ ((deprecated));
244 NR::Maybe<NR::Rect> sp_item_bbox_desktop(SPItem *item, SPItem::BBoxType type = SPItem::APPROXIMATE_BBOX);
246 NR::Matrix i2anc_affine(SPObject const *item, SPObject const *ancestor);
247 NR::Matrix i2i_affine(SPObject const *src, SPObject const *dest);
249 NR::Matrix sp_item_i2doc_affine(SPItem const *item);
250 NR::Matrix sp_item_i2root_affine(SPItem const *item);
252 NR::Matrix matrix_to_desktop (NR::Matrix m, SPItem const *item);
253 NR::Matrix matrix_from_desktop (NR::Matrix m, SPItem const *item);
255 /* fixme: - these are evil, but OK */
257 /* Fill *TRANSFORM with the item-to-desktop transform. See doc/coordinates.txt
258 * for a description of `Desktop coordinates'; though see also mental's comment
259 * at the top of that file.
260 *
261 * \return TRANSFORM.
262 */
263 NR::Matrix sp_item_i2d_affine(SPItem const *item);
264 NR::Matrix sp_item_i2r_affine(SPItem const *item);
265 void sp_item_set_i2d_affine(SPItem *item, NR::Matrix const &transform);
266 NR::Matrix sp_item_dt2i_affine(SPItem const *item);
267 int sp_item_repr_compare_position(SPItem *first, SPItem *second);
268 SPItem *sp_item_first_item_child (SPObject *obj);
270 #endif
272 /*
273 Local Variables:
274 mode:c++
275 c-file-style:"stroustrup"
276 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
277 indent-tabs-mode:nil
278 fill-column:99
279 End:
280 */
281 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :