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