Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / source / blender / ikplugin / BIK_api.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Original author: Benoit Bolsee
25  * Contributor(s): 
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef BIK_API_H
31 #define BIK_API_H
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 struct Object;
38 struct bPoseChannel;
39 struct bPose;
40 struct bArmature;
41 struct Scene;
42 struct bConstraint;
43
44 enum BIK_ParamType {
45         BIK_PARAM_TYPE_FLOAT = 0,
46         BIK_PARAM_TYPE_INT,
47         BIK_PARAM_TYPE_STRING,
48 };
49
50 struct BIK_ParamValue {
51         short type;                     /* BIK_PARAM_TYPE_.. */
52         short length;           /* for string, does not include terminating 0 */
53         union {
54                 float f[8];
55                 int   i[8];
56                 char  s[32];
57         } value;                
58 };
59 typedef struct BIK_ParamValue BIK_ParamValue;
60
61 void BIK_initialize_tree(struct Scene *scene, struct Object *ob, float ctime);
62 void BIK_execute_tree(struct Scene *scene, struct Object *ob, struct bPoseChannel *pchan, float ctime);
63 void BIK_release_tree(struct Scene *scene, struct Object *ob, float ctime);
64 void BIK_clear_data(struct bPose *pose);
65 void BIK_clear_cache(struct bPose *pose);
66 void BIK_update_param(struct bPose *pose);
67 void BIK_test_constraint(struct Object *ob, struct bConstraint *cons);
68 // not yet implemented
69 int BIK_get_constraint_param(struct bPose *pose, struct bConstraint *cons, int id, BIK_ParamValue *value);
70 int BIK_get_channel_param(struct bPose *pose, struct bPoseChannel *pchan, int id, BIK_ParamValue *value);
71 int BIK_get_solver_param(struct bPose *pose, struct bPoseChannel *pchan, int id, BIK_ParamValue *value);
72
73 // number of solver available
74 // 0 = iksolver
75 // 1 = iTaSC
76 #define BIK_SOLVER_COUNT                2
77
78 /* for use in BIK_get_constraint_param */
79 #define BIK_PARAM_CONSTRAINT_ERROR              0
80
81 /* for use in BIK_get_channel_param */
82 #define BIK_PARAM_CHANNEL_JOINT                 0
83
84 /* for use in BIK_get_solver_param */
85 #define BIK_PARAM_SOLVER_RANK                   0
86 #define BIK_PARAM_SOLVER_ITERATION              1
87
88 #ifdef __cplusplus
89 }
90 #endif
91
92 #endif // BIK_API_H
93