sp-shape.cpp revision 90ad663f3849368c59c9b1391690f3266c5a8eec
#define __SP_SHAPE_C__
/*
* Base class for shapes, including <path> element
*
* Author:
* Lauris Kaplinski <lauris@kaplinski.com>
*
* Copyright (C) 1999-2002 Lauris Kaplinski
* Copyright (C) 2000-2001 Ximian, Inc.
* Copyright (C) 2004 John Cliff
*
* Released under GNU GPL, read the file 'COPYING' for more information
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include <libnr/n-art-bpath.h>
#include <libnr/nr-matrix-fns.h>
#include <libnr/nr-matrix-ops.h>
#include <libnr/nr-matrix-translate-ops.h>
#include <libnr/nr-scale-matrix-ops.h>
#include "macros.h"
#include "display/nr-arena-shape.h"
#include "print.h"
#include "document.h"
#include "style.h"
#include "marker.h"
#include "sp-path.h"
#include "prefs-utils.h"
#include "attributes.h"
#include "live_effects/effect.h"
#include "live_effects/lpeobject.h"
#include "live_effects/lpeobject-reference.h"
#include "uri.h"
#include "extract-uri.h"
#include "uri-references.h"
#include "bad-uri-exception.h"
#define noSHAPE_VERBOSE
static Inkscape::XML::Node *sp_shape_write(SPObject *object, Inkscape::XML::Node *repr, guint flags);
static void sp_shape_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags);
static NRArenaItem *sp_shape_show (SPItem *item, NRArena *arena, unsigned int key, unsigned int flags);
static SPItemClass *parent_class;
/**
* Registers the SPShape class with Gdk and returns its type number.
*/
sp_shape_get_type (void)
{
if (!type) {
sizeof (SPShapeClass),
sizeof (SPShape),
16,
NULL, /* value_table */
};
}
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
{
}
/**
* Initializes an SPShape object.
*/
static void
{
for ( int i = 0 ; i < SP_MARKER_LOC_QTY ; i++ ) {
}
}
static void
{
for ( int i = 0 ; i < SP_MARKER_LOC_QTY ; i++ ) {
}
}
}
/**
* Virtual build callback for SPMarker.
*
* This is to be invoked immediately after creation of an SPShape.
*
* \see sp_object_build()
*/
static void
{
SP_SHAPE(object)->path_effect_ref->changedSignal().connect(sigc::bind(sigc::ptr_fun(lpeobject_ref_changed), SP_SHAPE(object)));
}
}
/**
* 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
{
SPItemView *v;
int i;
for (i=SP_MARKER_LOC_START; i<SP_MARKER_LOC_QTY; i++) {
}
}
}
}
if (shape->path_effect_href) {
}
}
}
static void
{
switch (key) {
/* No change, do nothing. */
} else {
if (shape->path_effect_href) {
}
if (value) {
// Now do the attaching, which emits the changed signal.
try {
} catch (Inkscape::BadURIException &e) {
}
} else {
// Detach, which emits the changed signal.
}
}
break;
default:
}
break;
}
}
{
if ( shape->path_effect_href ) {
} else {
}
}
return repr;
}
/**
* Updates the shape when its attributes have changed. Also establishes
* marker objects to match the style settings.
*/
static void
{
}
/* This stanza checks that an object's marker style agrees with
* the marker objects it has allocated. sp_shape_set_marker ensures
* that the appropriate marker objects are present (or absent) to
* match the style.
*/
/* TODO: It would be nice if this could be done at an earlier level */
for (int i = 0 ; i < SP_MARKER_LOC_QTY ; i++) {
}
}
}
}
/* 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 */
if (flags & SP_OBJECT_MODIFIED_FLAG) {
}
if (paintbox) {
s->setPaintBox(*paintbox);
}
}
}
if (sp_shape_has_markers (shape)) {
/* Dimension marker views */
/* Get enough keys for all, start, mid and end marker types,
** and set this view's arenaitem key to the first of these keys.
*/
v->arenaitem,
);
}
for (int i = 0 ; i < SP_MARKER_LOC_QTY ; i++) {
sp_shape_number_of_markers (shape, i));
}
}
}
/* Update marker views */
}
}
}
/**
* Works out whether a marker of a given type is required at a particular
* point on a shape.
*
* \param shape Shape of interest.
* \param m Marker type (e.g. SP_MARKER_LOC_START)
* \param bp Path segment.
* \return 1 if a marker is required here, otherwise 0.
*/
bool
{
return false;
}
return m == SP_MARKER_LOC_START;
return m == SP_MARKER_LOC_END;
else
return m == SP_MARKER_LOC_MID;
}
static bool
is_moveto(NRPathcode const c)
{
return c == NR_MOVETO || c == NR_MOVETO_OPEN;
}
/**
* 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 *
{
--bp;
}
return bp;
}
/**
* Advances the bpath to the last segment in the subpath.
*/
static NArtBpath const *
{
for(;;) {
++bp;
case NR_MOVETO:
case NR_MOVETO_OPEN:
case NR_END:
--bp;
return bp;
default: continue;
}
}
}
/* A subpath begins with a moveto and ends immediately before the next moveto or NR_END.
* (`moveto' here means either NR_MOVETO or NR_MOVETO_OPEN.) I'm assuming that non-empty
* paths always begin with a moveto.
*
* The control points of the subpath are the control points of the path elements of the subpath.
*
* As usual, the control points of a moveto or NR_LINETO are {c(3)}, and
* the control points of a NR_CURVETO are {c(1), c(2), c(3)}.
* (It follows from the definition that NR_END isn't part of a subpath.)
*
* The initial control point is bpath[bi0].c(3).
*
* Reference: http://www.w3.org/TR/SVG11/painting.html#MarkerElement, the `orient' attribute.
* Reference for behaviour of zero-length segments:
* http://www.w3.org/TR/SVG11/implnote.html#PathElementImplementationNotes
*/
static double const no_tangent = 128.0; /* arbitrarily-chosen value outside the range of atan2, i.e. outside of [-pi, pi]. */
/**
* Helper function to calculate the outgoing tangent of a path
* ( atan2(other - p0) )
* \pre The bpath[] containing bp0 begins with a moveto.
*/
static double
{
/* See notes in comment block above. */
++bp;
case NR_LINETO:
goto found;
}
break;
case NR_CURVETO:
goto found;
}
}
break;
case NR_MOVETO_OPEN:
case NR_END:
case NR_MOVETO:
/* Gone right around the subpath without finding any different point since the
* initial moveto. */
return no_tangent;
}
/* Open subpath. */
return no_tangent;
}
goto found;
}
break;
}
/* Back where we started, so zero-length subpath. */
return no_tangent;
/* Note: this test must come after we've looked at element bp, in case bp0 is a curve:
* we must look at c(1) and c(2). (E.g. single-curve subpath.)
*/
}
}
}
/**
* Helper function to calculate the incoming tangent of a path
* ( atan2(p0 - other) )
*
* \pre The bpath[] containing bp0 begins with a moveto.
*/
static double
{
/* See notes in comment block before outgoing_tangent. */
case NR_LINETO:
goto found;
}
--bp;
break;
case NR_CURVETO:
goto found;
}
}
--bp;
break;
case NR_MOVETO:
case NR_MOVETO_OPEN:
goto found;
}
/* Open subpath. */
return no_tangent;
}
break;
default: /* includes NR_END */
return no_tangent;
}
/* Back where we started from: zero-length subpath. */
return no_tangent;
}
}
}
/**
* 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.
*/
{
/* angle1 and angle2 are now each either unset (i.e. still 100 from their initialization) or in
[-pi, pi] from atan2. */
double ret_angle;
if (angle1 == no_tangent) {
/* First vertex of an open subpath. */
? 0.
: angle2 );
} else if (angle2 == no_tangent) {
/* Last vertex of an open subpath. */
} else {
/* ret_angle is in the middle of the larger of the two sectors between angle1 and
* angle2, so flip it by 180degrees to force it to the middle of the smaller sector.
*
* (Imagine a circle with rays drawn at angle1 and angle2 from the centre of the
* circle. Those two rays divide the circle into two sectors.)
*/
}
}
}
/**
* 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
{
for (int i = SP_MARKER_LOC_START; i < SP_MARKER_LOC_QTY; i++) {
continue;
}
int n = 0;
NR_ARENA_ITEM_GET_KEY(ai) + i, n, m,
n++;
}
}
}
}
/**
* Sets modified flag for all sub-item views.
*/
static void
{
}
if (flags & SP_OBJECT_STYLE_MODIFIED_FLAG) {
}
}
}
/**
* 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)
{
}
}
}
// Union with bboxes of the markers, if any
if (sp_shape_has_markers (shape)) {
for (int m = SP_MARKER_LOC_START; m < SP_MARKER_LOC_QTY; m++) {
}
// total marker transform
// get bbox of the marker with that transform
// union it with the shape bbox
}
}
}
}
}
// copy our bbox to the variable we're given
}
}
/**
* Prepares shape for printing. Handles printing of comments for printing
* comment labels.
*/
void
{
gint add_comments = prefs_get_int_attribute_limited ("printing.debug", "add-label-comments", 0, 0, 1);
if (add_comments) {
}
/* fixme: Think (Lauris) */
}
}
for (int m = SP_MARKER_LOC_START; m < SP_MARKER_LOC_QTY; m++) {
}
}
}
}
if (add_comments) {
}
}
/**
* Sets style, path, and paintbox. Updates marker views, including dimensions.
*/
static NRArenaItem *
{
if (paintbox) {
s->setPaintBox(*paintbox);
}
if (sp_shape_has_markers (shape)) {
/* Dimension the marker views */
}
for (int i = 0; i < SP_MARKER_LOC_QTY; i++) {
sp_shape_number_of_markers (shape, i));
}
}
/* Update marker views */
}
return arenaitem;
}
/**
*/
static void
{
SPItemView *v;
int i;
for (i=0; i<SP_MARKER_LOC_QTY; i++) {
NR_ARENA_ITEM_GET_KEY (v->arenaitem) + i);
}
}
}
}
}
}
/**
* \param shape Shape.
* \return TRUE if the shape has any markers, or FALSE if not.
*/
int
{
/* Note, we're ignoring 'marker' settings, which technically should apply for
all three settings. This should be fixed later such that if 'marker' is
specified, then all three should appear. */
return (
);
}
/**
* \param shape Shape.
* \param type Marker type (e.g. SP_MARKER_LOC_START)
* \return Number of markers that the shape has of this type.
*/
int
{
int n = 0;
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
{
int i;
for (i = SP_MARKER_LOC_START; i < SP_MARKER_LOC_QTY; i++) {
SPItemView *v;
/* Hide marker */
/* fixme: Do we need explicit remove here? (Lauris) */
/* nr_arena_item_set_mask (v->arenaitem, NULL); */
}
/* Detach marker */
}
}
}
/**
* No-op. Exists for handling 'modified' messages
*/
static void
{
/* I think mask does update automagically */
/* 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
{
return;
}
SPItemView *v;
/* Detach marker */
/* Hide marker */
/* fixme: Do we need explicit remove here? (Lauris) */
/* nr_arena_item_set_mask (v->arenaitem, NULL); */
}
/* Unref marker */
}
if (SP_IS_MARKER (mrk)) {
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
{
}
}
/**
* 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
{
}
if (curve) {
if (owner) {
} else {
}
}
}
/**
* Return duplicate of curve (if any exists) or NULL if there is no curve
*/
SPCurve *
{
}
return NULL;
}
/* NOT FOR GENERAL PUBLIC UNTIL SORTED OUT (Lauris) */
void
{
}
if (curve) {
if (owner) {
} else {
}
}
}
/**
* Return all nodes in a path that are to be considered for snapping
*
* If the attribute "sodipodi:nodetypes" has been set, then this will be used
* to discard any node on a smooth part of the path, i.e. only cusps will be returned
*/
{
return;
}
/* Use the end points of each segment of the path */
int nodetype_index = 0;
// nodetypes might still be empty, e.g. for pure SVG files
// or it might not have been updated yet
bp++; //The first point of a closed path is coincident with the end point. Skip the first point as we need only one
}
// if nodetypes is out of date then return any node for snapping
// otherwise only return cusps (i.e . non-smooth nodes)
}
bp++;
}
}
if (sp_shape_has_path_effect(shape)) {
} else {
return NULL;
}
}
/**
* Calls any registered handlers for the update_patheffect action
*/
void
{
#ifdef SHAPE_VERBOSE
#endif
}
}
if (!shape) return;
if (!curve) return;
}
}
/**
* Gets called when (re)attached to another lpeobject.
*/
static void
{
if (old_ref) {
}
{
shape->lpe_modified_connection = ref->connectModified(sigc::bind(sigc::ptr_fun(&lpeobject_ref_modified), shape));
}
}
/**
* Gets called when lpeobject repr contents change: i.e. parameter change.
*/
static void
{
sp_shape_update_patheffect (shape, true);
}
{
if (!value) {
} else {
}
}
{
if (SP_IS_PATH(shape)) {
}
}
{
}
{
}
}
/*
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:encoding=utf-8:textwidth=99 :