Merge branch 'blender2.7'
[blender.git] / source / blender / ikplugin / BIK_api.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  * Original author: Benoit Bolsee
19  */
20
21 /** \file \ingroup ikplugin
22  */
23
24
25 #ifndef __BIK_API_H__
26 #define __BIK_API_H__
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 struct Depsgraph;
33 struct Object;
34 struct Scene;
35 struct bConstraint;
36 struct bPose;
37 struct bPoseChannel;
38
39 enum BIK_ParamType {
40         BIK_PARAM_TYPE_FLOAT = 0,
41         BIK_PARAM_TYPE_INT,
42         BIK_PARAM_TYPE_STRING,
43 };
44
45 struct BIK_ParamValue {
46         short type;                     /* BIK_PARAM_TYPE_.. */
47         short length;           /* for string, does not include terminating 0 */
48         union {
49                 float f[8];
50                 int   i[8];
51                 char  s[32];
52         } value;
53 };
54 typedef struct BIK_ParamValue BIK_ParamValue;
55
56 void BIK_initialize_tree(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob, float ctime);
57 void BIK_execute_tree(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob, struct bPoseChannel *pchan, float ctime);
58 void BIK_release_tree(struct Scene *scene, struct Object *ob, float ctime);
59 void BIK_clear_data(struct bPose *pose);
60 void BIK_clear_cache(struct bPose *pose);
61 void BIK_update_param(struct bPose *pose);
62 void BIK_test_constraint(struct Object *ob, struct bConstraint *cons);
63 // not yet implemented
64 // int BIK_get_constraint_param(struct bPose *pose, struct bConstraint *cons, int id, BIK_ParamValue *value);
65 // int BIK_get_channel_param(struct bPose *pose, struct bPoseChannel *pchan, int id, BIK_ParamValue *value);
66 // int BIK_get_solver_param(struct bPose *pose, struct bPoseChannel *pchan, int id, BIK_ParamValue *value);
67
68 // number of solver available
69 // 0 = iksolver
70 // 1 = iTaSC
71
72 /* for use in BIK_get_constraint_param */
73 #define BIK_PARAM_CONSTRAINT_ERROR              0
74
75 /* for use in BIK_get_channel_param */
76 #define BIK_PARAM_CHANNEL_JOINT                 0
77
78 /* for use in BIK_get_solver_param */
79 #define BIK_PARAM_SOLVER_RANK                   0
80 #define BIK_PARAM_SOLVER_ITERATION              1
81
82 #ifdef __cplusplus
83 }
84 #endif
85
86 #endif  /* __BIK_API_H__ */