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