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