![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/src/sp-shape.cpp b/src/sp-shape.cpp
index 304d481bd625806ffafddb2b914f1f20a2016563..a38a10b4d954286dcd4cd1f79f2c346463d0bc3e 100644 (file)
--- a/src/sp-shape.cpp
+++ b/src/sp-shape.cpp
#include <libnr/nr-matrix-translate-ops.h>
#include <libnr/nr-scale-matrix-ops.h>
+#include <sigc++/functors/ptr_fun.h>
+#include <sigc++/adaptors/bind.h>
#include "macros.h"
#include "display/nr-arena-shape.h"
#include "print.h"
#include "document.h"
-#include "marker-status.h"
#include "style.h"
-#include "sp-marker.h"
+#include "marker.h"
#include "sp-path.h"
#include "prefs-utils.h"
static void sp_shape_class_init (SPShapeClass *klass);
static void sp_shape_init (SPShape *shape);
+static void sp_shape_finalize (GObject *object);
static void sp_shape_build (SPObject * object, SPDocument * document, Inkscape::XML::Node * repr);
static void sp_shape_release (SPObject *object);
static SPItemClass *parent_class;
+/**
+ * Registers the SPShape class with Gdk and returns its type number.
+ */
GType
sp_shape_get_type (void)
{
return type;
}
+/**
+ * Initializes a SPShapeClass object. Establishes the function pointers to the class'
+ * member routines in the class vtable, and sets pointers to parent classes.
+ */
static void
sp_shape_class_init (SPShapeClass *klass)
{
+ GObjectClass *gobject_class;
SPObjectClass *sp_object_class;
SPItemClass * item_class;
SPPathClass * path_class;
+ gobject_class = (GObjectClass *) klass;
sp_object_class = (SPObjectClass *) klass;
item_class = (SPItemClass *) klass;
path_class = (SPPathClass *) klass;
parent_class = (SPItemClass *)g_type_class_peek_parent (klass);
+ gobject_class->finalize = sp_shape_finalize;
+
sp_object_class->build = sp_shape_build;
sp_object_class->release = sp_shape_release;
sp_object_class->update = sp_shape_update;
item_class->snappoints = sp_shape_snappoints;
}
+/**
+ * Initializes an SPShape object.
+ */
static void
sp_shape_init (SPShape *shape)
{
- /* Nothing here */
+ for ( int i = 0 ; i < SP_MARKER_LOC_QTY ; i++ ) {
+ new (&shape->release_connect[i]) sigc::connection();
+ new (&shape->modified_connect[i]) sigc::connection();
+ }
+}
+
+static void
+sp_shape_finalize (GObject *object)
+{
+ SPShape *shape=(SPShape *)object;
+
+ for ( int i = 0 ; i < SP_MARKER_LOC_QTY ; i++ ) {
+ shape->release_connect[i].disconnect();
+ shape->release_connect[i].~connection();
+ shape->modified_connect[i].disconnect();
+ shape->modified_connect[i].~connection();
+ }
+
+ if (((GObjectClass *) (parent_class))->finalize) {
+ (* ((GObjectClass *) (parent_class))->finalize)(object);
+ }
}
+/**
+ * Virtual build callback for SPMarker.
+ *
+ * This is to be invoked immediately after creation of an SPShape. This is
+ * just a stub.
+ *
+ * \see sp_object_build()
+ */
static void
sp_shape_build (SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
{
@@ -115,6 +159,16 @@ sp_shape_build (SPObject *object, SPDocument *document, Inkscape::XML::Node *rep
}
}
+/**
+ * Removes, releases and unrefs all children of object
+ *
+ * This is the inverse of sp_shape_build(). It must be invoked as soon
+ * as the shape is removed from the tree, even if it is still referenced
+ * by other objects. This routine also disconnects/unrefs markers and
+ * curves attached to it.
+ *
+ * \see sp_object_release()
+ */
static void
sp_shape_release (SPObject *object)
{
}
}
+/**
+ * Updates the shape when its attributes have changed. Also establishes
+ * marker objects to match the style settings.
+ */
static void
sp_shape_update (SPObject *object, SPCtx *ctx, unsigned int flags)
{
return c == NR_MOVETO || c == NR_MOVETO_OPEN;
}
-/** \pre The bpath[] containing bp begins with a moveto. */
+/**
+ * Helper function that advances a subpath's bpath to the first subpath
+ * by checking for moveto segments.
+ *
+ * \pre The bpath[] containing bp begins with a moveto.
+ */
static NArtBpath const *
first_seg_in_subpath(NArtBpath const *bp)
{
return bp;
}
+/**
+ * Advances the bpath to the last segment in the subpath.
+ */
static NArtBpath const *
last_seg_in_subpath(NArtBpath const *bp)
{
static double const no_tangent = 128.0; /* arbitrarily-chosen value outside the range of atan2, i.e. outside of [-pi, pi]. */
-/** \pre The bpath[] containing bp0 begins with a moveto. */
+/**
+ * Helper function to calculate the outgoing tangent of a path
+ * ( atan2(other - p0) )
+ * \pre The bpath[] containing bp0 begins with a moveto.
+ */
static double
outgoing_tangent(NArtBpath const *bp0)
{
return atan2( other - p0 );
}
-/** \pre The bpath[] containing bp0 begins with a moveto. */
+/**
+ * Helper function to calculate the incoming tangent of a path
+ * ( atan2(p0 - other) )
+ *
+ * \pre The bpath[] containing bp0 begins with a moveto.
+ */
static double
incoming_tangent(NArtBpath const *bp0)
{
/**
-* Calculate the transform required to get a marker's path object in the
-* right place for particular path segment on a shape. You should
-* call sp_shape_marker_required first to see if a marker is required
-* at this point.
-*
-* \see sp_shape_marker_required.
-*
-* \param shape Shape which the marker is for.
-* \param m Marker type (e.g. SP_MARKER_LOC_START)
-* \param bp Path segment which the arrow is for.
-* \return Transform matrix.
-*/
-
+ * Calculate the transform required to get a marker's path object in the
+ * right place for particular path segment on a shape. You should
+ * call sp_shape_marker_required first to see if a marker is required
+ * at this point.
+ *
+ * \see sp_shape_marker_required.
+ *
+ * \param shape Shape which the marker is for.
+ * \param m Marker type (e.g. SP_MARKER_LOC_START)
+ * \param bp Path segment which the arrow is for.
+ * \return Transform matrix.
+ */
NR::Matrix
sp_shape_marker_get_transform(SPShape const *shape, NArtBpath const *bp)
{
return NR::Matrix(NR::rotate(ret_angle)) * NR::translate(bp->c(3));
}
-/* Marker views have to be scaled already */
-
+/**
+ * Updates the instances (views) of a given marker in a shape.
+ * Marker views have to be scaled already. The transformation
+ * is retrieved and then shown by calling sp_marker_show_instance.
+ */
static void
sp_shape_update_marker_view (SPShape *shape, NRArenaItem *ai)
{
SPStyle *style = ((SPObject *) shape)->style;
- marker_status("sp_shape_update_marker_view: Updating views of markers");
-
for (int i = SP_MARKER_LOC_START; i < SP_MARKER_LOC_QTY; i++) {
if (shape->marker[i] == NULL) {
continue;
}
}
+/**
+ * Sets modified flag for all sub-item views.
+ */
static void
sp_shape_modified (SPObject *object, unsigned int flags)
{
}
}
+/**
+ * Calculates the bounding box for item, storing it into bbox.
+ * This also includes the bounding boxes of any markers included in the shape.
+ */
static void sp_shape_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags)
{
SPShape const *shape = SP_SHAPE (item);
@@ -581,6 +663,12 @@ static void sp_shape_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &tr
}
}
+/**
+ * Prepares shape for printing. Handles printing of comments for printing
+ * debugging, sizes the item to fit into the document width/height,
+ * applies print fill/stroke, sets transforms for markers, and adds
+ * comment labels.
+ */
void
sp_shape_print (SPItem *item, SPPrintContext *ctx)
{
}
}
+/**
+ * Sets style, path, and paintbox. Updates marker views, including dimensions.
+ */
static NRArenaItem *
sp_shape_show (SPItem *item, NRArena *arena, unsigned int key, unsigned int flags)
{
@@ -667,7 +758,7 @@ sp_shape_show (SPItem *item, NRArena *arena, unsigned int key, unsigned int flag
if (sp_shape_has_markers (shape)) {
- /* Dimension marker views */
+ /* Dimension the marker views */
if (!arenaitem->key) {
NR_ARENA_ITEM_SET_KEY (arenaitem, sp_item_display_key_new (SP_MARKER_LOC_QTY));
}
@@ -688,6 +779,9 @@ sp_shape_show (SPItem *item, NRArena *arena, unsigned int key, unsigned int flag
return arenaitem;
}
+/**
+ * Hides/removes marker views from the shape.
+ */
static void
sp_shape_hide (SPItem *item, unsigned int key)
{
}
}
-/* Marker stuff */
-
/**
* \param shape Shape.
* \return TRUE if the shape has any markers, or FALSE if not.
return n;
}
+/**
+ * Checks if the given marker is used in the shape, and if so, it
+ * releases it by calling sp_marker_hide. Also detaches signals
+ * and unrefs the marker from the shape.
+ */
static void
sp_shape_marker_release (SPObject *marker, SPShape *shape)
{
item = (SPItem *) shape;
- marker_status("sp_shape_marker_release: Releasing markers");
for (i = SP_MARKER_LOC_START; i < SP_MARKER_LOC_QTY; i++) {
if (marker == shape->marker[i]) {
SPItemView *v;
}
}
+/**
+ * No-op. Exists for handling 'modified' messages
+ */
static void
sp_shape_marker_modified (SPObject *marker, guint flags, SPItem *item)
{
/* g_warning ("Item %s mask %s modified", SP_OBJECT_ID (item), SP_OBJECT_ID (mask)); */
}
+/**
+ * Adds a new marker to shape object at the location indicated by key. value
+ * must be a valid URI reference resolvable from the shape object (i.e., present
+ * in the document <defs>). If the shape object already has a marker
+ * registered at the given position, it is removed first. Then the
+ * new marker is hrefed and its signals connected.
+ */
void
sp_shape_set_marker (SPObject *object, unsigned int key, const gchar *value)
{
SPItemView *v;
/* Detach marker */
- g_signal_handler_disconnect (shape->marker[key], shape->release_connect[key]);
- g_signal_handler_disconnect (shape->marker[key], shape->modified_connect[key]);
+ shape->release_connect[key].disconnect();
+ shape->modified_connect[key].disconnect();
/* Hide marker */
for (v = item->display; v != NULL; v = v->next) {
}
if (SP_IS_MARKER (mrk)) {
shape->marker[key] = sp_object_href (mrk, object);
- shape->release_connect[key] = g_signal_connect (G_OBJECT (shape->marker[key]), "release",
- G_CALLBACK (sp_shape_marker_release), shape);
- shape->modified_connect[key] = g_signal_connect (G_OBJECT (shape->marker[key]), "modified",
- G_CALLBACK (sp_shape_marker_modified), shape);
+ shape->release_connect[key] = mrk->connectRelease(sigc::bind<1>(sigc::ptr_fun(&sp_shape_marker_release), shape));
+ shape->modified_connect[key] = mrk->connectModified(sigc::bind<2>(sigc::ptr_fun(&sp_shape_marker_modified), shape));
}
}
}
/* Shape section */
+/**
+ * Calls any registered handlers for the set_shape action
+ */
void
sp_shape_set_shape (SPShape *shape)
{
}
}
+/**
+ * Adds a curve to the shape. If owner is specified, a reference
+ * will be made, otherwise the curve will be copied into the shape.
+ * Any existing curve in the shape will be unreferenced first.
+ * This routine also triggers a request to update the display.
+ */
void
sp_shape_set_curve (SPShape *shape, SPCurve *curve, unsigned int owner)
{
SP_OBJECT(shape)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
}
-/* Return duplicate of curve or NULL */
+/**
+ * Return duplicate of curve (if any exists) or NULL if there is no curve
+ */
SPCurve *
sp_shape_get_curve (SPShape *shape)
{
}
}
+/**
+ * Sets the snappoint p to the end point of the path segment
+ */
static void sp_shape_snappoints(SPItem const *item, SnapPointsIter p)
{
g_assert(item != NULL);