Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / source / blender / blenkernel / BKE_constraint.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL 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.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): 2007 - Joshua Leung (major recode)
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef BKE_CONSTRAINT_H
31 #define BKE_CONSTRAINT_H
32
33 struct bConstraint;
34 struct bConstraintTarget;
35 struct ListBase;
36 struct Object;
37 struct Scene;
38 struct bPoseChannel;
39
40 /* ---------------------------------------------------------------------------- */
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 /* special struct for use in constraint evaluation */
46 typedef struct bConstraintOb {
47         struct Scene *scene;            /* for system time, part of deglobalization, code nicer later with local time (ton) */
48         struct Object *ob;                      /* if pchan, then armature that it comes from, otherwise constraint owner */
49         struct bPoseChannel *pchan;     /* pose channel that owns the constraints being evaluated */
50         
51         float matrix[4][4];                     /* matrix where constraints are accumulated + solved */
52         float startmat[4][4];           /* original matrix (before constraint solving) */
53         
54         short type;                                     /* type of owner  */
55         short rotOrder;                         /* rotation order for constraint owner (as defined in eEulerRotationOrders in BLI_arithb.h) */
56 } bConstraintOb;
57
58 /* ---------------------------------------------------------------------------- */
59
60 /* Constraint Type-Info (shorthand in code = cti):
61  *  This struct provides function pointers for runtime, so that functions can be
62  *  written more generally (with fewer/no special exceptions for various constraints).
63  *
64  *  Callers of these functions must check that they actually point to something useful,
65  *  as some constraints don't define some of these.
66  *
67  *  Warning: it is not too advisable to reorder order of members of this struct,
68  *                      as you'll have to edit quite a few ($NUM_CONSTRAINT_TYPES) of these
69  *                      structs.
70  */
71 typedef struct bConstraintTypeInfo {
72         /* admin/ident */
73         short type;                             /* CONSTRAINT_TYPE_### */
74         short size;                             /* size in bytes of the struct */
75         char name[32];                  /* name of constraint in interface */
76         char structName[32];    /* name of struct for SDNA */
77         
78         /* data management function pointers - special handling */
79                 /* free any data that is allocated separately (optional) */
80         void (*free_data)(struct bConstraint *con);
81                 /* adjust pointer to other ID-data using ID_NEW(), but not to targets (optional) */
82         void (*relink_data)(struct bConstraint *con);
83                 /* copy any special data that is allocated separately (optional) */
84         void (*copy_data)(struct bConstraint *con, struct bConstraint *src);
85                 /* set settings for data that will be used for bConstraint.data (memory already allocated using MEM_callocN) */
86         void (*new_data)(void *cdata);
87         
88         /* target handling function pointers */
89                 /* for multi-target constraints: return that list; otherwise make a temporary list (returns number of targets) */
90         int (*get_constraint_targets)(struct bConstraint *con, struct ListBase *list);
91                 /* for single-target constraints only: flush data back to source data, and the free memory used */
92         void (*flush_constraint_targets)(struct bConstraint *con, struct ListBase *list, short nocopy);
93         
94         /* evaluation */
95                 /* set the ct->matrix for the given constraint target (at the given ctime) */
96         void (*get_target_matrix)(struct bConstraint *con, struct bConstraintOb *cob, struct bConstraintTarget *ct, float ctime);
97                 /* evaluate the constraint for the given time */
98         void (*evaluate_constraint)(struct bConstraint *con, struct bConstraintOb *cob, struct ListBase *targets);
99 } bConstraintTypeInfo;
100
101 /* Function Prototypes for bConstraintTypeInfo's */
102 bConstraintTypeInfo *constraint_get_typeinfo(struct bConstraint *con);
103 bConstraintTypeInfo *get_constraint_typeinfo(int type);
104
105 /* ---------------------------------------------------------------------------- */
106 /* Useful macros for testing various common flag combinations */
107
108 /* Constraint Target Macros */
109 #define VALID_CONS_TARGET(ct) ((ct) && (ct->tar))
110
111
112 /* ---------------------------------------------------------------------------- */
113
114 /* Constraint function prototypes */
115 void unique_constraint_name(struct bConstraint *con, struct ListBase *list);
116
117 void free_constraints(struct ListBase *list);
118 void copy_constraints(struct ListBase *dst, struct ListBase *src);
119 void relink_constraints(struct ListBase *list);
120 void free_constraint_data(struct bConstraint *con);
121
122 struct bConstraint *constraints_get_active(struct ListBase *list);
123
124 /* Constraints + Proxies function prototypes */
125 void extract_proxylocal_constraints(struct ListBase *dst, struct ListBase *src);
126 short proxylocked_constraints_owner(struct Object *ob, struct bPoseChannel *pchan);
127
128 /* Constraint Evaluation function prototypes */
129 struct bConstraintOb *constraints_make_evalob(struct Scene *scene, struct Object *ob, void *subdata, short datatype);
130 void constraints_clear_evalob(struct bConstraintOb *cob);
131
132 void constraint_mat_convertspace(struct Object *ob, struct bPoseChannel *pchan, float mat[][4], short from, short to);
133
134 void get_constraint_target_matrix(struct bConstraint *con, int n, short ownertype, void *ownerdata, float mat[][4], float ctime);
135 void solve_constraints(struct ListBase *conlist, struct bConstraintOb *cob, float ctime);
136
137 #ifdef __cplusplus
138 }
139 #endif
140
141 #endif
142