Fluid: Added obstacle fluid distance parameter
[blender.git] / source / blender / blenkernel / BKE_object.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #pragma once
18
19 /** \file
20  * \ingroup bke
21  * \brief General operations, lookup, etc. for blender objects.
22  */
23
24 #include "BLI_compiler_attrs.h"
25 #include "BLI_sys_types.h"
26
27 #include "DNA_object_enums.h"
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 struct Base;
34 struct BoundBox;
35 struct Depsgraph;
36 struct GpencilModifierData;
37 struct HookGpencilModifierData;
38 struct HookModifierData;
39 struct ID;
40 struct Main;
41 struct Mesh;
42 struct ModifierData;
43 struct MovieClip;
44 struct Object;
45 struct RegionView3D;
46 struct RigidBodyWorld;
47 struct Scene;
48 struct ShaderFxData;
49 struct View3D;
50 struct ViewLayer;
51
52 void BKE_object_workob_clear(struct Object *workob);
53 void BKE_object_workob_calc_parent(struct Depsgraph *depsgraph,
54                                    struct Scene *scene,
55                                    struct Object *ob,
56                                    struct Object *workob);
57
58 void BKE_object_transform_copy(struct Object *ob_tar, const struct Object *ob_src);
59 void BKE_object_copy_softbody(struct Object *ob_dst, const struct Object *ob_src, const int flag);
60 struct ParticleSystem *BKE_object_copy_particlesystem(struct ParticleSystem *psys, const int flag);
61 void BKE_object_copy_particlesystems(struct Object *ob_dst,
62                                      const struct Object *ob_src,
63                                      const int flag);
64 void BKE_object_free_particlesystems(struct Object *ob);
65 void BKE_object_free_softbody(struct Object *ob);
66 void BKE_object_free_curve_cache(struct Object *ob);
67
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 void BKE_object_modifier_gpencil_hook_reset(struct Object *ob,
73                                             struct HookGpencilModifierData *hmd);
74 bool BKE_object_modifier_gpencil_use_time(struct Object *ob, struct GpencilModifierData *md);
75
76 bool BKE_object_shaderfx_use_time(struct Object *ob, struct ShaderFxData *md);
77
78 bool BKE_object_support_modifier_type_check(const struct Object *ob, int modifier_type);
79
80 bool BKE_object_copy_modifier(struct Object *ob_dst,
81                               const struct Object *ob_src,
82                               struct ModifierData *md);
83 bool BKE_object_copy_gpencil_modifier(struct Object *ob_dst, struct GpencilModifierData *md);
84 void BKE_object_link_modifiers(struct Object *ob_dst, const struct Object *ob_src);
85 void BKE_object_free_modifiers(struct Object *ob, const int flag);
86 void BKE_object_free_shaderfx(struct Object *ob, const int flag);
87
88 void BKE_object_make_proxy(struct Main *bmain,
89                            struct Object *ob,
90                            struct Object *target,
91                            struct Object *cob);
92 void BKE_object_copy_proxy_drivers(struct Object *ob, struct Object *target);
93
94 bool BKE_object_exists_check(struct Main *bmain, const struct Object *obtest);
95 bool BKE_object_is_in_editmode(const struct Object *ob);
96 bool BKE_object_is_in_editmode_vgroup(const struct Object *ob);
97 bool BKE_object_is_in_wpaint_select_vert(const struct Object *ob);
98 bool BKE_object_has_mode_data(const struct Object *ob, eObjectMode object_mode);
99 bool BKE_object_is_mode_compat(const struct Object *ob, eObjectMode object_mode);
100
101 bool BKE_object_data_is_in_editmode(const struct ID *id);
102
103 char *BKE_object_data_editmode_flush_ptr_get(struct ID *id);
104
105 void BKE_object_update_select_id(struct Main *bmain);
106
107 typedef enum eObjectVisibilityResult {
108   OB_VISIBLE_SELF = 1,
109   OB_VISIBLE_PARTICLES = 2,
110   OB_VISIBLE_INSTANCES = 4,
111   OB_VISIBLE_ALL = (OB_VISIBLE_SELF | OB_VISIBLE_PARTICLES | OB_VISIBLE_INSTANCES),
112 } eObjectVisibilityResult;
113
114 int BKE_object_visibility(const struct Object *ob, const int dag_eval_mode);
115
116 struct Object *BKE_object_add_only_object(struct Main *bmain, int type, const char *name)
117     ATTR_NONNULL(1) ATTR_RETURNS_NONNULL;
118 struct Object *BKE_object_add(struct Main *bmain,
119                               struct ViewLayer *view_layer,
120                               int type,
121                               const char *name) ATTR_NONNULL(1, 2) ATTR_RETURNS_NONNULL;
122 struct Object *BKE_object_add_from(struct Main *bmain,
123                                    struct Scene *scene,
124                                    struct ViewLayer *view_layer,
125                                    int type,
126                                    const char *name,
127                                    struct Object *ob_src)
128     ATTR_NONNULL(1, 2, 3, 6) ATTR_RETURNS_NONNULL;
129 struct Object *BKE_object_add_for_data(struct Main *bmain,
130                                        struct ViewLayer *view_layer,
131                                        int type,
132                                        const char *name,
133                                        struct ID *data,
134                                        bool do_id_user) ATTR_RETURNS_NONNULL;
135 void *BKE_object_obdata_add_from_type(struct Main *bmain, int type, const char *name)
136     ATTR_NONNULL(1);
137 int BKE_object_obdata_to_type(const struct ID *id) ATTR_NONNULL(1);
138
139 bool BKE_object_is_libdata(const struct Object *ob);
140 bool BKE_object_obdata_is_libdata(const struct Object *ob);
141
142 struct Object *BKE_object_duplicate(struct Main *bmain,
143                                     struct Object *ob,
144                                     uint dupflag,
145                                     const uint duplicate_options);
146
147 void BKE_object_obdata_size_init(struct Object *ob, const float size);
148
149 void BKE_object_scale_to_mat3(struct Object *ob, float r_mat[3][3]);
150 void BKE_object_rot_to_mat3(const struct Object *ob, float r_mat[3][3], bool use_drot);
151 void BKE_object_mat3_to_rot(struct Object *ob, float r_mat[3][3], bool use_compat);
152 void BKE_object_to_mat3(struct Object *ob, float r_mat[3][3]);
153 void BKE_object_to_mat4(struct Object *ob, float r_mat[4][4]);
154 void BKE_object_apply_mat4(struct Object *ob,
155                            const float mat[4][4],
156                            const bool use_compat,
157                            const bool use_parent);
158 void BKE_object_apply_mat4_ex(struct Object *ob,
159                               const float mat[4][4],
160                               struct Object *parent,
161                               const float parentinv[4][4],
162                               const bool use_compat);
163 void BKE_object_matrix_local_get(struct Object *ob, float r_mat[4][4]);
164
165 bool BKE_object_pose_context_check(const struct Object *ob);
166 struct Object *BKE_object_pose_armature_get(struct Object *ob);
167 struct Object *BKE_object_pose_armature_get_visible(struct Object *ob,
168                                                     struct ViewLayer *view_layer,
169                                                     struct View3D *v3d);
170
171 struct Object **BKE_object_pose_array_get_ex(struct ViewLayer *view_layer,
172                                              struct View3D *v3d,
173                                              unsigned int *r_objects_len,
174                                              bool unique);
175 struct Object **BKE_object_pose_array_get_unique(struct ViewLayer *view_layer,
176                                                  struct View3D *v3d,
177                                                  unsigned int *r_objects_len);
178 struct Object **BKE_object_pose_array_get(struct ViewLayer *view_layer,
179                                           struct View3D *v3d,
180                                           unsigned int *r_objects_len);
181
182 struct Base **BKE_object_pose_base_array_get_ex(struct ViewLayer *view_layer,
183                                                 struct View3D *v3d,
184                                                 unsigned int *r_bases_len,
185                                                 bool unique);
186 struct Base **BKE_object_pose_base_array_get_unique(struct ViewLayer *view_layer,
187                                                     struct View3D *v3d,
188                                                     unsigned int *r_bases_len);
189 struct Base **BKE_object_pose_base_array_get(struct ViewLayer *view_layer,
190                                              struct View3D *v3d,
191                                              unsigned int *r_bases_len);
192
193 void BKE_object_get_parent_matrix(struct Object *ob, struct Object *par, float r_parentmat[4][4]);
194 void BKE_object_where_is_calc(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob);
195 void BKE_object_where_is_calc_ex(struct Depsgraph *depsgraph,
196                                  struct Scene *scene,
197                                  struct RigidBodyWorld *rbw,
198                                  struct Object *ob,
199                                  float r_originmat[3][3]);
200 void BKE_object_where_is_calc_time(struct Depsgraph *depsgraph,
201                                    struct Scene *scene,
202                                    struct Object *ob,
203                                    float ctime);
204 void BKE_object_where_is_calc_mat4(struct Object *ob, float r_obmat[4][4]);
205
206 /* Possibly belong in own module? */
207 struct BoundBox *BKE_boundbox_alloc_unit(void);
208 void BKE_boundbox_init_from_minmax(struct BoundBox *bb, const float min[3], const float max[3]);
209 void BKE_boundbox_calc_center_aabb(const struct BoundBox *bb, float r_cent[3]);
210 void BKE_boundbox_calc_size_aabb(const struct BoundBox *bb, float r_size[3]);
211 void BKE_boundbox_minmax(const struct BoundBox *bb,
212                          const float obmat[4][4],
213                          float r_min[3],
214                          float r_max[3]);
215
216 struct BoundBox *BKE_object_boundbox_get(struct Object *ob);
217 void BKE_object_dimensions_get(struct Object *ob, float r_vec[3]);
218 void BKE_object_dimensions_set_ex(struct Object *ob,
219                                   const float value[3],
220                                   int axis_mask,
221                                   const float ob_scale_orig[3],
222                                   const float ob_obmat_orig[4][4]);
223 void BKE_object_dimensions_set(struct Object *ob, const float value[3], int axis_mask);
224
225 void BKE_object_empty_draw_type_set(struct Object *ob, const int value);
226 void BKE_object_boundbox_flag(struct Object *ob, int flag, const bool set);
227 void BKE_object_boundbox_calc_from_mesh(struct Object *ob, struct Mesh *me_eval);
228 void BKE_object_minmax(struct Object *ob, float r_min[3], float r_max[3], const bool use_hidden);
229 bool BKE_object_minmax_dupli(struct Depsgraph *depsgraph,
230                              struct Scene *scene,
231                              struct Object *ob,
232                              float r_min[3],
233                              float r_max[3],
234                              const bool use_hidden);
235
236 /* sometimes min-max isn't enough, we need to loop over each point */
237 void BKE_object_foreach_display_point(struct Object *ob,
238                                       const float obmat[4][4],
239                                       void (*func_cb)(const float[3], void *),
240                                       void *user_data);
241 void BKE_scene_foreach_display_point(struct Depsgraph *depsgraph,
242                                      void (*func_cb)(const float[3], void *),
243                                      void *user_data);
244
245 bool BKE_object_parent_loop_check(const struct Object *parent, const struct Object *ob);
246
247 void *BKE_object_tfm_backup(struct Object *ob);
248 void BKE_object_tfm_restore(struct Object *ob, void *obtfm_pt);
249
250 typedef struct ObjectTfmProtectedChannels {
251   float loc[3], dloc[3];
252   float scale[3], dscale[3];
253   float rot[3], drot[3];
254   float quat[4], dquat[4];
255   float rotAxis[3], drotAxis[3];
256   float rotAngle, drotAngle;
257 } ObjectTfmProtectedChannels;
258
259 void BKE_object_tfm_protected_backup(const struct Object *ob, ObjectTfmProtectedChannels *obtfm);
260
261 void BKE_object_tfm_protected_restore(struct Object *ob,
262                                       const ObjectTfmProtectedChannels *obtfm,
263                                       const short protectflag);
264
265 void BKE_object_tfm_copy(struct Object *object_dst, const struct Object *object_src);
266
267 void BKE_object_eval_reset(struct Object *ob_eval);
268
269 /* Dependency graph evaluation callbacks. */
270 void BKE_object_eval_local_transform(struct Depsgraph *depsgraph, struct Object *ob);
271 void BKE_object_eval_parent(struct Depsgraph *depsgraph, struct Object *ob);
272 void BKE_object_eval_constraints(struct Depsgraph *depsgraph,
273                                  struct Scene *scene,
274                                  struct Object *ob);
275 void BKE_object_eval_transform_final(struct Depsgraph *depsgraph, struct Object *ob);
276
277 bool BKE_object_eval_proxy_copy(struct Depsgraph *depsgraph, struct Object *object);
278 void BKE_object_eval_uber_transform(struct Depsgraph *depsgraph, struct Object *ob);
279 void BKE_object_eval_uber_data(struct Depsgraph *depsgraph,
280                                struct Scene *scene,
281                                struct Object *ob);
282 void BKE_object_eval_assign_data(struct Object *object, struct ID *data, bool is_owned);
283
284 void BKE_object_eval_boundbox(struct Depsgraph *depsgraph, struct Object *object);
285 void BKE_object_sync_to_original(struct Depsgraph *depsgraph, struct Object *object);
286
287 void BKE_object_eval_ptcache_reset(struct Depsgraph *depsgraph,
288                                    struct Scene *scene,
289                                    struct Object *object);
290
291 void BKE_object_eval_transform_all(struct Depsgraph *depsgraph,
292                                    struct Scene *scene,
293                                    struct Object *object);
294
295 void BKE_object_data_select_update(struct Depsgraph *depsgraph, struct ID *object_data);
296 void BKE_object_select_update(struct Depsgraph *depsgraph, struct Object *object);
297
298 void BKE_object_eval_eval_base_flags(struct Depsgraph *depsgraph,
299                                      struct Scene *scene,
300                                      const int view_layer_index,
301                                      struct Object *object,
302                                      int base_index,
303                                      const bool is_from_set);
304
305 void BKE_object_handle_data_update(struct Depsgraph *depsgraph,
306                                    struct Scene *scene,
307                                    struct Object *ob);
308 void BKE_object_handle_update(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob);
309 void BKE_object_handle_update_ex(struct Depsgraph *depsgraph,
310                                  struct Scene *scene,
311                                  struct Object *ob,
312                                  struct RigidBodyWorld *rbw,
313                                  const bool do_proxy_update);
314
315 void BKE_object_sculpt_data_create(struct Object *ob);
316
317 bool BKE_object_obdata_texspace_get(struct Object *ob,
318                                     short **r_texflag,
319                                     float **r_loc,
320                                     float **r_size);
321
322 struct Mesh *BKE_object_get_evaluated_mesh(struct Object *object);
323 struct Mesh *BKE_object_get_pre_modified_mesh(struct Object *object);
324 struct Mesh *BKE_object_get_original_mesh(struct Object *object);
325
326 int BKE_object_insert_ptcache(struct Object *ob);
327 void BKE_object_delete_ptcache(struct Object *ob, int index);
328 struct KeyBlock *BKE_object_shapekey_insert(struct Main *bmain,
329                                             struct Object *ob,
330                                             const char *name,
331                                             const bool from_mix);
332 bool BKE_object_shapekey_remove(struct Main *bmain, struct Object *ob, struct KeyBlock *kb);
333 bool BKE_object_shapekey_free(struct Main *bmain, struct Object *ob);
334
335 bool BKE_object_flag_test_recursive(const struct Object *ob, short flag);
336
337 bool BKE_object_is_child_recursive(const struct Object *ob_parent, const struct Object *ob_child);
338
339 /* return ModifierMode flag */
340 int BKE_object_is_modified(struct Scene *scene, struct Object *ob);
341 int BKE_object_is_deform_modified(struct Scene *scene, struct Object *ob);
342
343 bool BKE_object_moves_in_time(const struct Object *object, bool recurse_parent);
344
345 int BKE_object_scenes_users_get(struct Main *bmain, struct Object *ob);
346
347 struct MovieClip *BKE_object_movieclip_get(struct Scene *scene,
348                                            struct Object *ob,
349                                            bool use_default);
350
351 void BKE_object_runtime_reset(struct Object *object);
352 void BKE_object_runtime_reset_on_copy(struct Object *object, const int flag);
353
354 void BKE_object_batch_cache_dirty_tag(struct Object *ob);
355
356 /* this function returns a superset of the scenes selection based on relationships */
357
358 typedef enum eObRelationTypes {
359   OB_REL_NONE = 0,                      /* just the selection as is */
360   OB_REL_PARENT = (1 << 0),             /* immediate parent */
361   OB_REL_PARENT_RECURSIVE = (1 << 1),   /* parents up to root of selection tree*/
362   OB_REL_CHILDREN = (1 << 2),           /* immediate children */
363   OB_REL_CHILDREN_RECURSIVE = (1 << 3), /* All children */
364   OB_REL_MOD_ARMATURE = (1 << 4),       /* Armatures related to the selected objects */
365   /* OB_REL_SCENE_CAMERA = (1 << 5), */ /* you might want the scene camera too even if unselected?
366                                          */
367 } eObRelationTypes;
368
369 typedef enum eObjectSet {
370   OB_SET_SELECTED, /* Selected Objects */
371   OB_SET_VISIBLE,  /* Visible Objects  */
372   OB_SET_ALL,      /* All Objects      */
373 } eObjectSet;
374
375 struct LinkNode *BKE_object_relational_superset(struct ViewLayer *view_layer,
376                                                 eObjectSet objectSet,
377                                                 eObRelationTypes includeFilter);
378 struct LinkNode *BKE_object_groups(struct Main *bmain, struct Scene *scene, struct Object *ob);
379 void BKE_object_groups_clear(struct Main *bmain, struct Scene *scene, struct Object *object);
380
381 struct KDTree_3d *BKE_object_as_kdtree(struct Object *ob, int *r_tot);
382
383 bool BKE_object_modifier_use_time(struct Object *ob, struct ModifierData *md);
384
385 bool BKE_object_modifier_update_subframe(struct Depsgraph *depsgraph,
386                                          struct Scene *scene,
387                                          struct Object *ob,
388                                          bool update_mesh,
389                                          int parent_recursion,
390                                          float frame,
391                                          int type);
392
393 bool BKE_object_empty_image_frame_is_visible_in_view3d(const struct Object *ob,
394                                                        const struct RegionView3D *rv3d);
395 bool BKE_object_empty_image_data_is_visible_in_view3d(const struct Object *ob,
396                                                       const struct RegionView3D *rv3d);
397
398 /* This is an utility function for Python's object.to_mesh() (the naming is not very clear though).
399  * The result is owned by the object.
400  *
401  * The mesh will be freed when object is re-evaluated or is destroyed. It is possible to force to
402  * clear memory used by this mesh by calling BKE_object_to_mesh_clear().
403  *
404  * If preserve_all_data_layers is truth then the modifier stack is re-evaluated to ensure it
405  * preserves all possible custom data layers.
406  *
407  * NOTE: Dependency graph argument is required when preserve_all_data_layers is truth, and is
408  * ignored otherwise. */
409 struct Mesh *BKE_object_to_mesh(struct Depsgraph *depsgraph,
410                                 struct Object *object,
411                                 bool preserve_all_data_layers);
412
413 void BKE_object_to_mesh_clear(struct Object *object);
414
415 void BKE_object_check_uuids_unique_and_report(const struct Object *object);
416
417 #ifdef __cplusplus
418 }
419 #endif