doc: update copyright line for 2021
[adg.git] / src / adg / adg-path.h
blob6c7de7f1df8730e62b40ba50567ae25375068043
1 /* ADG - Automatic Drawing Generation
2 * Copyright (C) 2007-2021 Nicola Fontana <ntd at entidi.it>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
21 #if !defined(__ADG_H__)
22 #error "Only <adg.h> can be included directly."
23 #endif
26 #ifndef __ADG_PATH_H__
27 #define __ADG_PATH_H__
30 G_BEGIN_DECLS
32 #define ADG_TYPE_PATH (adg_path_get_type())
33 #define ADG_PATH(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), ADG_TYPE_PATH, AdgPath))
34 #define ADG_PATH_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), ADG_TYPE_PATH, AdgPathClass))
35 #define ADG_IS_PATH(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), ADG_TYPE_PATH))
36 #define ADG_IS_PATH_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), ADG_TYPE_PATH))
37 #define ADG_PATH_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), ADG_TYPE_PATH, AdgPathClass))
39 typedef struct _AdgPath AdgPath;
40 typedef struct _AdgPathClass AdgPathClass;
42 struct _AdgPath {
43 /*< private >*/
44 AdgTrail parent;
47 struct _AdgPathClass {
48 /*< private >*/
49 AdgTrailClass parent_class;
53 GType adg_path_get_type (void);
54 AdgPath * adg_path_new (void);
56 const CpmlPair *adg_path_get_current_point (AdgPath *path);
57 gboolean adg_path_has_current_point (AdgPath *path);
58 const CpmlPrimitive *
59 adg_path_last_primitive (AdgPath *path);
60 const CpmlPrimitive *
61 adg_path_over_primitive (AdgPath *path);
62 void adg_path_append (AdgPath *path,
63 gint type,
64 ...);
65 void adg_path_append_valist (AdgPath *path,
66 CpmlPrimitiveType type,
67 va_list var_args);
68 void adg_path_append_array (AdgPath *path,
69 CpmlPrimitiveType type,
70 const CpmlPair**pairs);
71 void adg_path_append_primitive (AdgPath *path,
72 const CpmlPrimitive
73 *primitive);
74 void adg_path_append_segment (AdgPath *path,
75 const CpmlSegment
76 *segment);
77 void adg_path_append_cairo_path (AdgPath *path,
78 const cairo_path_t
79 *cairo_path);
80 void adg_path_append_trail (AdgPath *path,
81 AdgTrail *trail);
82 void adg_path_remove_primitive (AdgPath *path);
83 void adg_path_move_to (AdgPath *path,
84 const CpmlPair *pair);
85 void adg_path_move_to_explicit (AdgPath *path,
86 gdouble x,
87 gdouble y);
88 void adg_path_line_to (AdgPath *path,
89 const CpmlPair *pair);
90 void adg_path_line_to_explicit (AdgPath *path,
91 gdouble x,
92 gdouble y);
93 void adg_path_arc_to (AdgPath *path,
94 const CpmlPair *through,
95 const CpmlPair *pair);
96 void adg_path_arc_to_explicit (AdgPath *path,
97 gdouble x1,
98 gdouble y1,
99 gdouble x2,
100 gdouble y2);
101 void adg_path_curve_to (AdgPath *path,
102 const CpmlPair *control1,
103 const CpmlPair *control2,
104 const CpmlPair *pair);
105 void adg_path_curve_to_explicit (AdgPath *path,
106 gdouble x1,
107 gdouble y1,
108 gdouble x2,
109 gdouble y2,
110 gdouble x3,
111 gdouble y3);
112 void adg_path_close (AdgPath *path);
114 void adg_path_arc (AdgPath *path,
115 const CpmlPair *center,
116 gdouble r,
117 gdouble start,
118 gdouble end);
119 void adg_path_arc_explicit (AdgPath *path,
120 gdouble xc,
121 gdouble yc,
122 gdouble r,
123 gdouble start,
124 gdouble end);
125 void adg_path_chamfer (AdgPath *path,
126 gdouble delta1,
127 gdouble delta2);
128 void adg_path_fillet (AdgPath *path,
129 gdouble radius);
130 void adg_path_join (AdgPath *path);
131 void adg_path_reflect (AdgPath *path,
132 const CpmlVector *vector);
133 void adg_path_reflect_explicit (AdgPath *path,
134 gdouble x,
135 gdouble y);
137 G_END_DECLS
140 #endif /* __ADG_PATH_H__ */