clear some c++ warnings.
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 /** \file blender/ikplugin/BIK_api.h
31  *  \ingroup ikplugin
32  */
33
34
35 #ifndef BIK_API_H
36 #define BIK_API_H
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 struct Object;
43 struct bPoseChannel;
44 struct bPose;
45 struct bArmature;
46 struct Scene;
47 struct bConstraint;
48
49 enum BIK_ParamType {
50         BIK_PARAM_TYPE_FLOAT = 0,
51         BIK_PARAM_TYPE_INT,
52         BIK_PARAM_TYPE_STRING,
53 };
54
55 struct BIK_ParamValue {
56         short type;                     /* BIK_PARAM_TYPE_.. */
57         short length;           /* for string, does not include terminating 0 */
58         union {
59                 float f[8];
60                 int   i[8];
61                 char  s[32];
62         } value;                
63 };
64 typedef struct BIK_ParamValue BIK_ParamValue;
65
66 void BIK_initialize_tree(struct Scene *scene, struct Object *ob, float ctime);
67 void BIK_execute_tree(struct Scene *scene, struct Object *ob, struct bPoseChannel *pchan, float ctime);
68 void BIK_release_tree(struct Scene *scene, struct Object *ob, float ctime);
69 void BIK_clear_data(struct bPose *pose);
70 void BIK_clear_cache(struct bPose *pose);
71 void BIK_update_param(struct bPose *pose);
72 void BIK_test_constraint(struct Object *ob, struct bConstraint *cons);
73 // not yet implemented
74 int BIK_get_constraint_param(struct bPose *pose, struct bConstraint *cons, int id, BIK_ParamValue *value);
75 int BIK_get_channel_param(struct bPose *pose, struct bPoseChannel *pchan, int id, BIK_ParamValue *value);
76 int BIK_get_solver_param(struct bPose *pose, struct bPoseChannel *pchan, int id, BIK_ParamValue *value);
77
78 // number of solver available
79 // 0 = iksolver
80 // 1 = iTaSC
81
82 /* for use in BIK_get_constraint_param */
83 #define BIK_PARAM_CONSTRAINT_ERROR              0
84
85 /* for use in BIK_get_channel_param */
86 #define BIK_PARAM_CHANNEL_JOINT                 0
87
88 /* for use in BIK_get_solver_param */
89 #define BIK_PARAM_SOLVER_RANK                   0
90 #define BIK_PARAM_SOLVER_ITERATION              1
91
92 #ifdef __cplusplus
93 }
94 #endif
95
96 #endif // BIK_API_H
97