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