ID-Remap - Step one: core work (cleanup and rework of generic ID datablock handling).
[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 ListBase;
40 struct Main;
41 struct Nurb;
42 struct Object;
43 struct Scene;
44 struct Path;
45 struct TextBox;
46 struct rctf;
47
48 typedef struct CurveCache {
49         ListBase disp;
50         ListBase bev;
51         ListBase deformed_nurbs;
52         struct Path *path;
53 } CurveCache;
54
55 #define KNOTSU(nu)      ( (nu)->orderu + (nu)->pntsu + (((nu)->flagu & CU_NURB_CYCLIC) ? ((nu)->orderu - 1) : 0) )
56 #define KNOTSV(nu)      ( (nu)->orderv + (nu)->pntsv + (((nu)->flagv & CU_NURB_CYCLIC) ? ((nu)->orderv - 1) : 0) )
57
58 /* Non cyclic nurbs have 1 less segment */
59 #define SEGMENTSU(nu)       ( ((nu)->flagu & CU_NURB_CYCLIC) ? (nu)->pntsu : (nu)->pntsu - 1)
60 #define SEGMENTSV(nu)       ( ((nu)->flagv & CU_NURB_CYCLIC) ? (nu)->pntsv : (nu)->pntsv - 1)
61
62 #define CU_DO_TILT(cu, nu) (((nu->flag & CU_2D) && (cu->flag & CU_3D) == 0) ? 0 : 1)
63 #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)
64
65 /* not 3d and not unfilled */
66 #define CU_DO_2DFILL(cu)  ((((cu)->flag & CU_3D) == 0) && (((cu)->flag & (CU_FRONT | CU_BACK)) != 0))
67
68 /* ** Curve ** */
69 void BKE_curve_free(struct Curve *cu);
70 void BKE_curve_editfont_free(struct Curve *cu);
71 void BKE_curve_init(struct Curve *cu);
72 struct Curve *BKE_curve_add(struct Main *bmain, const char *name, int type);
73 struct Curve *BKE_curve_copy(struct Curve *cu);
74 void BKE_curve_make_local(struct Curve *cu);
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 void 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 float unit_scale);
88 void BKE_curve_transform(struct Curve *cu, float mat[4][4], const bool do_keys);
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 int 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_free(struct EditNurb *editnurb);
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 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(struct Scene *scene, struct Object *ob,  struct ListBase *disp,
121                           const bool for_render, const bool use_render_resolution);
122
123 void BKE_curve_forward_diff_bezier(float q0, float q1, float q2, float q3, float *p, int it, int stride);
124 void BKE_curve_forward_diff_tangent_bezier(float q0, float q1, float q2, float q3, float *p, int it, int stride);
125
126 void BKE_curve_rect_from_textbox(const struct Curve *cu, const struct TextBox *tb, struct rctf *r_rect);
127
128 /* ** Nurbs ** */
129
130 bool BKE_nurbList_index_get_co(struct ListBase *editnurb, const int index, float r_co[3]);
131
132 int BKE_nurbList_verts_count(struct ListBase *nurb);
133 int BKE_nurbList_verts_count_without_handles(struct ListBase *nurb);
134
135 void BKE_nurbList_free(struct ListBase *lb);
136 void BKE_nurbList_duplicate(struct ListBase *lb1,  struct ListBase *lb2);
137 void BKE_nurbList_handles_set(struct ListBase *editnurb, const char code);
138 void BKE_nurbList_handles_recalculate(struct ListBase *editnurb, const bool calc_length, const char flag);
139
140 void BKE_nurbList_handles_autocalc(ListBase *editnurb, int flag);
141 void BKE_nurbList_flag_set(ListBase *editnurb, short flag);
142
143 void BKE_nurb_free(struct Nurb *nu);
144 struct Nurb *BKE_nurb_duplicate(struct Nurb *nu);
145 struct Nurb *BKE_nurb_copy(struct Nurb *src, int pntsu, int pntsv);
146
147 void BKE_nurb_test2D(struct Nurb *nu);
148 void BKE_nurb_minmax(struct Nurb *nu, bool use_radius, float min[3], float max[3]);
149
150 void BKE_nurb_makeFaces(struct Nurb *nu, float *coord_array, int rowstride, int resolu, int resolv);
151 void BKE_nurb_makeCurve(struct Nurb *nu, float *coord_array, float *tilt_array, float *radius_array, float *weight_array, int resolu, int stride);
152
153 void BKE_nurb_knot_calc_u(struct Nurb *nu);
154 void BKE_nurb_knot_calc_v(struct Nurb *nu);
155
156 /* nurb checks if they can be drawn, also clamp order func */
157 bool BKE_nurb_check_valid_u(struct Nurb *nu);
158 bool BKE_nurb_check_valid_v(struct Nurb *nu);
159 bool BKE_nurb_check_valid_uv(struct Nurb *nu);
160
161 bool BKE_nurb_order_clamp_u(struct Nurb *nu);
162 bool BKE_nurb_order_clamp_v(struct Nurb *nu);
163
164 void BKE_nurb_direction_switch(struct Nurb *nu);
165 bool BKE_nurb_type_convert(struct Nurb *nu, const short type, const bool use_handles);
166
167 void BKE_nurb_points_add(struct Nurb *nu, int number);
168 void BKE_nurb_bezierPoints_add(struct Nurb *nu, int number);
169
170 int  BKE_nurb_index_from_uv(struct Nurb *nu, int u, int v);
171 void BKE_nurb_index_to_uv(struct Nurb *nu, int index, int *r_u, int *r_v);
172
173 struct BezTriple *BKE_nurb_bezt_get_next(struct Nurb *nu, struct BezTriple *bezt);
174 struct BezTriple *BKE_nurb_bezt_get_prev(struct Nurb *nu, struct BezTriple *bezt);
175 struct BPoint    *BKE_nurb_bpoint_get_next(struct Nurb *nu, struct BPoint *bp);
176 struct BPoint    *BKE_nurb_bpoint_get_prev(struct Nurb *nu, struct BPoint *bp);
177
178 void BKE_nurb_bezt_calc_normal(struct Nurb *nu, struct BezTriple *bezt, float r_normal[3]);
179 void BKE_nurb_bezt_calc_plane(struct Nurb *nu, struct BezTriple *bezt, float r_plane[3]);
180
181 void BKE_nurb_bpoint_calc_normal(struct Nurb *nu, struct BPoint *bp, float r_normal[3]);
182
183 void BKE_nurb_handle_calc(struct BezTriple *bezt, struct BezTriple *prev,  struct BezTriple *next,
184                           const bool is_fcurve);
185 void BKE_nurb_handle_calc_simple(struct Nurb *nu, struct BezTriple *bezt);
186 void BKE_nurb_handle_calc_simple_auto(struct Nurb *nu, struct BezTriple *bezt);
187
188 void BKE_nurb_handles_calc(struct Nurb *nu);
189 void BKE_nurb_handles_autocalc(struct Nurb *nu, int flag);
190 void BKE_nurb_bezt_handle_test(struct BezTriple *bezt, const bool use_handle);
191 void BKE_nurb_handles_test(struct Nurb *nu, const bool use_handles);
192
193 /* **** Depsgraph evaluation **** */
194
195 struct EvaluationContext;
196
197 void BKE_curve_eval_geometry(struct EvaluationContext *eval_ctx,
198                              struct Curve *curve);
199
200 void BKE_curve_eval_path(struct EvaluationContext *eval_ctx,
201                          struct Curve *curve);
202
203 #endif  /* __BKE_CURVE_H__ */