== Constraints System ==
[blender.git] / source / blender / blenkernel / BKE_constraint.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  */
32
33 #ifndef BKE_CONSTRAINT_H
34 #define BKE_CONSTRAINT_H
35
36
37 struct bConstraint;
38 struct ListBase;
39 struct Object;
40 struct bConstraintChannel;
41 struct bPoseChannel;
42 struct bAction;
43 struct bArmature;
44
45 /* ---------------------------------------------------------------------------- */
46
47 /* Constraint target/owner types */
48 #define TARGET_OBJECT                   1       /*      string is ""                            */
49 #define TARGET_BONE                             2       /*      string is bone-name             */
50 #define TARGET_VERT                             3       /*      string is vertex-group name     */
51 #define TARGET_CV                               4       /*      string is vertex-group name - is not available until curves get vgroups */
52
53 /* ---------------------------------------------------------------------------- */
54
55 /* special struct for use in constraint evaluation */
56 typedef struct bConstraintOb {
57         struct Object *ob;                      /* if pchan, then armature that it comes from, otherwise constraint owner */
58         struct bPoseChannel *pchan;     /* pose channel that owns the constraints being evaluated */
59         
60         float matrix[4][4];                     /* matrix where constraints are accumulated + solved */
61         float startmat[4][4];           /* original matrix (before constraint solving) */
62         
63         short type;                                     /* type of owner  */
64 } bConstraintOb;
65
66 /* ---------------------------------------------------------------------------- */
67
68 /* Constraint function prototypes */
69 void unique_constraint_name (struct bConstraint *con, struct ListBase *list);
70 void *new_constraint_data (short type);
71 void free_constraints (struct ListBase *conlist);
72 void copy_constraints (struct ListBase *dst, struct ListBase *src);
73 void relink_constraints (struct ListBase *list);
74 void free_constraint_data (struct bConstraint *con);
75
76 /* Constraint Channel function prototypes */
77 struct bConstraintChannel *get_constraint_channel (ListBase *list, const char *name);
78 struct bConstraintChannel *verify_constraint_channel (ListBase *list, const char *name);
79 void do_constraint_channels (struct ListBase *conbase, struct ListBase *chanbase, float ctime);
80 void copy_constraint_channels (ListBase *dst, ListBase *src);
81 void clone_constraint_channels (struct ListBase *dst, struct ListBase *src);
82 void free_constraint_channels (ListBase *chanbase);
83
84 /* Target function prototypes  */
85 char constraint_has_target (struct bConstraint *con);
86 struct Object *get_constraint_target(struct bConstraint *con, char **subtarget);
87 void set_constraint_target(struct bConstraint *con, struct Object *ob, char *subtarget);
88
89 /* Constraint Evaluation function prototypes */
90 struct bConstraintOb *constraints_make_evalob (struct Object *ob, void *subdata, short datatype);
91 void constraints_clear_evalob(struct bConstraintOb *cob);
92
93 short get_constraint_target_matrix (struct bConstraint *con, short ownertype, void *ownerdata, float mat[][4], float time);
94 void solve_constraints (struct ListBase *conlist, struct bConstraintOb *cob, float ctime);
95
96
97 #endif
98