Cleanup: Use const qualifier for curve utilities
[blender.git] / source / blender / blenkernel / BKE_curve.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19 #ifndef __BKE_CURVE_H__
20 #define __BKE_CURVE_H__
21
22 /** \file
23  * \ingroup bke
24  */
25
26 struct BezTriple;
27 struct Curve;
28 struct Depsgraph;
29 struct EditNurb;
30 struct GHash;
31 struct LinkNode;
32 struct ListBase;
33 struct Main;
34 struct Nurb;
35 struct Object;
36 struct Path;
37 struct Scene;
38 struct TextBox;
39 struct rctf;
40
41 typedef struct CurveCache {
42   ListBase disp;
43   ListBase bev;
44   ListBase deformed_nurbs;
45   struct Path *path;
46 } CurveCache;
47
48 /* Definitions needed for shape keys */
49 typedef struct CVKeyIndex {
50   void *orig_cv;
51   int key_index, nu_index, pt_index, vertex_index;
52   bool switched;
53 } CVKeyIndex;
54
55 #define KNOTSU(nu) \
56   ((nu)->orderu + (nu)->pntsu + (((nu)->flagu & CU_NURB_CYCLIC) ? ((nu)->orderu - 1) : 0))
57 #define KNOTSV(nu) \
58   ((nu)->orderv + (nu)->pntsv + (((nu)->flagv & CU_NURB_CYCLIC) ? ((nu)->orderv - 1) : 0))
59
60 /* Non cyclic nurbs have 1 less segment */
61 #define SEGMENTSU(nu) (((nu)->flagu & CU_NURB_CYCLIC) ? (nu)->pntsu : (nu)->pntsu - 1)
62 #define SEGMENTSV(nu) (((nu)->flagv & CU_NURB_CYCLIC) ? (nu)->pntsv : (nu)->pntsv - 1)
63
64 #define CU_DO_TILT(cu, nu) ((((nu)->flag & CU_2D) && ((cu)->flag & CU_3D) == 0) ? 0 : 1)
65 #define CU_DO_RADIUS(cu, nu) \
66   ((CU_DO_TILT(cu, nu) || ((cu)->flag & CU_PATH_RADIUS) || (cu)->bevobj || (cu)->ext1 != 0.0f || \
67     (cu)->ext2 != 0.0f) ? \
68        1 : \
69        0)
70
71 /* not 3d and not unfilled */
72 #define CU_DO_2DFILL(cu) \
73   ((((cu)->flag & CU_3D) == 0) && (((cu)->flag & (CU_FRONT | CU_BACK)) != 0))
74
75 /* ** Curve ** */
76 void BKE_curve_free(struct Curve *cu);
77 void BKE_curve_editfont_free(struct Curve *cu);
78 void BKE_curve_init(struct Curve *cu);
79 struct Curve *BKE_curve_add(struct Main *bmain, const char *name, int type);
80 void BKE_curve_copy_data(struct Main *bmain,
81                          struct Curve *cu_dst,
82                          const struct Curve *cu_src,
83                          const int flag);
84 struct Curve *BKE_curve_copy(struct Main *bmain, const struct Curve *cu);
85 void BKE_curve_make_local(struct Main *bmain, struct Curve *cu, const bool lib_local);
86 short BKE_curve_type_get(struct Curve *cu);
87 void BKE_curve_type_test(struct Object *ob);
88 void BKE_curve_curve_dimension_update(struct Curve *cu);
89
90 void BKE_curve_boundbox_calc(struct Curve *cu, float r_loc[3], float r_size[3]);
91 struct BoundBox *BKE_curve_boundbox_get(struct Object *ob);
92 void BKE_curve_texspace_calc(struct Curve *cu);
93 struct BoundBox *BKE_curve_texspace_get(struct Curve *cu,
94                                         float r_loc[3],
95                                         float r_rot[3],
96                                         float r_size[3]);
97
98 bool BKE_curve_minmax(struct Curve *cu, bool use_radius, float min[3], float max[3]);
99 bool BKE_curve_center_median(struct Curve *cu, float cent[3]);
100 bool BKE_curve_center_bounds(struct Curve *cu, float cent[3]);
101 void BKE_curve_transform_ex(struct Curve *cu,
102                             float mat[4][4],
103                             const bool do_keys,
104                             const bool do_props,
105                             const float unit_scale);
106 void BKE_curve_transform(struct Curve *cu,
107                          float mat[4][4],
108                          const bool do_keys,
109                          const bool do_props);
110 void BKE_curve_translate(struct Curve *cu, float offset[3], const bool do_keys);
111 void BKE_curve_material_index_remove(struct Curve *cu, int index);
112 void BKE_curve_material_index_clear(struct Curve *cu);
113 bool BKE_curve_material_index_validate(struct Curve *cu);
114 void BKE_curve_material_remap(struct Curve *cu, const unsigned int *remap, unsigned int remap_len);
115
116 ListBase *BKE_curve_nurbs_get(struct Curve *cu);
117
118 int BKE_curve_nurb_vert_index_get(const struct Nurb *nu, const void *vert);
119 void BKE_curve_nurb_active_set(struct Curve *cu, const struct Nurb *nu);
120 struct Nurb *BKE_curve_nurb_active_get(struct Curve *cu);
121 void *BKE_curve_vert_active_get(struct Curve *cu);
122 void BKE_curve_nurb_vert_active_set(struct Curve *cu, const struct Nurb *nu, const void *vert);
123 bool BKE_curve_nurb_vert_active_get(struct Curve *cu, struct Nurb **r_nu, void **r_vert);
124 void BKE_curve_nurb_vert_active_validate(struct Curve *cu);
125
126 float (*BKE_curve_nurbs_vertexCos_get(struct ListBase *lb, int *r_numVerts))[3];
127 void BK_curve_nurbs_vertexCos_apply(struct ListBase *lb, float (*vertexCos)[3]);
128
129 float (*BKE_curve_nurbs_keyVertexCos_get(struct ListBase *lb, float *key))[3];
130 void BKE_curve_nurbs_keyVertexTilts_apply(struct ListBase *lb, float *key);
131
132 void BKE_curve_editNurb_keyIndex_delCV(struct GHash *keyindex, const void *cv);
133 void BKE_curve_editNurb_keyIndex_free(struct GHash **keyindex);
134 void BKE_curve_editNurb_free(struct Curve *cu);
135 struct ListBase *BKE_curve_editNurbs_get(struct Curve *cu);
136
137 float *BKE_curve_surf_make_orco(struct Object *ob);
138
139 void BKE_curve_bevelList_free(struct ListBase *bev);
140 void BKE_curve_bevelList_make(struct Object *ob, struct ListBase *nurbs, bool for_render);
141 void BKE_curve_bevel_make(struct Depsgraph *depsgraph,
142                           struct Scene *scene,
143                           struct Object *ob,
144                           struct ListBase *disp,
145                           const bool for_render,
146                           const bool use_render_resolution,
147                           struct LinkNode *ob_cyclic_list);
148
149 void BKE_curve_forward_diff_bezier(
150     float q0, float q1, float q2, float q3, float *p, int it, int stride);
151 void BKE_curve_forward_diff_tangent_bezier(
152     float q0, float q1, float q2, float q3, float *p, int it, int stride);
153
154 void BKE_curve_rect_from_textbox(const struct Curve *cu,
155                                  const struct TextBox *tb,
156                                  struct rctf *r_rect);
157
158 /* ** Nurbs ** */
159
160 bool BKE_nurbList_index_get_co(struct ListBase *editnurb, const int index, float r_co[3]);
161
162 int BKE_nurbList_verts_count(struct ListBase *nurb);
163 int BKE_nurbList_verts_count_without_handles(struct ListBase *nurb);
164
165 void BKE_nurbList_free(struct ListBase *lb);
166 void BKE_nurbList_duplicate(struct ListBase *lb1, const struct ListBase *lb2);
167 void BKE_nurbList_handles_set(struct ListBase *editnurb, const char code);
168 void BKE_nurbList_handles_recalculate(struct ListBase *editnurb,
169                                       const bool calc_length,
170                                       const char flag);
171
172 void BKE_nurbList_handles_autocalc(ListBase *editnurb, int flag);
173 void BKE_nurbList_flag_set(ListBase *editnurb, short flag);
174
175 void BKE_nurb_free(struct Nurb *nu);
176 struct Nurb *BKE_nurb_duplicate(const struct Nurb *nu);
177 struct Nurb *BKE_nurb_copy(struct Nurb *src, int pntsu, int pntsv);
178
179 void BKE_nurb_test_2d(struct Nurb *nu);
180 void BKE_nurb_minmax(struct Nurb *nu, bool use_radius, float min[3], float max[3]);
181 float BKE_nurb_calc_length(const struct Nurb *nu, int resolution);
182
183 void BKE_nurb_makeFaces(
184     const struct Nurb *nu, float *coord_array, int rowstride, int resolu, int resolv);
185 void BKE_nurb_makeCurve(const struct Nurb *nu,
186                         float *coord_array,
187                         float *tilt_array,
188                         float *radius_array,
189                         float *weight_array,
190                         int resolu,
191                         int stride);
192
193 unsigned int BKE_curve_calc_coords_axis_len(const unsigned int bezt_array_len,
194                                             const unsigned int resolu,
195                                             const bool is_cyclic,
196                                             const bool use_cyclic_duplicate_endpoint);
197 void BKE_curve_calc_coords_axis(const struct BezTriple *bezt_array,
198                                 const unsigned int bezt_array_len,
199                                 const unsigned int resolu,
200                                 const bool is_cyclic,
201                                 const bool use_cyclic_duplicate_endpoint,
202                                 /* array params */
203                                 const unsigned int axis,
204                                 const unsigned int stride,
205                                 float *r_points);
206
207 void BKE_nurb_knot_calc_u(struct Nurb *nu);
208 void BKE_nurb_knot_calc_v(struct Nurb *nu);
209
210 /* nurb checks if they can be drawn, also clamp order func */
211 bool BKE_nurb_check_valid_u(const struct Nurb *nu);
212 bool BKE_nurb_check_valid_v(const struct Nurb *nu);
213 bool BKE_nurb_check_valid_uv(const struct Nurb *nu);
214
215 bool BKE_nurb_order_clamp_u(struct Nurb *nu);
216 bool BKE_nurb_order_clamp_v(struct Nurb *nu);
217
218 void BKE_nurb_direction_switch(struct Nurb *nu);
219 bool BKE_nurb_type_convert(struct Nurb *nu, const short type, const bool use_handles);
220
221 void BKE_nurb_points_add(struct Nurb *nu, int number);
222 void BKE_nurb_bezierPoints_add(struct Nurb *nu, int number);
223
224 int BKE_nurb_index_from_uv(struct Nurb *nu, int u, int v);
225 void BKE_nurb_index_to_uv(struct Nurb *nu, int index, int *r_u, int *r_v);
226
227 struct BezTriple *BKE_nurb_bezt_get_next(struct Nurb *nu, struct BezTriple *bezt);
228 struct BezTriple *BKE_nurb_bezt_get_prev(struct Nurb *nu, struct BezTriple *bezt);
229 struct BPoint *BKE_nurb_bpoint_get_next(struct Nurb *nu, struct BPoint *bp);
230 struct BPoint *BKE_nurb_bpoint_get_prev(struct Nurb *nu, struct BPoint *bp);
231
232 void BKE_nurb_bezt_calc_normal(struct Nurb *nu, struct BezTriple *bezt, float r_normal[3]);
233 void BKE_nurb_bezt_calc_plane(struct Nurb *nu, struct BezTriple *bezt, float r_plane[3]);
234
235 void BKE_nurb_bpoint_calc_normal(struct Nurb *nu, struct BPoint *bp, float r_normal[3]);
236 void BKE_nurb_bpoint_calc_plane(struct Nurb *nu, struct BPoint *bp, float r_plane[3]);
237
238 void BKE_nurb_handle_calc(struct BezTriple *bezt,
239                           struct BezTriple *prev,
240                           struct BezTriple *next,
241                           const bool is_fcurve,
242                           const char smoothing);
243 void BKE_nurb_handle_calc_simple(struct Nurb *nu, struct BezTriple *bezt);
244 void BKE_nurb_handle_calc_simple_auto(struct Nurb *nu, struct BezTriple *bezt);
245
246 void BKE_nurb_handle_smooth_fcurve(struct BezTriple *bezt, int total, bool cyclic);
247
248 void BKE_nurb_handles_calc(struct Nurb *nu);
249 void BKE_nurb_handles_autocalc(struct Nurb *nu, int flag);
250 void BKE_nurb_bezt_handle_test(struct BezTriple *bezt, const bool use_handle);
251 void BKE_nurb_handles_test(struct Nurb *nu, const bool use_handles);
252
253 /* **** Depsgraph evaluation **** */
254
255 void BKE_curve_eval_geometry(struct Depsgraph *depsgraph, struct Curve *curve);
256
257 /* Draw Cache */
258 enum {
259   BKE_CURVE_BATCH_DIRTY_ALL = 0,
260   BKE_CURVE_BATCH_DIRTY_SELECT,
261 };
262 void BKE_curve_batch_cache_dirty_tag(struct Curve *cu, int mode);
263 void BKE_curve_batch_cache_free(struct Curve *cu);
264
265 /* curve_decimate.c */
266 unsigned int BKE_curve_decimate_bezt_array(struct BezTriple *bezt_array,
267                                            const unsigned int bezt_array_len,
268                                            const unsigned int resolu,
269                                            const bool is_cyclic,
270                                            const char flag_test,
271                                            const char flag_set,
272                                            const float error_sq_max,
273                                            const unsigned int error_target_len);
274
275 void BKE_curve_decimate_nurb(struct Nurb *nu,
276                              const unsigned int resolu,
277                              const float error_sq_max,
278                              const unsigned int error_target_len);
279
280 extern void (*BKE_curve_batch_cache_dirty_tag_cb)(struct Curve *cu, int mode);
281 extern void (*BKE_curve_batch_cache_free_cb)(struct Curve *cu);
282
283 #endif /* __BKE_CURVE_H__ */