doxygen: blender/ikplugin tagged.
[blender.git] / source / blender / ikplugin / intern / ikplugin_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/intern/ikplugin_api.h
31  *  \ingroup ikplugin
32  */
33
34
35 #ifndef IKPLUGIN_API_H
36 #define IKPLUGIN_API_H
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 struct Object;
43 struct bPoseChannel;
44 struct bArmature;
45 struct Scene;
46
47
48 struct IKPlugin {
49         void (*initialize_tree_func)(struct Scene *scene, struct Object *ob, float ctime);
50         void (*execute_tree_func)(struct Scene *scene, struct Object *ob, struct bPoseChannel *pchan, float ctime);
51         void (*release_tree_func)(struct Scene *scene, struct Object *ob, float ctime);
52         void (*remove_armature_func)(struct bPose *pose);
53         void (*clear_cache)(struct bPose *pose);
54         void (*update_param)(struct bPose *pose);
55         void (*test_constraint)(struct Object *ob, struct bConstraint *cons);
56 };
57
58 typedef struct IKPlugin IKPlugin;
59
60 #ifdef __cplusplus
61 }
62 #endif
63
64 #endif // IKPLUGIN_API_H
65