![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/src/sp-shape.cpp b/src/sp-shape.cpp
index 2ae76ef2ea7ba3ae484def2a1af285f06a692081..6dba2afb67b2f36a63b0d6f3ecd0ead17c03c4e6 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 void sp_shape_snappoints (SPItem const *item, SnapPointsIter p);
static void sp_shape_update_marker_view (SPShape *shape, NRArenaItem *ai);
-static int sp_shape_has_markers (SPShape const *shape);
-static int sp_shape_number_of_markers (SPShape* Shape, int type);
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->print = sp_shape_print;
item_class->show = sp_shape_show;
item_class->hide = sp_shape_hide;
- item_class->snappoints = sp_shape_snappoints;
+ 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)
{
@@ -117,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)
{
if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_PARENT_MODIFIED_FLAG)) {
/* This is suboptimal, because changing parent style schedules recalculation */
/* But on the other hand - how can we know that parent does not tie style and transform */
- NR::Rect const paintbox = SP_ITEM(object)->invokeBbox(NR::identity());
+ NR::Maybe<NR::Rect> paintbox = SP_ITEM(object)->getBounds(NR::identity());
for (SPItemView *v = SP_ITEM (shape)->display; v != NULL; v = v->next) {
NRArenaShape * const s = NR_ARENA_SHAPE(v->arenaitem);
if (flags & SP_OBJECT_MODIFIED_FLAG) {
nr_arena_shape_set_path(s, shape->curve, (flags & SP_OBJECT_USER_MODIFIED_FLAG_B));
}
- s->setPaintBox(paintbox);
+ if (paintbox) {
+ s->setPaintBox(*paintbox);
+ }
}
}
* \param bp Path segment.
* \return 1 if a marker is required here, otherwise 0.
*/
-static bool
+bool
sp_shape_marker_required(SPShape const *shape, int const m, NArtBpath *bp)
{
if (shape->marker[m] == NULL) {
return false;
}
- if (bp == shape->curve->bpath)
+ if (bp == SP_CURVE_BPATH(shape->curve))
return m == SP_MARKER_LOC_START;
else if (bp[1].code == NR_END)
return m == SP_MARKER_LOC_END;
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.
-*/
-
-static NR::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)
{
- g_return_val_if_fail(( is_moveto(shape->curve->bpath[0].code)
+ g_return_val_if_fail(( is_moveto(SP_CURVE_BPATH(shape->curve)[0].code)
&& ( 0 < shape->curve->end )
- && ( shape->curve->bpath[shape->curve->end].code == NR_END ) ),
+ && ( SP_CURVE_BPATH(shape->curve)[shape->curve->end].code == NR_END ) ),
NR::Matrix(NR::translate(bp->c(3))));
double const angle1 = incoming_tangent(bp);
double const angle2 = outgoing_tangent(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;
int n = 0;
- for (NArtBpath *bp = shape->curve->bpath; bp->code != NR_END; bp++) {
+ for (NArtBpath *bp = SP_CURVE_BPATH(shape->curve); bp->code != NR_END; bp++) {
if (sp_shape_marker_required (shape, i, bp)) {
NR::Matrix const m(sp_shape_marker_get_transform(shape, bp));
sp_marker_show_instance ((SPMarker* ) shape->marker[i], ai,
}
}
+/**
+ * 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);
@@ -536,55 +618,62 @@ static void sp_shape_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &tr
nr_path_matrix_bbox_union(&bp, transform, &cbbox);
- SPStyle* style=SP_OBJECT_STYLE (item);
- if (style->stroke.type != SP_PAINT_TYPE_NONE) {
- double const scale = expansion(transform);
- if ( fabs(style->stroke_width.computed * scale) > 0.01 ) { // sinon c'est 0=oon veut pas de bord
- double const width = MAX(0.125, style->stroke_width.computed * scale);
- if ( fabs(cbbox.x1-cbbox.x0) > -0.00001 && fabs(cbbox.y1-cbbox.y0) > -0.00001 ) {
- cbbox.x0-=0.5*width;
- cbbox.x1+=0.5*width;
- cbbox.y0-=0.5*width;
- cbbox.y1+=0.5*width;
+ if ((SPItem::BBoxType) flags != SPItem::GEOMETRIC_BBOX) {
+
+ SPStyle* style=SP_OBJECT_STYLE (item);
+ if (style->stroke.type != SP_PAINT_TYPE_NONE) {
+ double const scale = expansion(transform);
+ if ( fabs(style->stroke_width.computed * scale) > 0.01 ) { // sinon c'est 0=oon veut pas de bord
+ double const width = MAX(0.125, style->stroke_width.computed * scale);
+ if ( fabs(cbbox.x1-cbbox.x0) > -0.00001 && fabs(cbbox.y1-cbbox.y0) > -0.00001 ) {
+ cbbox.x0-=0.5*width;
+ cbbox.x1+=0.5*width;
+ cbbox.y0-=0.5*width;
+ cbbox.y1+=0.5*width;
+ }
}
}
- }
- // Union with bboxes of the markers, if any
- if (sp_shape_has_markers (shape)) {
- for (NArtBpath* bp = shape->curve->bpath; bp->code != NR_END; bp++) {
- for (int m = SP_MARKER_LOC_START; m < SP_MARKER_LOC_QTY; m++) {
- if (sp_shape_marker_required (shape, m, bp)) {
+ // Union with bboxes of the markers, if any
+ if (sp_shape_has_markers (shape)) {
+ for (NArtBpath* bp = SP_CURVE_BPATH(shape->curve); bp->code != NR_END; bp++) {
+ for (int m = SP_MARKER_LOC_START; m < SP_MARKER_LOC_QTY; m++) {
+ if (sp_shape_marker_required (shape, m, bp)) {
- SPMarker* marker = SP_MARKER (shape->marker[m]);
- SPItem* marker_item = sp_item_first_item_child (SP_OBJECT (shape->marker[m]));
+ SPMarker* marker = SP_MARKER (shape->marker[m]);
+ SPItem* marker_item = sp_item_first_item_child (SP_OBJECT (shape->marker[m]));
- NR::Matrix tr(sp_shape_marker_get_transform(shape, bp));
+ NR::Matrix tr(sp_shape_marker_get_transform(shape, bp));
- if (marker->markerUnits == SP_MARKER_UNITS_STROKEWIDTH) {
- tr = NR::scale(style->stroke_width.computed) * tr;
- }
+ if (marker->markerUnits == SP_MARKER_UNITS_STROKEWIDTH) {
+ tr = NR::scale(style->stroke_width.computed) * tr;
+ }
- // total marker transform
- tr = marker_item->transform * marker->c2p * tr * transform;
+ // total marker transform
+ tr = marker_item->transform * marker->c2p * tr * transform;
- // get bbox of the marker with that transform
- NRRect marker_bbox;
- sp_item_invoke_bbox (marker_item, &marker_bbox, tr, true);
- // union it with the shape bbox
- nr_rect_d_union (&cbbox, &cbbox, &marker_bbox);
+ // get bbox of the marker with that transform
+ NRRect marker_bbox;
+ sp_item_invoke_bbox (marker_item, &marker_bbox, tr, true);
+ // union it with the shape bbox
+ nr_rect_d_union (&cbbox, &cbbox, &marker_bbox);
+ }
}
}
}
}
- if ( fabs(cbbox.x1-cbbox.x0) > -0.00001 && fabs(cbbox.y1-cbbox.y0) > -0.00001 ) {
- NRRect tbbox=*bbox;
- nr_rect_d_union (bbox, &cbbox, &tbbox);
- }
+ // copy our bbox to the variable we're given
+ *bbox = cbbox;
}
}
+/**
+ * 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)
{
if (style->fill.type != SP_PAINT_TYPE_NONE) {
NRBPath bp;
- bp.path = shape->curve->bpath;
+ bp.path = SP_CURVE_BPATH(shape->curve);
sp_print_fill (ctx, &bp, i2d, style, &pbox, &dbox, &bbox);
}
if (style->stroke.type != SP_PAINT_TYPE_NONE) {
NRBPath bp;
- bp.path = shape->curve->bpath;
+ bp.path = SP_CURVE_BPATH(shape->curve);
sp_print_stroke (ctx, &bp, i2d, style, &pbox, &dbox, &bbox);
}
- for (NArtBpath* bp = shape->curve->bpath; bp->code != NR_END; bp++) {
+ for (NArtBpath* bp = SP_CURVE_BPATH(shape->curve); bp->code != NR_END; bp++) {
for (int m = SP_MARKER_LOC_START; m < SP_MARKER_LOC_QTY; m++) {
if (sp_shape_marker_required (shape, m, bp)) {
}
}
+/**
+ * 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)
{
@@ -666,12 +758,14 @@ sp_shape_show (SPItem *item, NRArena *arena, unsigned int key, unsigned int flag
NRArenaShape * const s = NR_ARENA_SHAPE(arenaitem);
nr_arena_shape_set_style(s, object->style);
nr_arena_shape_set_path(s, shape->curve, false);
- NR::Rect const paintbox = item->invokeBbox(NR::identity());
- s->setPaintBox(paintbox);
+ NR::Maybe<NR::Rect> paintbox = item->getBounds(NR::identity());
+ if (paintbox) {
+ s->setPaintBox(*paintbox);
+ }
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));
}
@@ -692,6 +786,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.
*/
-static int
+int
sp_shape_has_markers (SPShape const *shape)
{
/* Note, we're ignoring 'marker' settings, which technically should apply for
* \param type Marker type (e.g. SP_MARKER_LOC_START)
* \return Number of markers that the shape has of this type.
*/
-static int
+int
sp_shape_number_of_markers (SPShape *shape, int type)
{
int n = 0;
- for (NArtBpath* bp = shape->curve->bpath; bp->code != NR_END; bp++) {
+ for (NArtBpath* bp = SP_CURVE_BPATH(shape->curve); bp->code != NR_END; bp++) {
if (sp_shape_marker_required (shape, type, bp)) {
n++;
}
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);
NR::Matrix const i2d (sp_item_i2d_affine (item));
/* Use the end points of each segment of the path */
- NArtBpath const *bp = shape->curve->bpath;
+ NArtBpath const *bp = SP_CURVE_BPATH(shape->curve);
+
+ if (bp->code == NR_MOVETO) { // Indicates the start of a closed subpath, see nr-path-code.h
+ bp++; //The first point of a closed path is coincident with the end point. Skip the first point as we need only one
+ }
+
while (bp->code != NR_END) {
*p = bp->c(3) * i2d;
bp++;