ClangFormat: apply to source, most of intern
[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 #ifndef __BKE_OBJECT_H__
18 #define __BKE_OBJECT_H__
19
20 /** \file
21  * \ingroup bke
22  * \brief General operations, lookup, etc. for blender objects.
23  */
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 #include "BLI_compiler_attrs.h"
29
30 struct Base;
31 struct BoundBox;
32 struct Depsgraph;
33 struct GpencilModifierData;
34 struct HookGpencilModifierData;
35 struct HookModifierData;
36 struct ID;
37 struct Main;
38 struct Mesh;
39 struct ModifierData;
40 struct MovieClip;
41 struct Object;
42 struct RegionView3D;
43 struct RigidBodyWorld;
44 struct Scene;
45 struct ShaderFxData;
46 struct SoftBody;
47 struct View3D;
48 struct ViewLayer;
49
50 #include "DNA_object_enums.h"
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(struct Object *ob);
69 void BKE_object_free_derived_caches(struct Object *ob);
70 void BKE_object_free_derived_mesh_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 void BKE_object_modifier_gpencil_hook_reset(struct Object *ob,
75                                             struct HookGpencilModifierData *hmd);
76 bool BKE_object_modifier_gpencil_use_time(struct Object *ob, struct GpencilModifierData *md);
77
78 bool BKE_object_shaderfx_use_time(struct Object *ob, struct ShaderFxData *md);
79
80 bool BKE_object_support_modifier_type_check(const struct Object *ob, int modifier_type);
81
82 void BKE_object_link_modifiers(struct Scene *scene,
83                                struct Object *ob_dst,
84                                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 *gob);
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 typedef enum eObjectVisibilityResult {
104   OB_VISIBLE_SELF = 1,
105   OB_VISIBLE_PARTICLES = 2,
106   OB_VISIBLE_INSTANCES = 4,
107   OB_VISIBLE_ALL = (OB_VISIBLE_SELF | OB_VISIBLE_PARTICLES | OB_VISIBLE_INSTANCES),
108 } eObjectVisibilityResult;
109
110 int BKE_object_visibility(const struct Object *ob, const int dag_eval_mode);
111
112 void BKE_object_init(struct Object *ob);
113 struct Object *BKE_object_add_only_object(struct Main *bmain, int type, const char *name)
114     ATTR_NONNULL(1) ATTR_RETURNS_NONNULL;
115 struct Object *BKE_object_add(struct Main *bmain,
116                               struct Scene *scene,
117                               struct ViewLayer *view_layer,
118                               int type,
119                               const char *name) ATTR_NONNULL(1, 2, 3) ATTR_RETURNS_NONNULL;
120 struct Object *BKE_object_add_from(struct Main *bmain,
121                                    struct Scene *scene,
122                                    struct ViewLayer *view_layer,
123                                    int type,
124                                    const char *name,
125                                    struct Object *ob_src)
126     ATTR_NONNULL(1, 2, 3, 6) ATTR_RETURNS_NONNULL;
127 struct Object *BKE_object_add_for_data(struct Main *bmain,
128                                        struct ViewLayer *view_layer,
129                                        int type,
130                                        const char *name,
131                                        struct ID *data,
132                                        bool do_id_user) ATTR_RETURNS_NONNULL;
133 void *BKE_object_obdata_add_from_type(struct Main *bmain, int type, const char *name)
134     ATTR_NONNULL(1);
135
136 void BKE_object_copy_data(struct Main *bmain,
137                           struct Object *ob_dst,
138                           const struct Object *ob_src,
139                           const int flag);
140 struct Object *BKE_object_copy(struct Main *bmain, const struct Object *ob);
141 void BKE_object_make_local(struct Main *bmain, struct Object *ob, const bool lib_local);
142 void BKE_object_make_local_ex(struct Main *bmain,
143                               struct Object *ob,
144                               const bool lib_local,
145                               const bool clear_proxy);
146 bool BKE_object_is_libdata(const struct Object *ob);
147 bool BKE_object_obdata_is_libdata(const struct Object *ob);
148
149 struct Object *BKE_object_duplicate(struct Main *bmain,
150                                     const struct Object *ob,
151                                     const int dupflag);
152
153 void BKE_object_obdata_size_init(struct Object *ob, const float scale);
154
155 void BKE_object_scale_to_mat3(struct Object *ob, float mat[3][3]);
156 void BKE_object_rot_to_mat3(struct Object *ob, float mat[3][3], bool use_drot);
157 void BKE_object_mat3_to_rot(struct Object *ob, float mat[3][3], bool use_compat);
158 void BKE_object_to_mat3(struct Object *ob, float mat[3][3]);
159 void BKE_object_to_mat4(struct Object *ob, float mat[4][4]);
160 void BKE_object_apply_mat4(struct Object *ob,
161                            float mat[4][4],
162                            const bool use_compat,
163                            const bool use_parent);
164 void BKE_object_apply_mat4_ex(struct Object *ob,
165                               float mat[4][4],
166                               struct Object *parent,
167                               float parentinv[4][4],
168                               const bool use_compat);
169 void BKE_object_matrix_local_get(struct Object *ob, float mat[4][4]);
170
171 bool BKE_object_pose_context_check(const struct Object *ob);
172 struct Object *BKE_object_pose_armature_get(struct Object *ob);
173 struct Object *BKE_object_pose_armature_get_visible(struct Object *ob,
174                                                     struct ViewLayer *view_layer,
175                                                     struct View3D *v3d);
176
177 struct Object **BKE_object_pose_array_get_ex(struct ViewLayer *view_layer,
178                                              struct View3D *v3d,
179                                              unsigned int *r_objects_len,
180                                              bool unique);
181 struct Object **BKE_object_pose_array_get_unique(struct ViewLayer *view_layer,
182                                                  struct View3D *v3d,
183                                                  unsigned int *r_objects_len);
184 struct Object **BKE_object_pose_array_get(struct ViewLayer *view_layer,
185                                           struct View3D *v3d,
186                                           unsigned int *r_objects_len);
187
188 struct Base **BKE_object_pose_base_array_get_ex(struct ViewLayer *view_layer,
189                                                 struct View3D *v3d,
190                                                 unsigned int *r_bases_len,
191                                                 bool unique);
192 struct Base **BKE_object_pose_base_array_get_unique(struct ViewLayer *view_layer,
193                                                     struct View3D *v3d,
194                                                     unsigned int *r_bases_len);
195 struct Base **BKE_object_pose_base_array_get(struct ViewLayer *view_layer,
196                                              struct View3D *v3d,
197                                              unsigned int *r_bases_len);
198
199 void BKE_object_get_parent_matrix(struct Object *ob, struct Object *par, float parentmat[4][4]);
200 void BKE_object_where_is_calc(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob);
201 void BKE_object_where_is_calc_ex(struct Depsgraph *depsgraph,
202                                  struct Scene *scene,
203                                  struct RigidBodyWorld *rbw,
204                                  struct Object *ob,
205                                  float r_originmat[3][3]);
206 void BKE_object_where_is_calc_time(struct Depsgraph *depsgraph,
207                                    struct Scene *scene,
208                                    struct Object *ob,
209                                    float ctime);
210 void BKE_object_where_is_calc_mat4(struct Object *ob, float obmat[4][4]);
211
212 /* possibly belong in own moduke? */
213 struct BoundBox *BKE_boundbox_alloc_unit(void);
214 void BKE_boundbox_init_from_minmax(struct BoundBox *bb, const float min[3], const float max[3]);
215 void BKE_boundbox_calc_center_aabb(const struct BoundBox *bb, float r_cent[3]);
216 void BKE_boundbox_calc_size_aabb(const struct BoundBox *bb, float r_size[3]);
217 void BKE_boundbox_minmax(const struct BoundBox *bb,
218                          float obmat[4][4],
219                          float r_min[3],
220                          float r_max[3]);
221
222 struct BoundBox *BKE_object_boundbox_get(struct Object *ob);
223 void BKE_object_dimensions_get(struct Object *ob, float vec[3]);
224 void BKE_object_dimensions_set(struct Object *ob, const float value[3], int axis_mask);
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                                       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
283 void BKE_object_eval_boundbox(struct Depsgraph *depsgraph, struct Object *object);
284 void BKE_object_synchronize_to_original(struct Depsgraph *depsgraph, struct Object *object);
285
286 void BKE_object_eval_ptcache_reset(struct Depsgraph *depsgraph,
287                                    struct Scene *scene,
288                                    struct Object *object);
289
290 void BKE_object_eval_transform_all(struct Depsgraph *depsgraph,
291                                    struct Scene *scene,
292                                    struct Object *object);
293
294 void BKE_object_eval_update_shading(struct Depsgraph *depsgraph, struct Object *object);
295 void BKE_object_data_select_update(struct Depsgraph *depsgraph, struct ID *object_data);
296
297 void BKE_object_eval_eval_base_flags(struct Depsgraph *depsgraph,
298                                      struct Scene *scene,
299                                      const int view_layer_index,
300                                      struct Object *object,
301                                      int base_index,
302                                      const bool is_from_set);
303
304 void BKE_object_handle_data_update(struct Depsgraph *depsgraph,
305                                    struct Scene *scene,
306                                    struct Object *ob);
307 void BKE_object_handle_update(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob);
308 void BKE_object_handle_update_ex(struct Depsgraph *depsgraph,
309                                  struct Scene *scene,
310                                  struct Object *ob,
311                                  struct RigidBodyWorld *rbw,
312                                  const bool do_proxy_update);
313 void BKE_object_sculpt_modifiers_changed(struct Object *ob);
314
315 void BKE_object_sculpt_data_create(struct Object *ob);
316
317 int BKE_object_obdata_texspace_get(
318     struct Object *ob, short **r_texflag, float **r_loc, float **r_size, float **r_rot);
319
320 struct Mesh *BKE_object_get_evaluated_mesh(const struct Depsgraph *depsgraph, struct Object *ob);
321 struct Mesh *BKE_object_get_final_mesh(struct Object *object);
322 struct Mesh *BKE_object_get_pre_modified_mesh(struct Object *object);
323 struct Mesh *BKE_object_get_original_mesh(struct Object *object);
324
325 int BKE_object_insert_ptcache(struct Object *ob);
326 void BKE_object_delete_ptcache(struct Object *ob, int index);
327 struct KeyBlock *BKE_object_shapekey_insert(struct Main *bmain,
328                                             struct Object *ob,
329                                             const char *name,
330                                             const bool from_mix);
331 bool BKE_object_shapekey_remove(struct Main *bmain, struct Object *ob, struct KeyBlock *kb);
332 bool BKE_object_shapekey_free(struct Main *bmain, struct Object *ob);
333
334 bool BKE_object_flag_test_recursive(const struct Object *ob, short flag);
335
336 bool BKE_object_is_child_recursive(const struct Object *ob_parent, const struct Object *ob_child);
337 bool BKE_object_is_animated(struct Scene *scene, struct Object *ob);
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 int BKE_object_scenes_users_get(struct Main *bmain, struct Object *ob);
344
345 struct MovieClip *BKE_object_movieclip_get(struct Scene *scene,
346                                            struct Object *ob,
347                                            bool use_default);
348
349 void BKE_object_runtime_reset(struct Object *object);
350 void BKE_object_runtime_reset_on_copy(struct Object *object, const int flag);
351
352 void BKE_object_batch_cache_dirty_tag(struct Object *ob);
353
354 /* this function returns a superset of the scenes selection based on relationships */
355
356 typedef enum eObRelationTypes {
357   OB_REL_NONE = 0,                      /* just the selection as is */
358   OB_REL_PARENT = (1 << 0),             /* immediate parent */
359   OB_REL_PARENT_RECURSIVE = (1 << 1),   /* parents up to root of selection tree*/
360   OB_REL_CHILDREN = (1 << 2),           /* immediate children */
361   OB_REL_CHILDREN_RECURSIVE = (1 << 3), /* All children */
362   OB_REL_MOD_ARMATURE = (1 << 4),       /* Armatures related to the selected objects */
363   OB_REL_SCENE_CAMERA = (1 << 5), /* you might want the scene camera too even if unselected? */
364 } eObRelationTypes;
365
366 typedef enum eObjectSet {
367   OB_SET_SELECTED, /* Selected Objects */
368   OB_SET_VISIBLE,  /* Visible Objects  */
369   OB_SET_ALL,      /* All Objects      */
370 } eObjectSet;
371
372 struct LinkNode *BKE_object_relational_superset(struct ViewLayer *view_layer,
373                                                 eObjectSet objectSet,
374                                                 eObRelationTypes includeFilter);
375 struct LinkNode *BKE_object_groups(struct Main *bmain, struct Scene *scene, struct Object *ob);
376 void BKE_object_groups_clear(struct Main *bmain, struct Scene *scene, struct Object *object);
377
378 struct KDTree_3d *BKE_object_as_kdtree(struct Object *ob, int *r_tot);
379
380 bool BKE_object_modifier_use_time(struct Object *ob, struct ModifierData *md);
381
382 bool BKE_object_modifier_update_subframe(struct Depsgraph *depsgraph,
383                                          struct Scene *scene,
384                                          struct Object *ob,
385                                          bool update_mesh,
386                                          int parent_recursion,
387                                          float frame,
388                                          int type);
389
390 void BKE_object_type_set_empty_for_versioning(struct Object *ob);
391
392 bool BKE_object_empty_image_frame_is_visible_in_view3d(const struct Object *ob,
393                                                        const struct RegionView3D *rv3d);
394 bool BKE_object_empty_image_data_is_visible_in_view3d(const struct Object *ob,
395                                                       const struct RegionView3D *rv3d);
396
397 #ifdef __cplusplus
398 }
399 #endif
400
401 #endif