summaryrefslogtreecommitdiffstats
path: root/src/object/sp-offset.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/object/sp-offset.h')
-rw-r--r--src/object/sp-offset.h107
1 files changed, 107 insertions, 0 deletions
diff --git a/src/object/sp-offset.h b/src/object/sp-offset.h
new file mode 100644
index 0000000..a85837e
--- /dev/null
+++ b/src/object/sp-offset.h
@@ -0,0 +1,107 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+#ifndef SEEN_SP_OFFSET_H
+#define SEEN_SP_OFFSET_H
+/*
+ * Authors:
+ * Mitsuru Oka <oka326@parkcity.ne.jp>
+ * Lauris Kaplinski <lauris@kaplinski.com>
+ * (of the sp-spiral.h upon which this file was created)
+ * Copyright (C) 1999-2002 Lauris Kaplinski
+ * Copyright (C) 2000-2001 Ximian, Inc.
+ *
+ * Released under GNU GPL v2+, read the file 'COPYING' for more information.
+ */
+
+#include <cstddef>
+#include <sigc++/sigc++.h>
+
+#include "sp-shape.h"
+
+class SPUseReference;
+
+/**
+ * SPOffset class.
+ *
+ * An offset is defined by curve and radius. The original curve is kept as
+ * a path in a sodipodi:original attribute. It's not possible to change
+ * the original curve.
+ *
+ * SPOffset is a derivative of SPShape, much like the SPSpiral or SPRect.
+ * The goal is to have a source shape (= originalPath), an offset (= radius)
+ * and compute the offset of the source by the radius. To get it to work,
+ * one needs to know what the source is and what the radius is, and how it's
+ * stored in the xml representation. The object itself is a "path" element,
+ * to get lots of shape functionality for free. The source is the easy part:
+ * it's stored in a "inkscape:original" attribute in the path. In case of
+ * "linked" offset, as they've been dubbed, there is an additional
+ * "inkscape:href" that contains the id of an element of the svg.
+ * When built, the object will attach a listener vector to that object and
+ * rebuild the "inkscape:original" whenever the href'd object changes. This
+ * is of course grossly inefficient, and also does not react to changes
+ * to the href'd during context stuff (like changing the shape of a star by
+ * dragging control points) unless the path of that object is changed during
+ * the context (seems to be the case for SPEllipse). The computation of the
+ * offset is done in sp_offset_set_shape(), a function that is called whenever
+ * a change occurs to the offset (change of source or change of radius).
+ * just like the sp-star and other, this path derivative can make control
+ * points, or more precisely one control point, that's enough to define the
+ * radius (look in shape-editor-knotholders).
+ */
+class SPOffset : public SPShape {
+public:
+ SPOffset();
+ ~SPOffset() override;
+
+ void *originalPath; ///< will be a livarot Path, just don't declare it here to please the gcc linker FIXME what?
+ char *original; ///< SVG description of the source path
+ float rad; ///< offset radius
+
+ /// for interactive setting of the radius
+ bool knotSet;
+ Geom::Point knot;
+
+ bool sourceDirty;
+ bool isUpdating;
+
+ char *sourceHref;
+ SPUseReference *sourceRef;
+ Inkscape::XML::Node *sourceRepr; ///< the repr associated with that id
+ SPObject *sourceObject;
+
+ sigc::connection _modified_connection;
+ sigc::connection _delete_connection;
+ sigc::connection _changed_connection;
+ sigc::connection _transformed_connection;
+
+ void build(SPDocument *document, Inkscape::XML::Node *repr) override;
+ void set(SPAttr key, char const* value) override;
+ void update(SPCtx *ctx, unsigned int flags) override;
+ Inkscape::XML::Node* write(Inkscape::XML::Document *xml_doc, Inkscape::XML::Node *repr, unsigned flags) override;
+ void release() override;
+
+ void snappoints(std::vector<Inkscape::SnapCandidatePoint> &p, Inkscape::SnapPreferences const *snapprefs) const override;
+ const char* displayName() const override;
+ char* description() const override;
+
+ void set_shape() override;
+};
+
+double sp_offset_distance_to_original (SPOffset * offset, Geom::Point px);
+void sp_offset_top_point (SPOffset const *offset, Geom::Point *px);
+
+SPItem *sp_offset_get_source (SPOffset *offset);
+
+MAKE_SP_OBJECT_DOWNCAST_FUNCTIONS(SP_OFFSET, SPOffset)
+
+#endif
+
+/*
+ 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 :