9359763b5957d0e3de6418883ba6954ea3dc15c1
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. clippaths, masks and patterns); always display
75 */
76 #define SP_ITEM_REFERENCE_FLAGS SP_ITEM_SHOW_DISPLAY
78 class SPItemCtx;
80 /// Contains transformations to document/viewport and the viewport size.
81 struct SPItemCtx {
82 SPCtx ctx;
83 /** Item to document transformation */
84 NR::Matrix i2doc;
85 /** Viewport size */
86 NRRect vp;
87 /** Item to viewport transformation */
88 NR::Matrix i2vp;
89 };
91 /** Abstract base class for all visible shapes. */
92 struct SPItem : public SPObject {
93 enum BBoxType {
94 // legacy behavior: includes crude stroke, markers; excludes long miters, blur margin; is known to be wrong for caps
95 APPROXIMATE_BBOX,
96 // includes only the bare path bbox, no stroke, no nothing
97 GEOMETRIC_BBOX,
98 // includes everything: correctly done stroke (with proper miters and caps), markers, filter margins (e.g. blur)
99 RENDERING_BBOX
100 };
102 unsigned int sensitive : 1;
103 unsigned int stop_paint: 1;
104 double transform_center_x;
105 double transform_center_y;
107 NR::Matrix transform;
109 SPClipPathReference *clip_ref;
110 SPMaskReference *mask_ref;
112 // Used for object-avoiding connectors
113 SPAvoidRef *avoidRef;
115 SPItemView *display;
117 std::vector<SPGuideConstraint> constraints;
119 sigc::signal<void, NR::Matrix const *, SPItem *> _transformed_signal;
121 void init();
122 bool isLocked() const;
123 void setLocked(bool lock);
125 bool isHidden() const;
126 void setHidden(bool hidden);
128 bool isEvaluated() const;
129 void setEvaluated(bool visible);
130 void resetEvaluated();
132 bool isHidden(unsigned display_key) const;
134 bool isExplicitlyHidden() const;
136 void setExplicitlyHidden(bool val);
138 void setCenter(NR::Point object_centre);
139 void unsetCenter();
140 bool isCenterSet();
141 NR::Point getCenter() const;
143 bool isVisibleAndUnlocked() const;
145 bool isVisibleAndUnlocked(unsigned display_key) const;
147 NR::Matrix getRelativeTransform(SPObject const *obj) const;
149 void raiseOne();
150 void lowerOne();
151 void raiseToTop();
152 void lowerToBottom();
154 NR::Maybe<NR::Rect> getBounds(NR::Matrix const &transform, BBoxType type=APPROXIMATE_BBOX, unsigned int dkey=0) const;
156 sigc::connection _clip_ref_connection;
157 sigc::connection _mask_ref_connection;
159 sigc::connection connectTransformed(sigc::slot<void, NR::Matrix const *, SPItem *> slot) {
160 return _transformed_signal.connect(slot);
161 }
163 private:
164 enum EvaluatedStatus
165 {
166 StatusUnknown, StatusCalculated, StatusSet
167 };
169 mutable bool _is_evaluated;
170 mutable EvaluatedStatus _evaluated_status;
171 };
173 typedef std::back_insert_iterator<std::vector<NR::Point> > SnapPointsIter;
175 /// The SPItem vtable.
176 struct SPItemClass {
177 SPObjectClass parent_class;
179 /** BBox union in given coordinate system */
180 void (* bbox) (SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags);
182 /** Printing method. Assumes ctm is set to item affine matrix */
183 /* \todo Think about it, and maybe implement generic export method instead (Lauris) */
184 void (* print) (SPItem *item, SPPrintContext *ctx);
186 /** Give short description of item (for status display) */
187 gchar * (* description) (SPItem * item);
189 NRArenaItem * (* show) (SPItem *item, NRArena *arena, unsigned int key, unsigned int flags);
190 void (* hide) (SPItem *item, unsigned int key);
192 /** Write to an iterator the points that should be considered for snapping
193 * as the item's `nodes'.
194 */
195 void (* snappoints) (SPItem const *item, SnapPointsIter p);
197 /** Apply the transform optimally, and return any residual transformation */
198 NR::Matrix (* set_transform)(SPItem *item, NR::Matrix const &transform);
200 /** Emit event, if applicable */
201 gint (* event) (SPItem *item, SPEvent *event);
202 };
204 /* Flag testing macros */
206 #define SP_ITEM_STOP_PAINT(i) (SP_ITEM (i)->stop_paint)
208 /* Methods */
210 void sp_item_invoke_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const clear);
211 void sp_item_invoke_bbox_full(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags, unsigned const clear);
213 unsigned sp_item_pos_in_parent(SPItem *item);
215 gchar *sp_item_description(SPItem * item);
216 void sp_item_invoke_print(SPItem *item, SPPrintContext *ctx);
218 /** Shows/Hides item on given arena display list */
219 unsigned int sp_item_display_key_new(unsigned int numkeys);
220 NRArenaItem *sp_item_invoke_show(SPItem *item, NRArena *arena, unsigned int key, unsigned int flags);
221 void sp_item_invoke_hide(SPItem *item, unsigned int key);
223 void sp_item_snappoints(SPItem const *item, SnapPointsIter p);
225 void sp_item_adjust_pattern(SPItem *item, /* NR::Matrix const &premul, */ NR::Matrix const &postmul, bool set = false);
226 void sp_item_adjust_gradient(SPItem *item, /* NR::Matrix const &premul, */ NR::Matrix const &postmul, bool set = false);
227 void sp_item_adjust_stroke(SPItem *item, gdouble ex);
228 void sp_item_adjust_stroke_width_recursive(SPItem *item, gdouble ex);
229 void sp_item_adjust_paint_recursive(SPItem *item, NR::Matrix advertized_transform, NR::Matrix t_ancestors, bool is_pattern);
231 void sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NRMatrix const *transform, NR::Matrix const *adv = NULL);
232 void sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NR::Matrix const &transform, NR::Matrix const *adv = NULL, bool compensate = true);
234 void sp_item_set_item_transform(SPItem *item, NR::Matrix const &transform);
236 gint sp_item_event (SPItem *item, SPEvent *event);
238 /* Utility */
240 NRArenaItem *sp_item_get_arenaitem(SPItem *item, unsigned int key);
242 void sp_item_bbox_desktop(SPItem *item, NRRect *bbox) __attribute__ ((deprecated));
243 NR::Maybe<NR::Rect> sp_item_bbox_desktop(SPItem *item);
245 NR::Matrix i2anc_affine(SPObject const *item, SPObject const *ancestor);
246 NR::Matrix i2i_affine(SPObject const *src, SPObject const *dest);
248 NR::Matrix sp_item_i2doc_affine(SPItem const *item);
249 NR::Matrix sp_item_i2root_affine(SPItem const *item);
251 NR::Matrix matrix_to_desktop (NR::Matrix m, SPItem const *item);
252 NR::Matrix matrix_from_desktop (NR::Matrix m, SPItem const *item);
254 /* fixme: - these are evil, but OK */
256 /* Fill *TRANSFORM with the item-to-desktop transform. See doc/coordinates.txt
257 * for a description of `Desktop coordinates'; though see also mental's comment
258 * at the top of that file.
259 *
260 * \return TRANSFORM.
261 */
262 NR::Matrix sp_item_i2d_affine(SPItem const *item);
263 NR::Matrix sp_item_i2r_affine(SPItem const *item);
264 void sp_item_set_i2d_affine(SPItem *item, NR::Matrix const &transform);
265 NR::Matrix sp_item_dt2i_affine(SPItem const *item);
266 int sp_item_repr_compare_position(SPItem *first, SPItem *second);
267 SPItem *sp_item_first_item_child (SPObject *obj);
269 #endif
271 /*
272 Local Variables:
273 mode:c++
274 c-file-style:"stroustrup"
275 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
276 indent-tabs-mode:nil
277 fill-column:99
278 End:
279 */
280 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :