Fix T64842: crash rendering files with bevel curves
[blender.git] / source / blender / blenkernel / BKE_key.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19 #ifndef __BKE_KEY_H__
20 #define __BKE_KEY_H__
21
22 /** \file
23  * \ingroup bke
24  */
25 struct Curve;
26 struct ID;
27 struct Key;
28 struct KeyBlock;
29 struct Lattice;
30 struct ListBase;
31 struct Main;
32 struct Mesh;
33 struct Object;
34 struct WeightsArrayCache;
35
36 /* Kernel prototypes */
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 void BKE_key_free(struct Key *sc);
42 void BKE_key_free_nolib(struct Key *key);
43 struct Key *BKE_key_add(struct Main *bmain, struct ID *id);
44 void BKE_key_copy_data(struct Main *bmain,
45                        struct Key *key_dst,
46                        const struct Key *key_src,
47                        const int flag);
48 struct Key *BKE_key_copy(struct Main *bmain, const struct Key *key);
49 struct Key *BKE_key_copy_nolib(struct Key *key);
50 void BKE_key_sort(struct Key *key);
51
52 void key_curve_position_weights(float t, float data[4], int type);
53 void key_curve_tangent_weights(float t, float data[4], int type);
54 void key_curve_normal_weights(float t, float data[4], int type);
55
56 float *BKE_key_evaluate_object_ex(struct Object *ob, int *r_totelem, float *arr, size_t arr_size);
57 float *BKE_key_evaluate_object(struct Object *ob, int *r_totelem);
58
59 bool BKE_key_idtype_support(const short id_type);
60
61 struct Key **BKE_key_from_id_p(struct ID *id);
62 struct Key *BKE_key_from_id(struct ID *id);
63 struct Key **BKE_key_from_object_p(const struct Object *ob);
64 struct Key *BKE_key_from_object(const struct Object *ob);
65 struct KeyBlock *BKE_keyblock_from_object(struct Object *ob);
66 struct KeyBlock *BKE_keyblock_from_object_reference(struct Object *ob);
67
68 struct KeyBlock *BKE_keyblock_add(struct Key *key, const char *name);
69 struct KeyBlock *BKE_keyblock_add_ctime(struct Key *key, const char *name, const bool do_force);
70 struct KeyBlock *BKE_keyblock_from_key(struct Key *key, int index);
71 struct KeyBlock *BKE_keyblock_find_name(struct Key *key, const char name[]);
72 void BKE_keyblock_copy_settings(struct KeyBlock *kb_dst, const struct KeyBlock *kb_src);
73 char *BKE_keyblock_curval_rnapath_get(struct Key *key, struct KeyBlock *kb);
74
75 /* conversion functions */
76 /* Note: 'update_from' versions do not (re)allocate mem in kb, while 'convert_from' do. */
77 void BKE_keyblock_update_from_lattice(struct Lattice *lt, struct KeyBlock *kb);
78 void BKE_keyblock_convert_from_lattice(struct Lattice *lt, struct KeyBlock *kb);
79 void BKE_keyblock_convert_to_lattice(struct KeyBlock *kb, struct Lattice *lt);
80
81 int BKE_keyblock_curve_element_count(struct ListBase *nurb);
82 void BKE_keyblock_update_from_curve(struct Curve *cu, struct KeyBlock *kb, struct ListBase *nurb);
83 void BKE_keyblock_convert_from_curve(struct Curve *cu, struct KeyBlock *kb, struct ListBase *nurb);
84 void BKE_keyblock_convert_to_curve(struct KeyBlock *kb, struct Curve *cu, struct ListBase *nurb);
85
86 void BKE_keyblock_update_from_mesh(struct Mesh *me, struct KeyBlock *kb);
87 void BKE_keyblock_convert_from_mesh(struct Mesh *me, struct Key *key, struct KeyBlock *kb);
88 void BKE_keyblock_convert_to_mesh(struct KeyBlock *kb, struct Mesh *me);
89 void BKE_keyblock_mesh_calc_normals(struct KeyBlock *kb,
90                                     struct Mesh *mesh,
91                                     float (*r_vertnors)[3],
92                                     float (*r_polynors)[3],
93                                     float (*r_loopnors)[3]);
94
95 void BKE_keyblock_update_from_vertcos(struct Object *ob, struct KeyBlock *kb, float (*vertCos)[3]);
96 void BKE_keyblock_convert_from_vertcos(struct Object *ob,
97                                        struct KeyBlock *kb,
98                                        float (*vertCos)[3]);
99 float (*BKE_keyblock_convert_to_vertcos(struct Object *ob, struct KeyBlock *kb))[3];
100
101 void BKE_keyblock_update_from_offset(struct Object *ob, struct KeyBlock *kb, float (*ofs)[3]);
102
103 /* other management */
104 bool BKE_keyblock_move(struct Object *ob, int org_index, int new_index);
105
106 bool BKE_keyblock_is_basis(struct Key *key, const int index);
107
108 #ifdef __cplusplus
109 };
110 #endif
111
112 #endif /* __BKE_KEY_H__ */