Armature drawing: custom shape scale options
[blender-staging.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 Mesh;
43 struct WeightsArrayCache;
44
45 /* Kernel prototypes */
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
50 void        BKE_key_free(struct Key *sc);
51 void        BKE_key_free_nolib(struct Key *key);
52 struct Key *BKE_key_add(struct ID *id);
53 struct Key *BKE_key_copy(struct Key *key);
54 struct Key *BKE_key_copy_nolib(struct Key *key);
55 void        BKE_key_make_local(struct Key *key);
56 void        BKE_key_sort(struct Key *key);
57
58 void key_curve_position_weights(float t, float data[4], int type);
59 void key_curve_tangent_weights(float t, float data[4], int type);
60 void key_curve_normal_weights(float t, float data[4], int type);
61
62 float *BKE_key_evaluate_object_ex(
63         struct Object *ob, int *r_totelem,
64         float *arr, size_t arr_size);
65 float *BKE_key_evaluate_object(
66         struct Object *ob, int *r_totelem);
67
68 struct Key     **BKE_key_from_object_p(struct Object *ob);
69 struct Key      *BKE_key_from_object(struct Object *ob);
70 struct KeyBlock *BKE_keyblock_from_object(struct Object *ob);
71 struct KeyBlock *BKE_keyblock_from_object_reference(struct Object *ob);
72
73 struct KeyBlock *BKE_keyblock_add(struct Key *key, const char *name);
74 struct KeyBlock *BKE_keyblock_add_ctime(struct Key *key, const char *name, const bool do_force);
75 struct KeyBlock *BKE_keyblock_from_key(struct Key *key, int index);
76 struct KeyBlock *BKE_keyblock_find_name(struct Key *key, const char name[]);
77 void             BKE_keyblock_copy_settings(struct KeyBlock *kb_dst, const struct KeyBlock *kb_src);
78 char            *BKE_keyblock_curval_rnapath_get(struct Key *key, struct KeyBlock *kb);
79
80 // needed for the GE
81 typedef struct WeightsArrayCache {
82         int num_defgroup_weights;
83         float **defgroup_weights;
84 } WeightsArrayCache;
85
86 float **BKE_keyblock_get_per_block_weights(struct Object *ob, struct Key *key, struct WeightsArrayCache *cache);
87 void BKE_keyblock_free_per_block_weights(struct Key *key, float **per_keyblock_weights, struct WeightsArrayCache *cache);
88 void BKE_key_evaluate_relative(const int start, int end, const int tot, char *basispoin, struct Key *key, struct KeyBlock *actkb,
89                                float **per_keyblock_weights, const int mode);
90
91 /* conversion functions */
92 /* Note: 'update_from' versions do not (re)allocate mem in kb, while 'convert_from' do. */
93 void    BKE_keyblock_update_from_lattice(struct Lattice *lt, struct KeyBlock *kb);
94 void    BKE_keyblock_convert_from_lattice(struct Lattice *lt, struct KeyBlock *kb);
95 void    BKE_keyblock_convert_to_lattice(struct KeyBlock *kb, struct Lattice *lt);
96
97 void    BKE_keyblock_update_from_curve(struct Curve *cu, struct KeyBlock *kb, struct ListBase *nurb);
98 void    BKE_keyblock_convert_from_curve(struct Curve *cu, struct KeyBlock *kb, struct ListBase *nurb);
99 void    BKE_keyblock_convert_to_curve(struct KeyBlock *kb, struct Curve  *cu, struct ListBase *nurb);
100
101 void    BKE_keyblock_update_from_mesh(struct Mesh *me, struct KeyBlock *kb);
102 void    BKE_keyblock_convert_from_mesh(struct Mesh *me, struct KeyBlock *kb);
103 void    BKE_keyblock_convert_to_mesh(struct KeyBlock *kb, struct Mesh *me);
104
105 void    BKE_keyblock_update_from_vertcos(struct Object *ob, struct KeyBlock *kb, float (*vertCos)[3]);
106 void    BKE_keyblock_convert_from_vertcos(struct Object *ob, struct KeyBlock *kb, float (*vertCos)[3]);
107 float (*BKE_keyblock_convert_to_vertcos(struct Object *ob, struct KeyBlock *kb))[3];
108
109 void    BKE_keyblock_update_from_offset(struct Object *ob, struct KeyBlock *kb, float (*ofs)[3]);
110
111 /* other management */
112 bool    BKE_keyblock_move(struct Object *ob, int org_index, int new_index);
113
114 bool    BKE_keyblock_is_basis(struct Key *key, const int index);
115
116 #ifdef __cplusplus
117 };
118 #endif
119
120 #endif  /* __BKE_KEY_H__ */