Cleanup: remove redundant doxygen \file argument
[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 \ingroup bke
23  */
24 struct Curve;
25 struct ID;
26 struct Key;
27 struct KeyBlock;
28 struct Lattice;
29 struct ListBase;
30 struct Main;
31 struct Mesh;
32 struct Object;
33 struct WeightsArrayCache;
34
35 /* Kernel prototypes */
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 void        BKE_key_free(struct Key *sc);
41 void        BKE_key_free_nolib(struct Key *key);
42 struct Key *BKE_key_add(struct Main *bmain, struct ID *id);
43 void BKE_key_copy_data(struct Main *bmain, struct Key *key_dst, const struct Key *key_src, const int flag);
44 struct Key *BKE_key_copy(struct Main *bmain, const struct Key *key);
45 struct Key *BKE_key_copy_nolib(struct Key *key);
46 void        BKE_key_sort(struct Key *key);
47
48 void key_curve_position_weights(float t, float data[4], int type);
49 void key_curve_tangent_weights(float t, float data[4], int type);
50 void key_curve_normal_weights(float t, float data[4], int type);
51
52 float *BKE_key_evaluate_object_ex(
53         struct Object *ob, int *r_totelem,
54         float *arr, size_t arr_size);
55 float *BKE_key_evaluate_object(
56         struct Object *ob, int *r_totelem);
57
58 bool BKE_key_idtype_support(const short id_type);
59
60 struct Key     **BKE_key_from_id_p(struct ID *id);
61 struct Key      *BKE_key_from_id(struct ID *id);
62 struct Key     **BKE_key_from_object_p(struct Object *ob);
63 struct Key      *BKE_key_from_object(struct Object *ob);
64 struct KeyBlock *BKE_keyblock_from_object(struct Object *ob);
65 struct KeyBlock *BKE_keyblock_from_object_reference(struct Object *ob);
66
67 struct KeyBlock *BKE_keyblock_add(struct Key *key, const char *name);
68 struct KeyBlock *BKE_keyblock_add_ctime(struct Key *key, const char *name, const bool do_force);
69 struct KeyBlock *BKE_keyblock_from_key(struct Key *key, int index);
70 struct KeyBlock *BKE_keyblock_find_name(struct Key *key, const char name[]);
71 void             BKE_keyblock_copy_settings(struct KeyBlock *kb_dst, const struct KeyBlock *kb_src);
72 char            *BKE_keyblock_curval_rnapath_get(struct Key *key, struct KeyBlock *kb);
73
74 /* conversion functions */
75 /* Note: 'update_from' versions do not (re)allocate mem in kb, while 'convert_from' do. */
76 void    BKE_keyblock_update_from_lattice(struct Lattice *lt, struct KeyBlock *kb);
77 void    BKE_keyblock_convert_from_lattice(struct Lattice *lt, struct KeyBlock *kb);
78 void    BKE_keyblock_convert_to_lattice(struct KeyBlock *kb, struct Lattice *lt);
79
80 int     BKE_keyblock_curve_element_count(struct ListBase *nurb);
81 void    BKE_keyblock_update_from_curve(struct Curve *cu, struct KeyBlock *kb, struct ListBase *nurb);
82 void    BKE_keyblock_convert_from_curve(struct Curve *cu, struct KeyBlock *kb, struct ListBase *nurb);
83 void    BKE_keyblock_convert_to_curve(struct KeyBlock *kb, struct Curve  *cu, struct ListBase *nurb);
84
85 void    BKE_keyblock_update_from_mesh(struct Mesh *me, struct KeyBlock *kb);
86 void    BKE_keyblock_convert_from_mesh(struct Mesh *me, struct Key *key, struct KeyBlock *kb);
87 void    BKE_keyblock_convert_to_mesh(struct KeyBlock *kb, struct Mesh *me);
88 void    BKE_keyblock_mesh_calc_normals(
89         struct KeyBlock *kb, struct Mesh *mesh, float (*r_vertnors)[3], float (*r_polynors)[3], float (*r_loopnors)[3]);
90
91 void    BKE_keyblock_update_from_vertcos(struct Object *ob, struct KeyBlock *kb, float (*vertCos)[3]);
92 void    BKE_keyblock_convert_from_vertcos(struct Object *ob, struct KeyBlock *kb, float (*vertCos)[3]);
93 float (*BKE_keyblock_convert_to_vertcos(struct Object *ob, struct KeyBlock *kb))[3];
94
95 void    BKE_keyblock_update_from_offset(struct Object *ob, struct KeyBlock *kb, float (*ofs)[3]);
96
97 /* other management */
98 bool    BKE_keyblock_move(struct Object *ob, int org_index, int new_index);
99
100 bool    BKE_keyblock_is_basis(struct Key *key, const int index);
101
102 #ifdef __cplusplus
103 };
104 #endif
105
106 #endif  /* __BKE_KEY_H__ */