Depsgraph: remove EvaluationContext, pass Depsgraph instead.
[blender.git] / source / blender / blenkernel / BKE_constraint.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): 2007 - Joshua Leung (major recode)
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BKE_CONSTRAINT_H__
29 #define __BKE_CONSTRAINT_H__
30
31 /** \file BKE_constraint.h
32  *  \ingroup bke
33  *  \author Joshua Leung (major recode 2007)
34  */
35
36 struct ID;
37 struct bConstraint;
38 struct bConstraintTarget;
39 struct ListBase;
40 struct Object;
41 struct Scene;
42 struct bPoseChannel;
43 struct Depsgraph;
44
45 /* ---------------------------------------------------------------------------- */
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
50 /* special struct for use in constraint evaluation */
51 typedef struct bConstraintOb {
52         struct Scene *scene;        /* for system time, part of deglobalization, code nicer later with local time (ton) */
53         struct Object *ob;          /* if pchan, then armature that it comes from, otherwise constraint owner */
54         struct bPoseChannel *pchan; /* pose channel that owns the constraints being evaluated */
55         
56         float matrix[4][4];         /* matrix where constraints are accumulated + solved */
57         float startmat[4][4];       /* original matrix (before constraint solving) */
58         
59         short type;                 /* type of owner  */
60         short rotOrder;             /* rotation order for constraint owner (as defined in eEulerRotationOrders in BLI_math.h) */
61 } bConstraintOb;
62
63 /* ---------------------------------------------------------------------------- */
64
65 /* Callback format for performing operations on ID-pointers for Constraints */
66 typedef void (*ConstraintIDFunc)(struct bConstraint *con, struct ID **idpoin, bool is_reference, void *userdata);
67
68 /* ....... */
69
70 /* Constraint Type-Info (shorthand in code = cti):
71  *  This struct provides function pointers for runtime, so that functions can be
72  *  written more generally (with fewer/no special exceptions for various constraints).
73  *
74  *  Callers of these functions must check that they actually point to something useful,
75  *  as some constraints don't define some of these.
76  *
77  *  Warning: it is not too advisable to reorder order of members of this struct,
78  *                      as you'll have to edit quite a few ($NUM_CONSTRAINT_TYPES) of these
79  *                      structs.
80  */
81 typedef struct bConstraintTypeInfo {
82         /* admin/ident */
83         short type;             /* CONSTRAINT_TYPE_### */
84         short size;             /* size in bytes of the struct */
85         char name[32];          /* name of constraint in interface */
86         char structName[32];    /* name of struct for SDNA */
87         
88         /* data management function pointers - special handling */
89         /* free any data that is allocated separately (optional) */
90         void (*free_data)(struct bConstraint *con);
91         /* run the provided callback function on all the ID-blocks linked to the constraint */
92         void (*id_looper)(struct bConstraint *con, ConstraintIDFunc func, void *userdata);
93         /* copy any special data that is allocated separately (optional) */
94         void (*copy_data)(struct bConstraint *con, struct bConstraint *src);
95         /* set settings for data that will be used for bConstraint.data (memory already allocated using MEM_callocN) */
96         void (*new_data)(void *cdata);
97         
98         /* target handling function pointers */
99         /* for multi-target constraints: return that list; otherwise make a temporary list (returns number of targets) */
100         int (*get_constraint_targets)(struct bConstraint *con, struct ListBase *list);
101         /* for single-target constraints only: flush data back to source data, and the free memory used */
102         void (*flush_constraint_targets)(struct bConstraint *con, struct ListBase *list, bool no_copy);
103         
104         /* evaluation */
105         /* set the ct->matrix for the given constraint target (at the given ctime) */
106         void (*get_target_matrix)(struct Depsgraph *depsgraph, struct bConstraint *con, struct bConstraintOb *cob, struct bConstraintTarget *ct, float ctime);
107         /* evaluate the constraint for the given time */
108         void (*evaluate_constraint)(struct bConstraint *con, struct bConstraintOb *cob, struct ListBase *targets);
109 } bConstraintTypeInfo;
110
111 /* Function Prototypes for bConstraintTypeInfo's */
112 const bConstraintTypeInfo *BKE_constraint_typeinfo_get(struct bConstraint *con);
113 const bConstraintTypeInfo *BKE_constraint_typeinfo_from_type(int type);
114
115
116 /* ---------------------------------------------------------------------------- */
117
118 /* Constraint function prototypes */
119 void BKE_constraint_unique_name(struct bConstraint *con, struct ListBase *list);
120
121 void BKE_constraints_free(struct ListBase *list);
122 void BKE_constraints_free_ex(struct ListBase *list, bool do_id_user);
123 void BKE_constraints_copy(struct ListBase *dst, const struct ListBase *src, bool do_extern);
124 void BKE_constraints_copy_ex(struct ListBase *dst, const struct ListBase *src, const int flag, bool do_extern);
125 void BKE_constraints_id_loop(struct ListBase *list, ConstraintIDFunc func, void *userdata);
126 void BKE_constraint_free_data(struct bConstraint *con);
127 void BKE_constraint_free_data_ex(struct bConstraint *con, bool do_id_user);
128
129 /* Constraint API function prototypes */
130 struct bConstraint *BKE_constraints_active_get(struct ListBase *list);
131 void                BKE_constraints_active_set(ListBase *list, struct bConstraint *con);
132 struct bConstraint *BKE_constraints_find_name(struct ListBase *list, const char *name);
133
134 struct bConstraint *BKE_constraint_add_for_object(struct Object *ob, const char *name, short type);
135 struct bConstraint *BKE_constraint_add_for_pose(struct Object *ob, struct bPoseChannel *pchan, const char *name, short type);
136
137 bool                BKE_constraint_remove_ex(ListBase *list, struct Object *ob, struct bConstraint *con, bool clear_dep);
138 bool                BKE_constraint_remove(ListBase *list, struct bConstraint *con);
139
140 /* Constraints + Proxies function prototypes */
141 void BKE_constraints_proxylocal_extract(struct ListBase *dst, struct ListBase *src);
142 bool BKE_constraints_proxylocked_owner(struct Object *ob, struct bPoseChannel *pchan);
143
144 /* Constraint Evaluation function prototypes */
145 struct bConstraintOb *BKE_constraints_make_evalob(struct Scene *scene, struct Object *ob, void *subdata, short datatype);
146 void                  BKE_constraints_clear_evalob(struct bConstraintOb *cob);
147
148 void BKE_constraint_mat_convertspace(
149         struct Object *ob, struct bPoseChannel *pchan, float mat[4][4], short from, short to, const bool keep_scale);
150
151 void BKE_constraint_target_matrix_get(struct Depsgraph *depsgraph, struct Scene *scene, struct bConstraint *con,
152                                       int n, short ownertype, void *ownerdata, float mat[4][4], float ctime);
153 void BKE_constraint_targets_for_solving_get(struct Depsgraph *depsgraph, struct bConstraint *con, struct bConstraintOb *ob, struct ListBase *targets, float ctime);
154 void BKE_constraints_solve(struct Depsgraph *depsgraph, struct ListBase *conlist, struct bConstraintOb *cob, float ctime);
155
156 #ifdef __cplusplus
157 }
158 #endif
159
160 #endif
161