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