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