Pose brush: Smooth Iterations Brush Property
[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 #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,
57                          struct Scene *scene,
58                          struct Object *ob,
59                          float ctime);
60 void BIK_execute_tree(struct Depsgraph *depsgraph,
61                       struct Scene *scene,
62                       struct Object *ob,
63                       struct bPoseChannel *pchan,
64                       float ctime);
65 void BIK_release_tree(struct Scene *scene, struct Object *ob, float ctime);
66 void BIK_clear_data(struct bPose *pose);
67 void BIK_clear_cache(struct bPose *pose);
68 void BIK_update_param(struct bPose *pose);
69 void BIK_test_constraint(struct Object *ob, struct bConstraint *cons);
70 // not yet implemented
71 // int BIK_get_constraint_param(struct bPose *pose,
72 //                              struct bConstraint *cons,
73 //                              int id,
74 //                              BIK_ParamValue *value);
75 // int BIK_get_channel_param(struct bPose *pose,
76 //                           struct bPoseChannel *pchan,
77 //                           int id,
78 //                           BIK_ParamValue *value);
79 // int BIK_get_solver_param(struct bPose *pose,
80 //                          struct bPoseChannel *pchan,
81 //                          int id,
82 //                          BIK_ParamValue *value);
83
84 // number of solver available
85 // 0 = iksolver
86 // 1 = iTaSC
87
88 /* for use in BIK_get_constraint_param */
89 #define BIK_PARAM_CONSTRAINT_ERROR 0
90
91 /* for use in BIK_get_channel_param */
92 #define BIK_PARAM_CHANNEL_JOINT 0
93
94 /* for use in BIK_get_solver_param */
95 #define BIK_PARAM_SOLVER_RANK 0
96 #define BIK_PARAM_SOLVER_ITERATION 1
97
98 #ifdef __cplusplus
99 }
100 #endif
101
102 #endif /* __BIK_API_H__ */