svn merge ^/trunk/blender -r43436:43443
[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 Scene;
42 struct Lattice;
43 struct Mesh;
44
45 /* Kernel prototypes */
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
50 void free_key(struct Key *sc); 
51 void free_key_nolib(struct Key *key);
52 struct Key *add_key(struct ID *id);
53 struct Key *copy_key(struct Key *key);
54 struct Key *copy_key_nolib(struct Key *key);
55 void make_local_key(struct Key *key);
56 void sort_keys(struct Key *key);
57
58 void key_curve_position_weights(float t, float *data, int type);
59 void key_curve_tangent_weights(float t, float *data, int type);
60 void key_curve_normal_weights(float t, float *data, int type);
61
62 float *do_ob_key(struct Scene *scene, struct Object *ob);
63
64 struct Key *ob_get_key(struct Object *ob);
65 struct KeyBlock *add_keyblock(struct Key *key, const char *name);
66 struct KeyBlock *ob_get_keyblock(struct Object *ob);
67 struct KeyBlock *ob_get_reference_keyblock(struct Object *ob);
68 struct KeyBlock *key_get_keyblock(struct Key *key, int index);
69 struct KeyBlock *key_get_named_keyblock(struct Key *key, const char name[]);
70 char *key_get_curValue_rnaPath(struct Key *key, struct KeyBlock *kb);
71 // needed for the GE
72 void do_rel_key(const int start, int end, const int tot, char *basispoin, struct Key *key, struct KeyBlock *actkb, const int mode);
73
74 /* conversion functions */
75 void key_to_mesh(struct KeyBlock *kb, struct Mesh *me);
76 void mesh_to_key(struct Mesh *me, struct KeyBlock *kb);
77 void key_to_latt(struct KeyBlock *kb, struct Lattice *lt);
78 void latt_to_key(struct Lattice *lt, struct KeyBlock *kb);
79 void key_to_curve(struct KeyBlock *kb, struct Curve  *cu, struct ListBase *nurb);
80 void curve_to_key(struct Curve *cu, struct KeyBlock *kb, struct ListBase *nurb);
81 float (*key_to_vertcos(struct Object *ob, struct KeyBlock *kb))[3];
82 void vertcos_to_key(struct Object *ob, struct KeyBlock *kb, float (*vertCos)[3]);
83 void offset_to_key(struct Object *ob, struct KeyBlock *kb, float (*ofs)[3]);
84
85 /* key.c */
86 extern int slurph_opt;
87
88 #ifdef __cplusplus
89 };
90 #endif
91
92 #endif // BKE_KEY_H