Merging r59130 through r59135 from trunk into soc-2013-depsgraph_mt
[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 BevList;
37 struct BezTriple;
38 struct Curve;
39 struct EditNurb;
40 struct ListBase;
41 struct Main;
42 struct Nurb;
43 struct Object;
44 struct Scene;
45 struct Path;
46
47 typedef struct CurveCache {
48         ListBase disp;
49         ListBase bev;
50         struct Path *path;
51 } CurveCache;
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 /* ** Curve ** */
64 void BKE_curve_unlink(struct Curve *cu);
65 void BKE_curve_free(struct Curve *cu);
66 void BKE_curve_editfont_free(struct Curve *cu);
67 struct Curve *BKE_curve_add(struct Main *bmain, const char *name, int type);
68 struct Curve *BKE_curve_copy(struct Curve *cu);
69 void BKE_curve_make_local(struct Curve *cu);
70 short BKE_curve_type_get(struct Curve *cu);
71 void BKE_curve_type_test(struct Object *ob);
72 void BKE_curve_curve_dimension_update(struct Curve *cu);
73
74 void BKE_curve_boundbox_calc(struct Curve *cu, float r_loc[3], float r_size[3]);
75 struct BoundBox *BKE_curve_boundbox_get(struct Object *ob);
76 void BKE_curve_texspace_calc(struct Curve *cu);
77 void BKE_curve_texspace_get(struct Curve *cu, float r_loc[3], float r_rot[3], float r_size[3]);
78
79 bool BKE_curve_minmax(struct Curve *cu, bool use_radius, float min[3], float max[3]);
80 bool BKE_curve_center_median(struct Curve *cu, float cent[3]);
81 bool BKE_curve_center_bounds(struct Curve *cu, float cent[3]);
82 void BKE_curve_translate(struct Curve *cu, float offset[3], int do_keys);
83 void BKE_curve_delete_material_index(struct Curve *cu, int index);
84
85 ListBase *BKE_curve_nurbs_get(struct Curve *cu);
86
87 float (*BKE_curve_nurbs_vertexCos_get(struct ListBase *lb, int *numVerts_r))[3];
88 void BK_curve_nurbs_vertexCos_apply(struct ListBase *lb, float (*vertexCos)[3]);
89
90 float (*BKE_curve_nurbs_keyVertexCos_get(struct ListBase *lb, float *key))[3];
91 void BKE_curve_nurbs_keyVertexTilts_apply(struct ListBase *lb, float *key);
92
93 void BKE_curve_editNurb_keyIndex_free(struct EditNurb *editnurb);
94 void BKE_curve_editNurb_free(struct Curve *cu);
95 struct ListBase *BKE_curve_editNurbs_get(struct Curve *cu);
96
97 float *BKE_curve_make_orco(struct Scene *scene, struct Object *ob, int *r_numVerts);
98 float *BKE_curve_surf_make_orco(struct Object *ob);
99
100 void BKE_curve_bevelList_make(struct Object *ob, struct ListBase *nurbs, bool for_render);
101 void BKE_curve_bevel_make(struct Scene *scene, struct Object *ob,  struct ListBase *disp, int forRender, int renderResolution);
102
103 void BKE_curve_forward_diff_bezier(float q0, float q1, float q2, float q3, float *p, int it, int stride);
104
105 /* ** Nurbs ** */
106
107 int BKE_nurbList_index_get_co(struct ListBase *editnurb, const int index, float r_co[3]);
108
109 int BKE_nurbList_verts_count(struct ListBase *nurb);
110 int BKE_nurbList_verts_count_without_handles(struct ListBase *nurb);
111
112 void BKE_nurbList_free(struct ListBase *lb);
113 void BKE_nurbList_duplicate(struct ListBase *lb1,  struct ListBase *lb2);
114 void BKE_nurbList_handles_set(struct ListBase *editnurb, short code);
115
116 void BKE_nurbList_handles_autocalc(ListBase *editnurb, int flag);
117
118 void BKE_nurb_free(struct Nurb *nu);
119 struct Nurb *BKE_nurb_duplicate(struct Nurb *nu);
120
121 void BKE_nurb_test2D(struct Nurb *nu);
122 void BKE_nurb_minmax(struct Nurb *nu, bool use_radius, float min[3], float max[3]);
123
124 void BKE_nurb_makeFaces(struct Nurb *nu, float *coord_array, int rowstride, int resolu, int resolv);
125 void BKE_nurb_makeCurve(struct Nurb *nu, float *coord_array, float *tilt_array, float *radius_array, float *weight_array, int resolu, int stride);
126
127 void BKE_nurb_knot_calc_u(struct Nurb *nu);
128 void BKE_nurb_knot_calc_v(struct Nurb *nu);
129
130 /* nurb checks if they can be drawn, also clamp order func */
131 bool BKE_nurb_check_valid_u(struct Nurb *nu);
132 bool BKE_nurb_check_valid_v(struct Nurb *nu);
133
134 bool BKE_nurb_order_clamp_u(struct Nurb *nu);
135 bool BKE_nurb_order_clamp_v(struct Nurb *nu);
136
137 void BKE_nurb_direction_switch(struct Nurb *nu);
138 bool BKE_nurb_type_convert(struct Nurb *nu, const short type, const bool use_handles);
139
140 void BKE_nurb_points_add(struct Nurb *nu, int number);
141 void BKE_nurb_bezierPoints_add(struct Nurb *nu, int number);
142
143 struct BezTriple *BKE_nurb_bezt_get_next(struct Nurb *nu, struct BezTriple *bezt);
144 struct BezTriple *BKE_nurb_bezt_get_prev(struct Nurb *nu, struct BezTriple *bezt);
145 struct BPoint    *BKE_nurb_bpoint_get_next(struct Nurb *nu, struct BPoint *bp);
146 struct BPoint    *BKE_nurb_bpoint_get_prev(struct Nurb *nu, struct BPoint *bp);
147
148 void BKE_nurb_bezt_calc_normal(struct Nurb *nu, struct BezTriple *bezt, float r_normal[3]);
149 void BKE_nurb_bezt_calc_plane(struct Nurb *nu, struct BezTriple *bezt, float r_plane[3]);
150
151 void BKE_nurb_handle_calc(struct BezTriple *bezt, struct BezTriple *prev,  struct BezTriple *next, int mode);
152
153 void BKE_nurb_handles_calc(struct Nurb *nu);
154 void BKE_nurb_handles_autocalc(struct Nurb *nu, int flag);
155 void BKE_nurb_handles_test(struct Nurb *nu);
156
157 #endif  /* __BKE_CURVE_H__ */