Files
gimp/app/vectors/gimpstroke.h
Ell d9ec9386ce app: allow gimp_stroke_transform() to result in multiple strokes
The next commit is going to perform clipping when transforming
Bezier strokes.  When parts of the stroke get clipped, the result
consists of multiple strokes.

Adapt gimp_stroke_transform() in preparation, to allow for the
transformation to result in multiple strokes, by adding a GQueue*
parameter that receives the transformed strokes.

For convenience, we allow passing NULL as the argument, in which
case the current behavior is maintained.  However, NULL should only
be passed when clipping is known to be unnecessary.

Adapt the rest of the code for the change.

Note that this technically affects public API: existing stroke
object IDs now become invalid after transforming their containing
vectors object.  However, this is unlikely to affect code in
practice.
2018-02-03 05:58:43 -05:00

344 lines
20 KiB
C

/* GIMP - The GNU Image Manipulation Program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* gimpstroke.h
* Copyright (C) 2002 Simon Budig <simon@gimp.org>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __GIMP_STROKE_H__
#define __GIMP_STROKE_H__
#include "core/gimpobject.h"
#define GIMP_TYPE_STROKE (gimp_stroke_get_type ())
#define GIMP_STROKE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_STROKE, GimpStroke))
#define GIMP_STROKE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_STROKE, GimpStrokeClass))
#define GIMP_IS_STROKE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_STROKE))
#define GIMP_IS_STROKE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_STROKE))
#define GIMP_STROKE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_STROKE, GimpStrokeClass))
typedef struct _GimpStrokeClass GimpStrokeClass;
struct _GimpStroke
{
GimpObject parent_instance;
gint ID;
GQueue *anchors;
gboolean closed;
};
struct _GimpStrokeClass
{
GimpObjectClass parent_class;
void (* changed) (GimpStroke *stroke);
void (* removed) (GimpStroke *stroke);
GimpAnchor * (* anchor_get) (GimpStroke *stroke,
const GimpCoords *coord);
gdouble (* nearest_point_get) (GimpStroke *stroke,
const GimpCoords *coord,
gdouble precision,
GimpCoords *ret_point,
GimpAnchor **ret_segment_start,
GimpAnchor **ret_segment_end,
gdouble *ret_pos);
gdouble (* nearest_tangent_get) (GimpStroke *stroke,
const GimpCoords *coord1,
const GimpCoords *coord2,
gdouble precision,
GimpCoords *nearest,
GimpAnchor **ret_segment_start,
GimpAnchor **ret_segment_end,
gdouble *ret_pos);
gdouble (* nearest_intersection_get)
(GimpStroke *stroke,
const GimpCoords *coord1,
const GimpCoords *direction,
gdouble precision,
GimpCoords *nearest,
GimpAnchor **ret_segment_start,
GimpAnchor **ret_segment_end,
gdouble *ret_pos);
GimpAnchor * (* anchor_get_next) (GimpStroke *stroke,
const GimpAnchor *prev);
void (* anchor_select) (GimpStroke *stroke,
GimpAnchor *anchor,
gboolean selected,
gboolean exclusive);
void (* anchor_move_relative) (GimpStroke *stroke,
GimpAnchor *anchor,
const GimpCoords *deltacoord,
GimpAnchorFeatureType feature);
void (* anchor_move_absolute) (GimpStroke *stroke,
GimpAnchor *anchor,
const GimpCoords *coord,
GimpAnchorFeatureType feature);
void (* anchor_convert) (GimpStroke *stroke,
GimpAnchor *anchor,
GimpAnchorFeatureType feature);
void (* anchor_delete) (GimpStroke *stroke,
GimpAnchor *anchor);
gboolean (* point_is_movable) (GimpStroke *stroke,
GimpAnchor *predec,
gdouble position);
void (* point_move_relative) (GimpStroke *stroke,
GimpAnchor *predec,
gdouble position,
const GimpCoords *deltacoord,
GimpAnchorFeatureType feature);
void (* point_move_absolute) (GimpStroke *stroke,
GimpAnchor *predec,
gdouble position,
const GimpCoords *coord,
GimpAnchorFeatureType feature);
void (* close) (GimpStroke *stroke);
GimpStroke * (* open) (GimpStroke *stroke,
GimpAnchor *end_anchor);
gboolean (* anchor_is_insertable) (GimpStroke *stroke,
GimpAnchor *predec,
gdouble position);
GimpAnchor * (* anchor_insert) (GimpStroke *stroke,
GimpAnchor *predec,
gdouble position);
gboolean (* is_extendable) (GimpStroke *stroke,
GimpAnchor *neighbor);
GimpAnchor * (* extend) (GimpStroke *stroke,
const GimpCoords *coords,
GimpAnchor *neighbor,
GimpVectorExtendMode extend_mode);
gboolean (* connect_stroke) (GimpStroke *stroke,
GimpAnchor *anchor,
GimpStroke *extension,
GimpAnchor *neighbor);
gboolean (* is_empty) (GimpStroke *stroke);
gdouble (* get_length) (GimpStroke *stroke,
gdouble precision);
gdouble (* get_distance) (GimpStroke *stroke,
const GimpCoords *coord);
gboolean (* get_point_at_dist) (GimpStroke *stroke,
gdouble dist,
gdouble precision,
GimpCoords *position,
gdouble *slope);
GArray * (* interpolate) (GimpStroke *stroke,
gdouble precision,
gboolean *ret_closed);
GimpStroke * (* duplicate) (GimpStroke *stroke);
GimpBezierDesc * (* make_bezier) (GimpStroke *stroke);
void (* translate) (GimpStroke *stroke,
gdouble offset_x,
gdouble offset_y);
void (* scale) (GimpStroke *stroke,
gdouble scale_x,
gdouble scale_y);
void (* rotate) (GimpStroke *stroke,
gdouble center_x,
gdouble center_y,
gdouble angle);
void (* flip) (GimpStroke *stroke,
GimpOrientationType flip_type,
gdouble axis);
void (* flip_free) (GimpStroke *stroke,
gdouble x1,
gdouble y1,
gdouble x2,
gdouble y2);
void (* transform) (GimpStroke *stroke,
const GimpMatrix3 *matrix,
GQueue *ret_strokes);
GList * (* get_draw_anchors) (GimpStroke *stroke);
GList * (* get_draw_controls) (GimpStroke *stroke);
GArray * (* get_draw_lines) (GimpStroke *stroke);
GArray * (* control_points_get) (GimpStroke *stroke,
gboolean *ret_closed);
};
GType gimp_stroke_get_type (void) G_GNUC_CONST;
void gimp_stroke_set_ID (GimpStroke *stroke,
gint id);
gint gimp_stroke_get_ID (GimpStroke *stroke);
/* accessing / modifying the anchors */
GArray * gimp_stroke_control_points_get (GimpStroke *stroke,
gboolean *closed);
GimpAnchor * gimp_stroke_anchor_get (GimpStroke *stroke,
const GimpCoords *coord);
gdouble gimp_stroke_nearest_point_get (GimpStroke *stroke,
const GimpCoords *coord,
gdouble precision,
GimpCoords *ret_point,
GimpAnchor **ret_segment_start,
GimpAnchor **ret_segment_end,
gdouble *ret_pos);
gdouble gimp_stroke_nearest_tangent_get (GimpStroke *stroke,
const GimpCoords *coords1,
const GimpCoords *coords2,
gdouble precision,
GimpCoords *nearest,
GimpAnchor **ret_segment_start,
GimpAnchor **ret_segment_end,
gdouble *ret_pos);
gdouble gimp_stroke_nearest_intersection_get (GimpStroke *stroke,
const GimpCoords *coords1,
const GimpCoords *direction,
gdouble precision,
GimpCoords *nearest,
GimpAnchor **ret_segment_start,
GimpAnchor **ret_segment_end,
gdouble *ret_pos);
/* prev == NULL: "first" anchor */
GimpAnchor * gimp_stroke_anchor_get_next (GimpStroke *stroke,
const GimpAnchor *prev);
void gimp_stroke_anchor_select (GimpStroke *stroke,
GimpAnchor *anchor,
gboolean selected,
gboolean exclusive);
/* type will be an xorable enum:
* VECTORS_NONE, VECTORS_FIX_ANGLE, VECTORS_FIX_RATIO, VECTORS_RESTRICT_ANGLE
* or so.
*/
void gimp_stroke_anchor_move_relative (GimpStroke *stroke,
GimpAnchor *anchor,
const GimpCoords *delta,
GimpAnchorFeatureType feature);
void gimp_stroke_anchor_move_absolute (GimpStroke *stroke,
GimpAnchor *anchor,
const GimpCoords *coord,
GimpAnchorFeatureType feature);
gboolean gimp_stroke_point_is_movable (GimpStroke *stroke,
GimpAnchor *predec,
gdouble position);
void gimp_stroke_point_move_relative (GimpStroke *stroke,
GimpAnchor *predec,
gdouble position,
const GimpCoords *deltacoord,
GimpAnchorFeatureType feature);
void gimp_stroke_point_move_absolute (GimpStroke *stroke,
GimpAnchor *predec,
gdouble position,
const GimpCoords *coord,
GimpAnchorFeatureType feature);
void gimp_stroke_close (GimpStroke *stroke);
void gimp_stroke_anchor_convert (GimpStroke *stroke,
GimpAnchor *anchor,
GimpAnchorFeatureType feature);
void gimp_stroke_anchor_delete (GimpStroke *stroke,
GimpAnchor *anchor);
GimpStroke * gimp_stroke_open (GimpStroke *stroke,
GimpAnchor *end_anchor);
gboolean gimp_stroke_anchor_is_insertable (GimpStroke *stroke,
GimpAnchor *predec,
gdouble position);
GimpAnchor * gimp_stroke_anchor_insert (GimpStroke *stroke,
GimpAnchor *predec,
gdouble position);
gboolean gimp_stroke_is_extendable (GimpStroke *stroke,
GimpAnchor *neighbor);
GimpAnchor * gimp_stroke_extend (GimpStroke *stroke,
const GimpCoords *coords,
GimpAnchor *neighbor,
GimpVectorExtendMode extend_mode);
gboolean gimp_stroke_connect_stroke (GimpStroke *stroke,
GimpAnchor *anchor,
GimpStroke *extension,
GimpAnchor *neighbor);
gboolean gimp_stroke_is_empty (GimpStroke *stroke);
/* accessing the shape of the curve */
gdouble gimp_stroke_get_length (GimpStroke *stroke,
gdouble precision);
gdouble gimp_stroke_get_distance (GimpStroke *stroke,
const GimpCoords *coord);
gboolean gimp_stroke_get_point_at_dist (GimpStroke *stroke,
gdouble dist,
gdouble precision,
GimpCoords *position,
gdouble *slope);
/* returns an array of valid coordinates */
GArray * gimp_stroke_interpolate (GimpStroke *stroke,
const gdouble precision,
gboolean *closed);
GimpStroke * gimp_stroke_duplicate (GimpStroke *stroke);
/* creates a bezier approximation. */
GimpBezierDesc * gimp_stroke_make_bezier (GimpStroke *stroke);
void gimp_stroke_translate (GimpStroke *stroke,
gdouble offset_x,
gdouble offset_y);
void gimp_stroke_scale (GimpStroke *stroke,
gdouble scale_x,
gdouble scale_y);
void gimp_stroke_rotate (GimpStroke *stroke,
gdouble center_x,
gdouble center_y,
gdouble angle);
void gimp_stroke_flip (GimpStroke *stroke,
GimpOrientationType flip_type,
gdouble axis);
void gimp_stroke_flip_free (GimpStroke *stroke,
gdouble x1,
gdouble y1,
gdouble x2,
gdouble y2);
void gimp_stroke_transform (GimpStroke *stroke,
const GimpMatrix3 *matrix,
GQueue *ret_strokes);
GList * gimp_stroke_get_draw_anchors (GimpStroke *stroke);
GList * gimp_stroke_get_draw_controls (GimpStroke *stroke);
GArray * gimp_stroke_get_draw_lines (GimpStroke *stroke);
#endif /* __GIMP_STROKE_H__ */