marker.cpp revision 0de00189ead4347edfdce459510b99b572e43e26
/*
* SVG <marker> implementation
*
* Authors:
* Lauris Kaplinski <lauris@kaplinski.com>
* Bryce Harrington <bryce@bryceharrington.org>
* Abhishek Sharma
* Jon A. Cruz <jon@joncruz.org>
*
* Copyright (C) 1999-2003 Lauris Kaplinski
* 2004-2006 Bryce Harrington
* 2008 Johan Engelen
*
* Released under GNU GPL, read the file 'COPYING' for more information
*/
#include <cstring>
#include <string>
#include "config.h"
#include <2geom/affine.h>
#include <2geom/transforms.h>
#include "svg/svg.h"
#include "display/drawing-group.h"
#include "xml/repr.h"
#include "attributes.h"
#include "marker.h"
#include "document.h"
#include "document-private.h"
struct SPMarkerView {
SPMarkerView *next;
unsigned int key;
std::vector<Inkscape::DrawingItem *> items;
};
static void sp_marker_class_init (SPMarkerClass *klass);
static void sp_marker_init (SPMarker *marker);
static void sp_marker_build (SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
static void sp_marker_release (SPObject *object);
static void sp_marker_set (SPObject *object, unsigned int key, const gchar *value);
static void sp_marker_update (SPObject *object, SPCtx *ctx, guint flags);
static Inkscape::XML::Node *sp_marker_write (SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags);
static Inkscape::DrawingItem *sp_marker_private_show (SPItem *item, Inkscape::Drawing &drawing, unsigned int key, unsigned int flags);
static void sp_marker_private_hide (SPItem *item, unsigned int key);
static Geom::OptRect sp_marker_bbox(SPItem const *item, Geom::Affine const &transform, SPItem::BBoxType type);
static void sp_marker_print (SPItem *item, SPPrintContext *ctx);
static void sp_marker_view_remove (SPMarker *marker, SPMarkerView *view, unsigned int destroyitems);
static SPGroupClass *parent_class = 0;
/**
* Registers the SPMarker class with Gdk and returns its type number.
*/
GType
sp_marker_get_type (void)
{
static GType type = 0;
if (!type) {
GTypeInfo info = {
sizeof (SPMarkerClass),
NULL, NULL,
(GClassInitFunc) sp_marker_class_init,
NULL, NULL,
sizeof (SPMarker),
16,
(GInstanceInitFunc) sp_marker_init,
NULL, /* value_table */
};
type = g_type_register_static (SP_TYPE_GROUP, "SPMarker", &info, (GTypeFlags)0);
}
return type;
}
/**
* Initializes a SPMarkerClass object. Establishes the function pointers to the class'
* member routines in the class vtable, and sets pointers to parent classes.
*/
static void sp_marker_class_init(SPMarkerClass *klass)
{
SPObjectClass *sp_object_class = reinterpret_cast<SPObjectClass *>(klass);
SPItemClass *sp_item_class = reinterpret_cast<SPItemClass *>(klass);
parent_class = reinterpret_cast<SPGroupClass *>(g_type_class_ref(SP_TYPE_GROUP));
sp_object_class->build = sp_marker_build;
sp_object_class->release = sp_marker_release;
sp_object_class->set = sp_marker_set;
sp_object_class->update = sp_marker_update;
sp_object_class->write = sp_marker_write;
sp_item_class->show = sp_marker_private_show;
sp_item_class->hide = sp_marker_private_hide;
sp_item_class->bbox = sp_marker_bbox;
sp_item_class->print = sp_marker_print;
}
/**
* Initializes an SPMarker object. This notes the marker's viewBox is
* not set and initializes the marker's c2p identity matrix.
*/
static void
sp_marker_init (SPMarker *marker)
{
marker->viewBox = Geom::OptRect();
marker->c2p.setIdentity();
marker->views = NULL;
}
/**
* Virtual build callback for SPMarker.
*
* This is to be invoked immediately after creation of an SPMarker. This
* method fills an SPMarker object with its SVG attributes, and calls the
* parent class' build routine to attach the object to its document and
* repr. The result will be creation of the whole document tree.
*
* \see sp_object_build()
*/
static void sp_marker_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
{
object->readAttr( "markerUnits" );
object->readAttr( "refX" );
object->readAttr( "refY" );
object->readAttr( "markerWidth" );
object->readAttr( "markerHeight" );
object->readAttr( "orient" );
object->readAttr( "viewBox" );
object->readAttr( "preserveAspectRatio" );
if (reinterpret_cast<SPObjectClass *>(parent_class)->build) {
reinterpret_cast<SPObjectClass *>(parent_class)->build(object, document, repr);
}
}
/**
* Removes, releases and unrefs all children of object
*
* This is the inverse of sp_marker_build(). It must be invoked as soon
* as the marker is removed from the tree, even if it is still referenced
* by other objects. It hides and removes any views of the marker, then
* calls the parent classes' release function to deregister the object
* and release its SPRepr bindings. The result will be the destruction
* of the entire document tree.
*
* \see sp_object_release()
*/
static void sp_marker_release(SPObject *object)
{
SPMarker *marker = reinterpret_cast<SPMarker *>(object);
while (marker->views) {
// Destroy all DrawingItems etc.
// Parent class ::hide method
reinterpret_cast<SPItemClass *>(parent_class)->hide(marker, marker->views->key);
sp_marker_view_remove (marker, marker->views, TRUE);
}
if (reinterpret_cast<SPObjectClass *>(parent_class)->release) {
reinterpret_cast<SPObjectClass *>(parent_class)->release(object);
}
}
/**
* Sets an attribute, 'key', of a marker object to 'value'. Supported
* attributes that can be set with this routine include:
*
* SP_ATTR_MARKERUNITS
* SP_ATTR_REFX
* SP_ATTR_REFY
* SP_ATTR_MARKERWIDTH
* SP_ATTR_MARKERHEIGHT
* SP_ATTR_ORIENT
* SP_ATTR_VIEWBOX
* SP_ATTR_PRESERVEASPECTRATIO
*/
static void sp_marker_set(SPObject *object, unsigned int key, const gchar *value)
{
SPMarker *marker = SP_MARKER(object);
switch (key) {
case SP_ATTR_MARKERUNITS:
marker->markerUnits_set = FALSE;
marker->markerUnits = SP_MARKER_UNITS_STROKEWIDTH;
if (value) {
if (!strcmp (value, "strokeWidth")) {
marker->markerUnits_set = TRUE;
} else if (!strcmp (value, "userSpaceOnUse")) {
marker->markerUnits = SP_MARKER_UNITS_USERSPACEONUSE;
marker->markerUnits_set = TRUE;
}
}
object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_VIEWPORT_MODIFIED_FLAG);
break;
case SP_ATTR_REFX:
marker->refX.readOrUnset(value);
object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_REFY:
marker->refY.readOrUnset(value);
object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_MARKERWIDTH:
marker->markerWidth.readOrUnset(value, SVGLength::NONE, 3.0, 3.0);
object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_MARKERHEIGHT:
marker->markerHeight.readOrUnset(value, SVGLength::NONE, 3.0, 3.0);
object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_ORIENT:
marker->orient_set = FALSE;
marker->orient_auto = FALSE;
marker->orient = 0.0;
if (value) {
if (!strcmp (value, "auto")) {
marker->orient_auto = TRUE;
marker->orient_set = TRUE;
} else if (sp_svg_number_read_f (value, &marker->orient)) {
marker->orient_set = TRUE;
}
}
object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
break;
case SP_ATTR_VIEWBOX:
marker->viewBox = Geom::OptRect();
if (value) {
double x, y, width, height;
char *eptr;
/* fixme: We have to take original item affine into account */
/* fixme: Think (Lauris) */
eptr = (gchar *) value;
x = g_ascii_strtod (eptr, &eptr);
while (*eptr && ((*eptr == ',') || (*eptr == ' '))) eptr++;
y = g_ascii_strtod (eptr, &eptr);
while (*eptr && ((*eptr == ',') || (*eptr == ' '))) eptr++;
width = g_ascii_strtod (eptr, &eptr);
while (*eptr && ((*eptr == ',') || (*eptr == ' '))) eptr++;
height = g_ascii_strtod (eptr, &eptr);
while (*eptr && ((*eptr == ',') || (*eptr == ' '))) eptr++;
if ((width > 0) && (height > 0)) {
/* Set viewbox */
marker->viewBox = Geom::Rect( Geom::Point(x,y),
Geom::Point(x + width, y + height) );
}
}
object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_VIEWPORT_MODIFIED_FLAG);
break;
case SP_ATTR_PRESERVEASPECTRATIO:
/* Do setup before, so we can use break to escape */
marker->aspect_set = FALSE;
marker->aspect_align = SP_ASPECT_NONE;
marker->aspect_clip = SP_ASPECT_MEET;
object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_VIEWPORT_MODIFIED_FLAG);
if (value) {
int len;
gchar c[256];
const gchar *p, *e;
unsigned int align, clip;
p = value;
while (*p && *p == 32) p += 1;
if (!*p) break;
e = p;
while (*e && *e != 32) e += 1;
len = e - p;
if (len > 8) break;
memcpy (c, value, len);
c[len] = 0;
/* Now the actual part */
if (!strcmp (c, "none")) {
align = SP_ASPECT_NONE;
} else if (!strcmp (c, "xMinYMin")) {
align = SP_ASPECT_XMIN_YMIN;
} else if (!strcmp (c, "xMidYMin")) {
align = SP_ASPECT_XMID_YMIN;
} else if (!strcmp (c, "xMaxYMin")) {
align = SP_ASPECT_XMAX_YMIN;
} else if (!strcmp (c, "xMinYMid")) {
align = SP_ASPECT_XMIN_YMID;
} else if (!strcmp (c, "xMidYMid")) {
align = SP_ASPECT_XMID_YMID;
} else if (!strcmp (c, "xMaxYMid")) {
align = SP_ASPECT_XMAX_YMID;
} else if (!strcmp (c, "xMinYMax")) {
align = SP_ASPECT_XMIN_YMAX;
} else if (!strcmp (c, "xMidYMax")) {
align = SP_ASPECT_XMID_YMAX;
} else if (!strcmp (c, "xMaxYMax")) {
align = SP_ASPECT_XMAX_YMAX;
} else {
break;
}
clip = SP_ASPECT_MEET;
while (*e && *e == 32) e += 1;
if (*e) {
if (!strcmp (e, "meet")) {
clip = SP_ASPECT_MEET;
} else if (!strcmp (e, "slice")) {
clip = SP_ASPECT_SLICE;
} else {
break;
}
}
marker->aspect_set = TRUE;
marker->aspect_align = align;
marker->aspect_clip = clip;
}
break;
default:
if (((SPObjectClass *) parent_class)->set)
((SPObjectClass *) parent_class)->set (object, key, value);
break;
}
}
/**
* Updates <marker> when its attributes have changed. Takes care of setting up
* transformations and viewBoxes.
*/
static void sp_marker_update(SPObject *object, SPCtx *ctx, guint flags)
{
SPMarker *marker = SP_MARKER(object);
SPItemCtx rctx;
// fixme: We have to set up clip here too
// Copy parent context
rctx.ctx = *ctx;
// Initialize tranformations
rctx.i2doc = Geom::identity();
rctx.i2vp = Geom::identity();
// Set up viewport
rctx.viewport = Geom::Rect::from_xywh(0, 0, marker->markerWidth.computed, marker->markerHeight.computed);
// Start with identity transform
marker->c2p.setIdentity();
// Viewbox is always present, either implicitly or explicitly
Geom::Rect vb;
if (marker->viewBox) {
vb = *marker->viewBox;
} else {
vb = rctx.viewport;
}
// Now set up viewbox transformation
// Determine actual viewbox in viewport coordinates
double x = 0;
double y = 0;
double width = 0;
double height = 0;
if (marker->aspect_align == SP_ASPECT_NONE) {
x = 0.0;
y = 0.0;
width = rctx.viewport.width();
height = rctx.viewport.height();
} else {
double scalex, scaley, scale;
// Things are getting interesting
scalex = rctx.viewport.width() / (vb.width());
scaley = rctx.viewport.height() / (vb.height());
scale = (marker->aspect_clip == SP_ASPECT_MEET) ? MIN (scalex, scaley) : MAX (scalex, scaley);
width = (vb.width()) * scale;
height = (vb.height()) * scale;
// Now place viewbox to requested position
switch (marker->aspect_align) {
case SP_ASPECT_XMIN_YMIN:
x = 0.0;
y = 0.0;
break;
case SP_ASPECT_XMID_YMIN:
x = 0.5 * (rctx.viewport.width() - width);
y = 0.0;
break;
case SP_ASPECT_XMAX_YMIN:
x = 1.0 * (rctx.viewport.width() - width);
y = 0.0;
break;
case SP_ASPECT_XMIN_YMID:
x = 0.0;
y = 0.5 * (rctx.viewport.height() - height);
break;
case SP_ASPECT_XMID_YMID:
x = 0.5 * (rctx.viewport.width() - width);
y = 0.5 * (rctx.viewport.height() - height);
break;
case SP_ASPECT_XMAX_YMID:
x = 1.0 * (rctx.viewport.width() - width);
y = 0.5 * (rctx.viewport.height() - height);
break;
case SP_ASPECT_XMIN_YMAX:
x = 0.0;
y = 1.0 * (rctx.viewport.height() - height);
break;
case SP_ASPECT_XMID_YMAX:
x = 0.5 * (rctx.viewport.width() - width);
y = 1.0 * (rctx.viewport.height() - height);
break;
case SP_ASPECT_XMAX_YMAX:
x = 1.0 * (rctx.viewport.width() - width);
y = 1.0 * (rctx.viewport.height() - height);
break;
default:
x = 0.0;
y = 0.0;
break;
}
}
// TODO fixme: all that work is done to figure out x and y, which are just ignored. Check why.
// viewbox transformation and reference translation
marker->c2p = Geom::Translate(-marker->refX.computed, -marker->refY.computed) *
Geom::Scale(width / vb.width(), height / vb.height());
rctx.i2doc = marker->c2p * rctx.i2doc;
// If viewBox is set reinitialize child viewport
// Otherwise it already correct
if (marker->viewBox) {
rctx.viewport = *marker->viewBox;
rctx.i2vp = Geom::identity();
}
// And invoke parent method
if (((SPObjectClass *) (parent_class))->update) {
((SPObjectClass *) (parent_class))->update (object, (SPCtx *) &rctx, flags);
}
// As last step set additional transform of drawing group
for (SPMarkerView *v = marker->views; v != NULL; v = v->next) {
for (unsigned i = 0 ; i < v->items.size() ; i++) {
if (v->items[i]) {
Inkscape::DrawingGroup *g = dynamic_cast<Inkscape::DrawingGroup *>(v->items[i]);
g->setChildTransform(marker->c2p);
}
}
}
}
/**
* Writes the object's properties into its repr object.
*/
static Inkscape::XML::Node *
sp_marker_write (SPObject *object, Inkscape::XML::Document *xml_doc, Inkscape::XML::Node *repr, guint flags)
{
SPMarker *marker;
marker = SP_MARKER (object);
if ((flags & SP_OBJECT_WRITE_BUILD) && !repr) {
repr = xml_doc->createElement("svg:marker");
}
if (marker->markerUnits_set) {
if (marker->markerUnits == SP_MARKER_UNITS_STROKEWIDTH) {
repr->setAttribute("markerUnits", "strokeWidth");
} else {
repr->setAttribute("markerUnits", "userSpaceOnUse");
}
} else {
repr->setAttribute("markerUnits", NULL);
}
if (marker->refX._set) {
sp_repr_set_svg_double(repr, "refX", marker->refX.computed);
} else {
repr->setAttribute("refX", NULL);
}
if (marker->refY._set) {
sp_repr_set_svg_double (repr, "refY", marker->refY.computed);
} else {
repr->setAttribute("refY", NULL);
}
if (marker->markerWidth._set) {
sp_repr_set_svg_double (repr, "markerWidth", marker->markerWidth.computed);
} else {
repr->setAttribute("markerWidth", NULL);
}
if (marker->markerHeight._set) {
sp_repr_set_svg_double (repr, "markerHeight", marker->markerHeight.computed);
} else {
repr->setAttribute("markerHeight", NULL);
}
if (marker->orient_set) {
if (marker->orient_auto) {
repr->setAttribute("orient", "auto");
} else {
sp_repr_set_css_double(repr, "orient", marker->orient);
}
} else {
repr->setAttribute("orient", NULL);
}
/* fixme: */
//XML Tree being used directly here while it shouldn't be....
repr->setAttribute("viewBox", object->getRepr()->attribute("viewBox"));
//XML Tree being used directly here while it shouldn't be....
repr->setAttribute("preserveAspectRatio", object->getRepr()->attribute("preserveAspectRatio"));
if (((SPObjectClass *) (parent_class))->write)
((SPObjectClass *) (parent_class))->write (object, xml_doc, repr, flags);
return repr;
}
/**
* This routine is disabled to break propagation.
*/
static Inkscape::DrawingItem *
sp_marker_private_show (SPItem */*item*/, Inkscape::Drawing &/*drawing*/, unsigned int /*key*/, unsigned int /*flags*/)
{
/* Break propagation */
return NULL;
}
/**
* This routine is disabled to break propagation.
*/
static void
sp_marker_private_hide (SPItem */*item*/, unsigned int /*key*/)
{
/* Break propagation */
}
/**
* This routine is disabled to break propagation.
*/
static Geom::OptRect
sp_marker_bbox(SPItem const *, Geom::Affine const &, SPItem::BBoxType)
{
/* Break propagation */
return Geom::OptRect();
}
/**
* This routine is disabled to break propagation.
*/
static void
sp_marker_print (SPItem */*item*/, SPPrintContext */*ctx*/)
{
/* Break propagation */
}
/* fixme: Remove link if zero-sized (Lauris) */
/**
* Removes any SPMarkerViews that a marker has with a specific key.
* Set up the DrawingItem array's size in the specified SPMarker's SPMarkerView.
* This is called from sp_shape_update() for shapes that have markers. It
* removes the old view of the marker and establishes a new one, registering
* it with the marker's list of views for future updates.
*
* \param marker Marker to create views in.
* \param key Key to give each SPMarkerView.
* \param size Number of DrawingItems to put in the SPMarkerView.
*/
void
sp_marker_show_dimension (SPMarker *marker, unsigned int key, unsigned int size)
{
SPMarkerView *view;
unsigned int i;
for (view = marker->views; view != NULL; view = view->next) {
if (view->key == key) break;
}
if (view && (view->items.size() != size)) {
/* Free old view and allocate new */
/* Parent class ::hide method */
((SPItemClass *) parent_class)->hide ((SPItem *) marker, key);
sp_marker_view_remove (marker, view, TRUE);
view = NULL;
}
if (!view) {
view = new SPMarkerView();
view->items.clear();
for (i = 0; i < size; i++) {
view->items.push_back(NULL);
}
view->next = marker->views;
marker->views = view;
view->key = key;
}
}
/**
* Shows an instance of a marker. This is called during sp_shape_update_marker_view()
* show and transform a child item in the drawing for all views with the given key.
*/
Inkscape::DrawingItem *
sp_marker_show_instance ( SPMarker *marker, Inkscape::DrawingItem *parent,
unsigned int key, unsigned int pos,
Geom::Affine const &base, float linewidth)
{
// do not show marker if linewidth == 0 and markerUnits == strokeWidth
// otherwise Cairo will fail to render anything on the tile
// that contains the "degenerate" marker
if (marker->markerUnits == SP_MARKER_UNITS_STROKEWIDTH && linewidth == 0) {
return NULL;
}
for (SPMarkerView *v = marker->views; v != NULL; v = v->next) {
if (v->key == key) {
if (pos >= v->items.size()) {
return NULL;
}
if (!v->items[pos]) {
/* Parent class ::show method */
v->items[pos] = ((SPItemClass *) parent_class)->show ((SPItem *) marker,
parent->drawing(), key,
SP_ITEM_REFERENCE_FLAGS);
if (v->items[pos]) {
/* fixme: Position (Lauris) */
parent->prependChild(v->items[pos]);
Inkscape::DrawingGroup *g = dynamic_cast<Inkscape::DrawingGroup *>(v->items[pos]);
if (g) g->setChildTransform(marker->c2p);
}
}
if (v->items[pos]) {
Geom::Affine m;
if (marker->orient_auto) {
m = base;
} else {
/* fixme: Orient units (Lauris) */
m = Geom::Rotate::from_degrees(marker->orient);
m *= Geom::Translate(base.translation());
}
if (marker->markerUnits == SP_MARKER_UNITS_STROKEWIDTH) {
m = Geom::Scale(linewidth) * m;
}
v->items[pos]->setTransform(m);
}
return v->items[pos];
}
}
return NULL;
}
/**
* Hides/removes all views of the given marker that have key 'key'.
* This replaces SPItem implementation because we have our own views
* \param key SPMarkerView key to hide.
*/
void
sp_marker_hide (SPMarker *marker, unsigned int key)
{
SPMarkerView *v;
v = marker->views;
while (v != NULL) {
SPMarkerView *next;
next = v->next;
if (v->key == key) {
/* Parent class ::hide method */
((SPItemClass *) parent_class)->hide ((SPItem *) marker, key);
sp_marker_view_remove (marker, v, TRUE);
return;
}
v = next;
}
}
/**
* Removes a given view. Also will destroy sub-items in the view if destroyitems
* is set to a non-zero value.
*/
static void
sp_marker_view_remove (SPMarker *marker, SPMarkerView *view, unsigned int destroyitems)
{
unsigned int i;
if (view == marker->views) {
marker->views = view->next;
} else {
SPMarkerView *v;
for (v = marker->views; v->next != view; v = v->next) if (!v->next) return;
v->next = view->next;
}
if (destroyitems) {
for (i = 0; i < view->items.size(); i++) {
/* We have to walk through the whole array because there may be hidden items */
delete view->items[i];
}
}
view->items.clear();
delete view;
}
const gchar *generate_marker(GSList *reprs, Geom::Rect bounds, SPDocument *document, Geom::Affine /*transform*/, Geom::Affine move)
{
Inkscape::XML::Document *xml_doc = document->getReprDoc();
Inkscape::XML::Node *defsrepr = document->getDefs()->getRepr();
Inkscape::XML::Node *repr = xml_doc->createElement("svg:marker");
// Uncommenting this will make the marker fixed-size independent of stroke width.
// Commented out for consistency with standard markers which scale when you change
// stroke width:
//repr->setAttribute("markerUnits", "userSpaceOnUse");
sp_repr_set_svg_double(repr, "markerWidth", bounds.dimensions()[Geom::X]);
sp_repr_set_svg_double(repr, "markerHeight", bounds.dimensions()[Geom::Y]);
repr->setAttribute("orient", "auto");
defsrepr->appendChild(repr);
const gchar *mark_id = repr->attribute("id");
SPObject *mark_object = document->getObjectById(mark_id);
for (GSList *i = reprs; i != NULL; i = i->next) {
Inkscape::XML::Node *node = (Inkscape::XML::Node *)(i->data);
SPItem *copy = SP_ITEM(mark_object->appendChildRepr(node));
Geom::Affine dup_transform;
if (!sp_svg_transform_read (node->attribute("transform"), &dup_transform))
dup_transform = Geom::identity();
dup_transform *= move;
copy->doWriteTransform(copy->getRepr(), dup_transform);
}
Inkscape::GC::release(repr);
return mark_id;
}
/*
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 :