Cleanup: remove moar G.main from BKE area.
[blender.git] / source / blender / blenkernel / BKE_object.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: all of this file.
19  *
20  * Contributor(s): none yet.
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #ifndef __BKE_OBJECT_H__
26 #define __BKE_OBJECT_H__
27
28 /** \file BKE_object.h
29  *  \ingroup bke
30  *  \brief General operations, lookup, etc. for blender objects.
31  */
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 #include "BLI_compiler_attrs.h"
37
38 struct Base;
39 struct EvaluationContext;
40 struct Scene;
41 struct Object;
42 struct BoundBox;
43 struct View3D;
44 struct SoftBody;
45 struct BulletSoftBody;
46 struct MovieClip;
47 struct Main;
48 struct RigidBodyWorld;
49 struct HookModifierData;
50 struct ModifierData;
51
52 void BKE_object_workob_clear(struct Object *workob);
53 void BKE_object_workob_calc_parent(struct Scene *scene, struct Object *ob, struct Object *workob);
54
55 void BKE_object_transform_copy(struct Object *ob_tar, const struct Object *ob_src);
56 struct SoftBody *copy_softbody(const struct SoftBody *sb, const int flag);
57 struct BulletSoftBody *copy_bulletsoftbody(const struct BulletSoftBody *sb, const int flag);
58 struct ParticleSystem *BKE_object_copy_particlesystem(struct ParticleSystem *psys, const int flag);
59 void BKE_object_copy_particlesystems(struct Object *ob_dst, const struct Object *ob_src, const int flag);
60 void BKE_object_copy_softbody(struct Object *ob_dst, const struct Object *ob_src);
61 void BKE_object_free_particlesystems(struct Object *ob);
62 void BKE_object_free_softbody(struct Object *ob);
63 void BKE_object_free_bulletsoftbody(struct Object *ob);
64 void BKE_object_free_curve_cache(struct Object *ob);
65 void BKE_object_update_base_layer(struct Scene *scene, struct Object *ob);
66
67 void BKE_object_free(struct Object *ob);
68 void BKE_object_free_derived_caches(struct Object *ob);
69 void BKE_object_free_caches(struct Object *object);
70
71 void BKE_object_modifier_hook_reset(struct Object *ob, struct HookModifierData *hmd);
72
73 bool BKE_object_support_modifier_type_check(const struct Object *ob, int modifier_type);
74
75 void BKE_object_link_modifiers(struct Object *ob_dst, const struct Object *ob_src);
76 void BKE_object_free_modifiers(struct Object *ob, const int flag);
77
78 void BKE_object_make_proxy(struct Object *ob, struct Object *target, struct Object *gob);
79 void BKE_object_copy_proxy_drivers(struct Object *ob, struct Object *target);
80
81 bool BKE_object_exists_check(struct Main *bmain, const struct Object *obtest);
82 bool BKE_object_is_in_editmode(const struct Object *ob);
83 bool BKE_object_is_in_editmode_vgroup(const struct Object *ob);
84 bool BKE_object_is_in_wpaint_select_vert(const struct Object *ob);
85
86 void BKE_object_init(struct Object *ob);
87 struct Object *BKE_object_add_only_object(
88         struct Main *bmain,
89         int type, const char *name)
90         ATTR_NONNULL(1) ATTR_RETURNS_NONNULL;
91 struct Object *BKE_object_add(
92         struct Main *bmain, struct Scene *scene,
93         int type, const char *name)
94         ATTR_NONNULL(1, 2) ATTR_RETURNS_NONNULL;
95 void *BKE_object_obdata_add_from_type(
96         struct Main *bmain,
97         int type, const char *name)
98         ATTR_NONNULL(1);
99
100 void BKE_object_lod_add(struct Object *ob);
101 void BKE_object_lod_sort(struct Object *ob);
102 bool BKE_object_lod_remove(struct Object *ob, int level);
103 void BKE_object_lod_update(struct Object *ob, const float camera_position[3]);
104 bool BKE_object_lod_is_usable(struct Object *ob, struct Scene *scene);
105 struct Object *BKE_object_lod_meshob_get(struct Object *ob, struct Scene *scene);
106 struct Object *BKE_object_lod_matob_get(struct Object *ob, struct Scene *scene);
107
108 void BKE_object_copy_data(struct Main *bmain, struct Object *ob_dst, const struct Object *ob_src, const int flag);
109 struct Object *BKE_object_copy(struct Main *bmain, const struct Object *ob);
110 void BKE_object_make_local(struct Main *bmain, struct Object *ob, const bool lib_local);
111 void BKE_object_make_local_ex(struct Main *bmain, struct Object *ob, const bool lib_local, const bool clear_proxy);
112 bool BKE_object_is_libdata(const struct Object *ob);
113 bool BKE_object_obdata_is_libdata(const struct Object *ob);
114
115 void BKE_object_obdata_size_init(struct Object *ob, const float scale);
116
117 void BKE_object_scale_to_mat3(struct Object *ob, float mat[3][3]);
118 void BKE_object_rot_to_mat3(struct Object *ob, float mat[3][3], bool use_drot);
119 void BKE_object_mat3_to_rot(struct Object *ob, float mat[3][3], bool use_compat);
120 void BKE_object_to_mat3(struct Object *ob, float mat[3][3]);
121 void BKE_object_to_mat4(struct Object *ob, float mat[4][4]);
122 void BKE_object_apply_mat4(struct Object *ob, float mat[4][4], const bool use_compat, const bool use_parent);
123 void BKE_object_matrix_local_get(struct Object *ob, float mat[4][4]);
124
125 bool BKE_object_pose_context_check(const struct Object *ob);
126 struct Object *BKE_object_pose_armature_get(struct Object *ob);
127
128 void BKE_object_get_parent_matrix(struct Scene *scene, struct Object *ob, struct Object *par, float parentmat[4][4]);
129 void BKE_object_where_is_calc(struct Scene *scene, struct Object *ob);
130 void BKE_object_where_is_calc_ex(
131         struct Scene *scene, struct RigidBodyWorld *rbw, struct Object *ob, float r_originmat[3][3]);
132 void BKE_object_where_is_calc_time(struct Scene *scene, struct Object *ob, float ctime);
133 void BKE_object_where_is_calc_time_ex(
134         struct Scene *scene, struct Object *ob, float ctime,
135         struct RigidBodyWorld *rbw, float r_originmat[3][3]);
136 void BKE_object_where_is_calc_mat4(struct Scene *scene, struct Object *ob, float obmat[4][4]);
137
138 /* possibly belong in own moduke? */
139 struct BoundBox *BKE_boundbox_alloc_unit(void);
140 void BKE_boundbox_init_from_minmax(struct BoundBox *bb, const float min[3], const float max[3]);
141 void BKE_boundbox_calc_center_aabb(const struct BoundBox *bb, float r_cent[3]);
142 void BKE_boundbox_calc_size_aabb(const struct BoundBox *bb, float r_size[3]);
143 void BKE_boundbox_minmax(const struct BoundBox *bb, float obmat[4][4], float r_min[3], float r_max[3]);
144
145 struct BoundBox *BKE_object_boundbox_get(struct Object *ob);
146 void BKE_object_dimensions_get(struct Object *ob, float vec[3]);
147 void BKE_object_dimensions_set(struct Object *ob, const float value[3]);
148 void BKE_object_empty_draw_type_set(struct Object *ob, const int value);
149 void BKE_object_boundbox_flag(struct Object *ob, int flag, const bool set);
150 void BKE_object_minmax(struct Object *ob, float r_min[3], float r_max[3], const bool use_hidden);
151 bool BKE_object_minmax_dupli(
152         struct Main *bmain, struct Scene *scene,
153         struct Object *ob, float r_min[3], float r_max[3], const bool use_hidden);
154
155 /* sometimes min-max isn't enough, we need to loop over each point */
156 void BKE_object_foreach_display_point(
157         struct Object *ob, float obmat[4][4],
158         void (*func_cb)(const float[3], void *), void *user_data);
159 void BKE_scene_foreach_display_point(
160         struct Main *bmain,
161         struct Scene *scene,
162         struct View3D *v3d,
163         const short flag,
164         void (*func_cb)(const float[3], void *), void *user_data);
165
166 bool BKE_object_parent_loop_check(const struct Object *parent, const struct Object *ob);
167
168 void *BKE_object_tfm_backup(struct Object *ob);
169 void  BKE_object_tfm_restore(struct Object *ob, void *obtfm_pt);
170
171 typedef struct ObjectTfmProtectedChannels {
172         float loc[3],     dloc[3];
173         float size[3],    dscale[3];
174         float rot[3],     drot[3];
175         float quat[4],    dquat[4];
176         float rotAxis[3], drotAxis[3];
177         float rotAngle,   drotAngle;
178 } ObjectTfmProtectedChannels;
179
180 void BKE_object_tfm_protected_backup(
181         const struct Object *ob,
182         ObjectTfmProtectedChannels *obtfm);
183
184 void BKE_object_tfm_protected_restore(
185         struct Object *ob,
186         const ObjectTfmProtectedChannels *obtfm,
187         const short protectflag);
188
189 /* Dependency graph evaluation callbacks. */
190 void BKE_object_eval_local_transform(
191         struct EvaluationContext *eval_ctx,
192         struct Object *ob);
193 void BKE_object_eval_parent(
194         struct EvaluationContext *eval_ctx,
195         struct Scene *scene,
196         struct Object *ob);
197 void BKE_object_eval_constraints(
198         struct EvaluationContext *eval_ctx,
199         struct Scene *scene,
200         struct Object *ob);
201 void BKE_object_eval_done(struct EvaluationContext *eval_ctx, struct Object *ob);
202
203 bool BKE_object_eval_proxy_copy(
204         struct EvaluationContext *eval_ctx,
205         struct Object *object);
206 void BKE_object_eval_uber_transform(
207         struct EvaluationContext *eval_ctx,
208         struct Object *ob);
209 void BKE_object_eval_uber_data(
210         struct Main *bmain,
211         struct EvaluationContext *eval_ctx,
212         struct Scene *scene,
213         struct Object *ob);
214
215 void BKE_object_eval_cloth(
216         struct EvaluationContext *eval_ctx,
217         struct Scene *scene,
218         struct Object *object);
219
220
221 void BKE_object_eval_transform_all(
222         struct EvaluationContext *eval_ctx,
223         struct Scene *scene,
224         struct Object *object);
225
226 void BKE_object_handle_data_update(
227         struct Main *bmain,
228         struct EvaluationContext *eval_ctx,
229         struct Scene *scene,
230         struct Object *ob);
231 void BKE_object_handle_update(
232         struct Main *bmain,
233         struct EvaluationContext *eval_ctx,
234         struct Scene *scene,
235         struct Object *ob);
236 void BKE_object_handle_update_ex(
237         struct Main *bmain,
238         struct EvaluationContext *eval_ctx,
239         struct Scene *scene, struct Object *ob,
240         struct RigidBodyWorld *rbw,
241         const bool do_proxy_update);
242 void BKE_object_sculpt_modifiers_changed(struct Object *ob);
243
244 int BKE_object_obdata_texspace_get(struct Object *ob, short **r_texflag, float **r_loc, float **r_size, float **r_rot);
245
246 int BKE_object_insert_ptcache(struct Object *ob);
247 void BKE_object_delete_ptcache(struct Object *ob, int index);
248 struct KeyBlock *BKE_object_shapekey_insert(struct Main *bmain, struct Object *ob, const char *name, const bool from_mix);
249 bool BKE_object_shapekey_remove(struct Main *bmain, struct Object *ob, struct KeyBlock *kb);
250 bool BKE_object_shapekey_free(struct Main *bmain, struct Object *ob);
251
252 bool BKE_object_flag_test_recursive(const struct Object *ob, short flag);
253
254 bool BKE_object_is_child_recursive(const struct Object *ob_parent, const struct Object *ob_child);
255 bool BKE_object_is_animated(struct Scene *scene, struct Object *ob);
256
257 /* return ModifierMode flag */
258 int BKE_object_is_modified(struct Scene *scene, struct Object *ob);
259 int BKE_object_is_deform_modified(struct Scene *scene, struct Object *ob);
260
261 void BKE_object_relink(struct Object *ob);
262 void BKE_object_data_relink(struct Object *ob);
263
264 struct MovieClip *BKE_object_movieclip_get(struct Scene *scene, struct Object *ob, bool use_default);
265
266 /* this function returns a superset of the scenes selection based on relationships */
267
268 typedef enum eObRelationTypes {
269         OB_REL_NONE               = 0,        /* just the selection as is */
270         OB_REL_PARENT             = (1 << 0), /* immediate parent */
271         OB_REL_PARENT_RECURSIVE   = (1 << 1), /* parents up to root of selection tree*/
272         OB_REL_CHILDREN           = (1 << 2), /* immediate children */
273         OB_REL_CHILDREN_RECURSIVE = (1 << 3), /* All children */
274         OB_REL_MOD_ARMATURE       = (1 << 4), /* Armatures related to the selected objects */
275         OB_REL_SCENE_CAMERA       = (1 << 5), /* you might want the scene camera too even if unselected? */
276 } eObRelationTypes;
277
278 typedef enum eObjectSet {
279         OB_SET_SELECTED, /* Selected Objects */
280         OB_SET_VISIBLE,  /* Visible Objects  */
281         OB_SET_ALL       /* All Objects      */
282 } eObjectSet;
283
284 struct LinkNode *BKE_object_relational_superset(
285         struct Scene *scene, eObjectSet objectSet, eObRelationTypes includeFilter);
286 struct LinkNode *BKE_object_groups(struct Object *ob);
287 void             BKE_object_groups_clear(struct Scene *scene, struct Base *base, struct Object *object);
288
289 struct KDTree *BKE_object_as_kdtree(struct Object *ob, int *r_tot);
290
291 bool BKE_object_modifier_use_time(struct Object *ob, struct ModifierData *md);
292
293 bool BKE_object_modifier_update_subframe(
294         struct Main *bmain, struct EvaluationContext *eval_ctx,
295         struct Scene *scene, struct Object *ob, bool update_mesh,
296         int parent_recursion, float frame,
297         int type);
298
299 #ifdef __cplusplus
300 }
301 #endif
302
303 #endif