630c5fa1856bb5782d08169ec6ebf7d5d64d076b
[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 GHash;
30 struct ListBase;
31 struct Main;
32 struct Nurb;
33 struct Object;
34 struct Path;
35 struct TextBox;
36 struct rctf;
37
38 typedef struct CurveCache {
39   ListBase disp;
40   ListBase bev;
41   ListBase deformed_nurbs;
42   struct Path *path;
43 } CurveCache;
44
45 /* Definitions needed for shape keys */
46 typedef struct CVKeyIndex {
47   void *orig_cv;
48   int key_index, nu_index, pt_index, vertex_index;
49   bool switched;
50 } CVKeyIndex;
51
52 #define KNOTSU(nu) \
53   ((nu)->orderu + (nu)->pntsu + (((nu)->flagu & CU_NURB_CYCLIC) ? ((nu)->orderu - 1) : 0))
54 #define KNOTSV(nu) \
55   ((nu)->orderv + (nu)->pntsv + (((nu)->flagv & CU_NURB_CYCLIC) ? ((nu)->orderv - 1) : 0))
56
57 /* Non cyclic nurbs have 1 less segment */
58 #define SEGMENTSU(nu) (((nu)->flagu & CU_NURB_CYCLIC) ? (nu)->pntsu : (nu)->pntsu - 1)
59 #define SEGMENTSV(nu) (((nu)->flagv & CU_NURB_CYCLIC) ? (nu)->pntsv : (nu)->pntsv - 1)
60
61 #define CU_DO_TILT(cu, nu) ((((nu)->flag & CU_2D) && ((cu)->flag & CU_3D) == 0) ? 0 : 1)
62 #define CU_DO_RADIUS(cu, nu) \
63   ((CU_DO_TILT(cu, nu) || ((cu)->flag & CU_PATH_RADIUS) || (cu)->bevobj || (cu)->ext1 != 0.0f || \
64     (cu)->ext2 != 0.0f) ? \
65        1 : \
66        0)
67
68 /* not 3d and not unfilled */
69 #define CU_DO_2DFILL(cu) \
70   ((((cu)->flag & CU_3D) == 0) && (((cu)->flag & (CU_FRONT | CU_BACK)) != 0))
71
72 /* ** Curve ** */
73 void BKE_curve_free(struct Curve *cu);
74 void BKE_curve_editfont_free(struct Curve *cu);
75 void BKE_curve_init(struct Curve *cu, const short curve_type);
76 struct Curve *BKE_curve_add(struct Main *bmain, const char *name, int type);
77 void BKE_curve_copy_data(struct Main *bmain,
78                          struct Curve *cu_dst,
79                          const struct Curve *cu_src,
80                          const int flag);
81 struct Curve *BKE_curve_copy(struct Main *bmain, const struct Curve *cu);
82 void BKE_curve_make_local(struct Main *bmain, struct Curve *cu, const bool lib_local);
83 short BKE_curve_type_get(struct Curve *cu);
84 void BKE_curve_type_test(struct Object *ob);
85 void BKE_curve_curve_dimension_update(struct Curve *cu);
86
87 void BKE_curve_boundbox_calc(struct Curve *cu, float r_loc[3], float r_size[3]);
88 struct BoundBox *BKE_curve_boundbox_get(struct Object *ob);
89
90 void BKE_curve_texspace_calc(struct Curve *cu);
91 void BKE_curve_texspace_ensure(struct Curve *cu);
92 void BKE_curve_texspace_get(struct Curve *cu, float r_loc[3], float r_size[3]);
93
94 bool BKE_curve_minmax(struct Curve *cu, bool use_radius, float min[3], float max[3]);
95 bool BKE_curve_center_median(struct Curve *cu, float cent[3]);
96 bool BKE_curve_center_bounds(struct Curve *cu, float cent[3]);
97 void BKE_curve_transform_ex(struct Curve *cu,
98                             float mat[4][4],
99                             const bool do_keys,
100                             const bool do_props,
101                             const float unit_scale);
102 void BKE_curve_transform(struct Curve *cu,
103                          float mat[4][4],
104                          const bool do_keys,
105                          const bool do_props);
106 void BKE_curve_translate(struct Curve *cu, float offset[3], const bool do_keys);
107 void BKE_curve_material_index_remove(struct Curve *cu, int index);
108 bool BKE_curve_material_index_used(struct Curve *cu, int index);
109 void BKE_curve_material_index_clear(struct Curve *cu);
110 bool BKE_curve_material_index_validate(struct Curve *cu);
111 void BKE_curve_material_remap(struct Curve *cu, const unsigned int *remap, unsigned int remap_len);
112
113 ListBase *BKE_curve_nurbs_get(struct Curve *cu);
114
115 int BKE_curve_nurb_vert_index_get(const struct Nurb *nu, const void *vert);
116 void BKE_curve_nurb_active_set(struct Curve *cu, const struct Nurb *nu);
117 struct Nurb *BKE_curve_nurb_active_get(struct Curve *cu);
118 void *BKE_curve_vert_active_get(struct Curve *cu);
119 void BKE_curve_nurb_vert_active_set(struct Curve *cu, const struct Nurb *nu, const void *vert);
120 bool BKE_curve_nurb_vert_active_get(struct Curve *cu, struct Nurb **r_nu, void **r_vert);
121 void BKE_curve_nurb_vert_active_validate(struct Curve *cu);
122
123 float (*BKE_curve_nurbs_vert_coords_alloc(struct ListBase *lb, int *r_vert_len))[3];
124 void BKE_curve_nurbs_vert_coords_get(struct ListBase *lb, float (*vert_coords)[3], int vert_len);
125
126 void BKE_curve_nurbs_vert_coords_apply_with_mat4(struct ListBase *lb,
127                                                  const float (*vert_coords)[3],
128                                                  const float mat[4][4],
129                                                  const bool constrain_2d);
130
131 void BKE_curve_nurbs_vert_coords_apply(struct ListBase *lb,
132                                        const float (*vert_coords)[3],
133                                        const bool constrain_2d);
134
135 float (*BKE_curve_nurbs_key_vert_coords_alloc(struct ListBase *lb,
136                                               float *key,
137                                               int *r_vert_len))[3];
138 void BKE_curve_nurbs_key_vert_tilts_apply(struct ListBase *lb, float *key);
139
140 void BKE_curve_editNurb_keyIndex_delCV(struct GHash *keyindex, const void *cv);
141 void BKE_curve_editNurb_keyIndex_free(struct GHash **keyindex);
142 void BKE_curve_editNurb_free(struct Curve *cu);
143 struct ListBase *BKE_curve_editNurbs_get(struct Curve *cu);
144
145 float *BKE_curve_surf_make_orco(struct Object *ob);
146
147 void BKE_curve_bevelList_free(struct ListBase *bev);
148 void BKE_curve_bevelList_make(struct Object *ob, struct ListBase *nurbs, bool for_render);
149 void BKE_curve_bevel_make(struct Object *ob, struct ListBase *disp);
150
151 void BKE_curve_forward_diff_bezier(
152     float q0, float q1, float q2, float q3, float *p, int it, int stride);
153 void BKE_curve_forward_diff_tangent_bezier(
154     float q0, float q1, float q2, float q3, float *p, int it, int stride);
155
156 void BKE_curve_rect_from_textbox(const struct Curve *cu,
157                                  const struct TextBox *tb,
158                                  struct rctf *r_rect);
159
160 /* ** Nurbs ** */
161
162 bool BKE_nurbList_index_get_co(struct ListBase *editnurb, const int index, float r_co[3]);
163
164 int BKE_nurbList_verts_count(struct ListBase *nurb);
165 int BKE_nurbList_verts_count_without_handles(struct ListBase *nurb);
166
167 void BKE_nurbList_free(struct ListBase *lb);
168 void BKE_nurbList_duplicate(struct ListBase *lb1, const struct ListBase *lb2);
169 void BKE_nurbList_handles_set(struct ListBase *editnurb, const char code);
170 void BKE_nurbList_handles_recalculate(struct ListBase *editnurb,
171                                       const bool calc_length,
172                                       const char flag);
173
174 void BKE_nurbList_handles_autocalc(ListBase *editnurb, int flag);
175 void BKE_nurbList_flag_set(ListBase *editnurb, short flag);
176
177 void BKE_nurb_free(struct Nurb *nu);
178 struct Nurb *BKE_nurb_duplicate(const struct Nurb *nu);
179 struct Nurb *BKE_nurb_copy(struct Nurb *src, int pntsu, int pntsv);
180
181 void BKE_nurb_test_2d(struct Nurb *nu);
182 void BKE_nurb_minmax(struct Nurb *nu, bool use_radius, float min[3], float max[3]);
183 float BKE_nurb_calc_length(const struct Nurb *nu, int resolution);
184
185 void BKE_nurb_makeFaces(
186     const struct Nurb *nu, float *coord_array, int rowstride, int resolu, int resolv);
187 void BKE_nurb_makeCurve(const struct Nurb *nu,
188                         float *coord_array,
189                         float *tilt_array,
190                         float *radius_array,
191                         float *weight_array,
192                         int resolu,
193                         int stride);
194
195 unsigned int BKE_curve_calc_coords_axis_len(const unsigned int bezt_array_len,
196                                             const unsigned int resolu,
197                                             const bool is_cyclic,
198                                             const bool use_cyclic_duplicate_endpoint);
199 void BKE_curve_calc_coords_axis(const struct BezTriple *bezt_array,
200                                 const unsigned int bezt_array_len,
201                                 const unsigned int resolu,
202                                 const bool is_cyclic,
203                                 const bool use_cyclic_duplicate_endpoint,
204                                 /* array params */
205                                 const unsigned int axis,
206                                 const unsigned int stride,
207                                 float *r_points);
208
209 void BKE_nurb_knot_calc_u(struct Nurb *nu);
210 void BKE_nurb_knot_calc_v(struct Nurb *nu);
211
212 /* nurb checks if they can be drawn, also clamp order func */
213 bool BKE_nurb_check_valid_u(const struct Nurb *nu);
214 bool BKE_nurb_check_valid_v(const struct Nurb *nu);
215 bool BKE_nurb_check_valid_uv(const struct Nurb *nu);
216
217 bool BKE_nurb_order_clamp_u(struct Nurb *nu);
218 bool BKE_nurb_order_clamp_v(struct Nurb *nu);
219
220 void BKE_nurb_direction_switch(struct Nurb *nu);
221 bool BKE_nurb_type_convert(struct Nurb *nu, const short type, const bool use_handles);
222
223 void BKE_nurb_points_add(struct Nurb *nu, int number);
224 void BKE_nurb_bezierPoints_add(struct Nurb *nu, int number);
225
226 int BKE_nurb_index_from_uv(struct Nurb *nu, int u, int v);
227 void BKE_nurb_index_to_uv(struct Nurb *nu, int index, int *r_u, int *r_v);
228
229 struct BezTriple *BKE_nurb_bezt_get_next(struct Nurb *nu, struct BezTriple *bezt);
230 struct BezTriple *BKE_nurb_bezt_get_prev(struct Nurb *nu, struct BezTriple *bezt);
231 struct BPoint *BKE_nurb_bpoint_get_next(struct Nurb *nu, struct BPoint *bp);
232 struct BPoint *BKE_nurb_bpoint_get_prev(struct Nurb *nu, struct BPoint *bp);
233
234 void BKE_nurb_bezt_calc_normal(struct Nurb *nu, struct BezTriple *bezt, float r_normal[3]);
235 void BKE_nurb_bezt_calc_plane(struct Nurb *nu, struct BezTriple *bezt, float r_plane[3]);
236
237 void BKE_nurb_bpoint_calc_normal(struct Nurb *nu, struct BPoint *bp, float r_normal[3]);
238 void BKE_nurb_bpoint_calc_plane(struct Nurb *nu, struct BPoint *bp, float r_plane[3]);
239
240 void BKE_nurb_handle_calc(struct BezTriple *bezt,
241                           struct BezTriple *prev,
242                           struct BezTriple *next,
243                           const bool is_fcurve,
244                           const char smoothing);
245 void BKE_nurb_handle_calc_simple(struct Nurb *nu, struct BezTriple *bezt);
246 void BKE_nurb_handle_calc_simple_auto(struct Nurb *nu, struct BezTriple *bezt);
247
248 void BKE_nurb_handle_smooth_fcurve(struct BezTriple *bezt, int total, bool cyclic);
249
250 void BKE_nurb_handles_calc(struct Nurb *nu);
251 void BKE_nurb_handles_autocalc(struct Nurb *nu, int flag);
252 void BKE_nurb_bezt_handle_test(struct BezTriple *bezt, const bool use_handle);
253 void BKE_nurb_handles_test(struct Nurb *nu, const bool use_handles);
254
255 /* **** Depsgraph evaluation **** */
256
257 void BKE_curve_eval_geometry(struct Depsgraph *depsgraph, struct Curve *curve);
258
259 /* Draw Cache */
260 enum {
261   BKE_CURVE_BATCH_DIRTY_ALL = 0,
262   BKE_CURVE_BATCH_DIRTY_SELECT,
263 };
264 void BKE_curve_batch_cache_dirty_tag(struct Curve *cu, int mode);
265 void BKE_curve_batch_cache_free(struct Curve *cu);
266
267 /* curve_decimate.c */
268 unsigned int BKE_curve_decimate_bezt_array(struct BezTriple *bezt_array,
269                                            const unsigned int bezt_array_len,
270                                            const unsigned int resolu,
271                                            const bool is_cyclic,
272                                            const char flag_test,
273                                            const char flag_set,
274                                            const float error_sq_max,
275                                            const unsigned int error_target_len);
276
277 void BKE_curve_decimate_nurb(struct Nurb *nu,
278                              const unsigned int resolu,
279                              const float error_sq_max,
280                              const unsigned int error_target_len);
281
282 extern void (*BKE_curve_batch_cache_dirty_tag_cb)(struct Curve *cu, int mode);
283 extern void (*BKE_curve_batch_cache_free_cb)(struct Curve *cu);
284
285 #endif /* __BKE_CURVE_H__ */