Merged changes in the trunk up to revision 53584.
[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 ListBase;
42 struct Nurb;
43 struct Object;
44 struct Scene;
45
46 #define KNOTSU(nu)      ( (nu)->orderu + (nu)->pntsu + (((nu)->flagu & CU_NURB_CYCLIC) ? ((nu)->orderu - 1) : 0) )
47 #define KNOTSV(nu)      ( (nu)->orderv + (nu)->pntsv + (((nu)->flagv & CU_NURB_CYCLIC) ? ((nu)->orderv - 1) : 0) )
48
49 /* Non cyclic nurbs have 1 less segment */
50 #define SEGMENTSU(nu)       ( ((nu)->flagu & CU_NURB_CYCLIC) ? (nu)->pntsu : (nu)->pntsu - 1)
51 #define SEGMENTSV(nu)       ( ((nu)->flagv & CU_NURB_CYCLIC) ? (nu)->pntsv : (nu)->pntsv - 1)
52
53 #define CU_DO_TILT(cu, nu) (((nu->flag & CU_2D) && (cu->flag & CU_3D) == 0) ? 0 : 1)
54 #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)
55
56 /* ** Curve ** */
57 void BKE_curve_unlink(struct Curve *cu);
58 void BKE_curve_free(struct Curve *cu);
59 void BKE_curve_editfont_free(struct Curve *cu);
60 struct Curve *BKE_curve_add(const char *name, int type);
61 struct Curve *BKE_curve_copy(struct Curve *cu);
62 void BKE_curve_make_local(struct Curve *cu);
63 short BKE_curve_type_get(struct Curve *cu);
64 void BKE_curve_type_test(struct Object *ob);
65 void BKE_curve_curve_dimension_update(struct Curve *cu);
66 void BKE_curve_texspace_calc(struct Curve *cu);
67
68 int BKE_curve_minmax(struct Curve *cu, float min[3], float max[3]);
69 int BKE_curve_center_median(struct Curve *cu, float cent[3]);
70 int BKE_curve_center_bounds(struct Curve *cu, float cent[3]);
71 void BKE_curve_translate(struct Curve *cu, float offset[3], int do_keys);
72 void BKE_curve_delete_material_index(struct Curve *cu, int index);
73
74 ListBase *BKE_curve_nurbs_get(struct Curve *cu);
75
76 float (*BKE_curve_vertexCos_get(struct Curve *cu, struct ListBase *lb, int *numVerts_r))[3];
77 void BK_curve_vertexCos_apply(struct Curve *cu, struct ListBase *lb, float (*vertexCos)[3]);
78
79 float (*BKE_curve_keyVertexCos_get(struct Curve *cu, struct ListBase *lb, float *key))[3];
80 void BKE_curve_keyVertexTilts_apply(struct Curve *cu, struct ListBase *lb, float *key);
81
82 void BKE_curve_editNurb_keyIndex_free(struct EditNurb *editnurb);
83 void BKE_curve_editNurb_free(struct Curve *cu);
84 struct ListBase *BKE_curve_editNurbs_get(struct Curve *cu);
85
86 float *BKE_curve_make_orco(struct Scene *scene, struct Object *ob);
87 float *BKE_curve_surf_make_orco(struct Object *ob);
88
89 void BKE_curve_bevelList_make(struct Object *ob);
90 void BKE_curve_bevel_make(struct Scene *scene, struct Object *ob,  struct ListBase *disp, int forRender);
91
92 void BKE_curve_forward_diff_bezier(float q0, float q1, float q2, float q3, float *p, int it, int stride);
93
94 /* ** Nurbs ** */
95
96 int BKE_nurbList_index_get_co(struct ListBase *editnurb, const int index, float r_co[3]);
97
98 int BKE_nurbList_verts_count(struct ListBase *nurb);
99 int BKE_nurbList_verts_count_without_handles(struct ListBase *nurb);
100
101 void BKE_nurbList_free(struct ListBase *lb);
102 void BKE_nurbList_duplicate(struct ListBase *lb1,  struct ListBase *lb2);
103 void BKE_nurbList_handles_set(struct ListBase *editnurb, short code);
104
105 void BKE_nurbList_handles_autocalc(ListBase *editnurb, int flag);
106
107 void BKE_nurb_free(struct Nurb *nu);
108 struct Nurb *BKE_nurb_duplicate(struct Nurb *nu);
109
110 void BKE_nurb_test2D(struct Nurb *nu);
111 void BKE_nurb_minmax(struct Nurb *nu, float min[3], float max[3]);
112
113 void BKE_nurb_makeFaces(struct Nurb *nu, float *coord_array, int rowstride, int resolu, int resolv);
114 void BKE_nurb_makeCurve(struct Nurb *nu, float *coord_array, float *tilt_array, float *radius_array, float *weight_array, int resolu, int stride);
115
116 void BKE_nurb_knot_calc_u(struct Nurb *nu);
117 void BKE_nurb_knot_calc_v(struct Nurb *nu);
118
119 /* nurb checks if they can be drawn, also clamp order func */
120 int BKE_nurb_check_valid_u(struct Nurb *nu);
121 int BKE_nurb_check_valid_v(struct Nurb *nu);
122
123 int BKE_nurb_order_clamp_u(struct Nurb *nu);
124 int BKE_nurb_order_clamp_v(struct Nurb *nu);
125
126 void BKE_nurb_direction_switch(struct Nurb *nu);
127
128 void BKE_nurb_points_add(struct Nurb *nu, int number);
129 void BKE_nurb_bezierPoints_add(struct Nurb *nu, int number);
130
131 void BKE_nurb_handle_calc(struct BezTriple *bezt, struct BezTriple *prev,  struct BezTriple *next, int mode);
132
133 void BKE_nurb_handles_calc(struct Nurb *nu);
134 void BKE_nurb_handles_autocalc(struct Nurb *nu, int flag);
135 void BKE_nurb_handles_test(struct Nurb *nu);
136
137 #endif