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