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