58d648b4aa44d45036bb8b05418b2f1b76996eb4
[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, 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 void BKE_object_copy_softbody(struct Object *ob_dst, const struct Object *ob_src, const int flag);
57 struct ParticleSystem *BKE_object_copy_particlesystem(struct ParticleSystem *psys, const int flag);
58 void BKE_object_copy_particlesystems(struct Object *ob_dst, const struct Object *ob_src, const int flag);
59 void BKE_object_free_particlesystems(struct Object *ob);
60 void BKE_object_free_softbody(struct Object *ob);
61 void BKE_object_free_curve_cache(struct Object *ob);
62
63 void BKE_object_free(struct Object *ob);
64 void BKE_object_free_derived_caches(struct Object *ob);
65 void BKE_object_free_derived_mesh_caches(struct Object *ob);
66 void BKE_object_free_caches(struct Object *object);
67
68 void BKE_object_modifier_hook_reset(struct Object *ob, struct HookModifierData *hmd);
69 void BKE_object_modifier_gpencil_hook_reset(struct Object *ob, struct HookGpencilModifierData *hmd);
70 bool BKE_object_modifier_gpencil_use_time(struct Object *ob, struct GpencilModifierData *md);
71
72 bool BKE_object_shaderfx_use_time(struct Object *ob, struct ShaderFxData *md);
73
74 bool BKE_object_support_modifier_type_check(const struct Object *ob, int modifier_type);
75
76 void BKE_object_link_modifiers(struct Scene *scene, struct Object *ob_dst, const struct Object *ob_src);
77 void BKE_object_free_modifiers(struct Object *ob, const int flag);
78 void BKE_object_free_shaderfx(struct Object *ob, const int flag);
79
80 void BKE_object_make_proxy(struct Main *bmain, struct Object *ob, struct Object *target, struct Object *gob);
81 void BKE_object_copy_proxy_drivers(struct Object *ob, struct Object *target);
82
83 bool BKE_object_exists_check(struct Main *bmain, const struct Object *obtest);
84 bool BKE_object_is_in_editmode(const struct Object *ob);
85 bool BKE_object_is_in_editmode_vgroup(const struct Object *ob);
86 bool BKE_object_is_in_wpaint_select_vert(const struct Object *ob);
87 bool BKE_object_has_mode_data(const struct Object *ob, eObjectMode object_mode);
88 bool BKE_object_is_mode_compat(const struct Object *ob, eObjectMode object_mode);
89
90 bool BKE_object_data_is_in_editmode(const struct ID *id);
91
92 typedef enum eObjectVisibilityResult {
93         OB_VISIBLE_SELF = 1,
94         OB_VISIBLE_PARTICLES = 2,
95         OB_VISIBLE_INSTANCES = 4,
96         OB_VISIBLE_ALL = (OB_VISIBLE_SELF | OB_VISIBLE_PARTICLES | OB_VISIBLE_INSTANCES),
97 } eObjectVisibilityResult;
98
99 int BKE_object_visibility(const struct Object *ob, const int dag_eval_mode);
100
101 void BKE_object_init(struct Object *ob);
102 struct Object *BKE_object_add_only_object(
103         struct Main *bmain,
104         int type, const char *name)
105         ATTR_NONNULL(1) ATTR_RETURNS_NONNULL;
106 struct Object *BKE_object_add(
107         struct Main *bmain, struct Scene *scene, struct ViewLayer *view_layer,
108         int type, const char *name)
109         ATTR_NONNULL(1, 2, 3) ATTR_RETURNS_NONNULL;
110 struct Object *BKE_object_add_from(
111         struct Main *bmain, struct Scene *scene, struct ViewLayer *view_layer,
112         int type, const char *name, struct Object *ob_src)
113         ATTR_NONNULL(1, 2, 3, 6) ATTR_RETURNS_NONNULL;
114 struct Object *BKE_object_add_for_data(
115         struct Main *bmain, struct ViewLayer *view_layer,
116         int type, const char *name, struct ID *data, bool do_id_user) ATTR_RETURNS_NONNULL;
117 void *BKE_object_obdata_add_from_type(
118         struct Main *bmain,
119         int type, const char *name)
120         ATTR_NONNULL(1);
121
122 void BKE_object_copy_data(struct Main *bmain, struct Object *ob_dst, const struct Object *ob_src, const int flag);
123 struct Object *BKE_object_copy(struct Main *bmain, const struct Object *ob);
124 void BKE_object_make_local(struct Main *bmain, struct Object *ob, const bool lib_local);
125 void BKE_object_make_local_ex(struct Main *bmain, struct Object *ob, const bool lib_local, const bool clear_proxy);
126 bool BKE_object_is_libdata(const struct Object *ob);
127 bool BKE_object_obdata_is_libdata(const struct Object *ob);
128
129 void BKE_object_obdata_size_init(struct Object *ob, const float scale);
130
131 void BKE_object_scale_to_mat3(struct Object *ob, float mat[3][3]);
132 void BKE_object_rot_to_mat3(struct Object *ob, float mat[3][3], bool use_drot);
133 void BKE_object_mat3_to_rot(struct Object *ob, float mat[3][3], bool use_compat);
134 void BKE_object_to_mat3(struct Object *ob, float mat[3][3]);
135 void BKE_object_to_mat4(struct Object *ob, float mat[4][4]);
136 void BKE_object_apply_mat4(struct Object *ob, float mat[4][4], const bool use_compat, const bool use_parent);
137 void BKE_object_apply_mat4_ex(struct Object *ob, float mat[4][4], struct Object *parent, float parentinv[4][4], const bool use_compat);
138 void BKE_object_matrix_local_get(struct Object *ob, float mat[4][4]);
139
140 bool BKE_object_pose_context_check(const struct Object *ob);
141 struct Object *BKE_object_pose_armature_get(struct Object *ob);
142 struct Object *BKE_object_pose_armature_get_visible(struct Object *ob, struct ViewLayer *view_layer, struct View3D *v3d);
143
144 struct Object **BKE_object_pose_array_get_ex(struct ViewLayer *view_layer, struct View3D *v3d, unsigned int *r_objects_len, bool unique);
145 struct Object **BKE_object_pose_array_get_unique(struct ViewLayer *view_layer, struct View3D *v3d, unsigned int *r_objects_len);
146 struct Object **BKE_object_pose_array_get(struct ViewLayer *view_layer, struct View3D *v3d, unsigned int *r_objects_len);
147
148 struct Base **BKE_object_pose_base_array_get_ex(struct ViewLayer *view_layer, struct View3D *v3d, unsigned int *r_bases_len, bool unique);
149 struct Base **BKE_object_pose_base_array_get_unique(struct ViewLayer *view_layer, struct View3D *v3d, unsigned int *r_bases_len);
150 struct Base **BKE_object_pose_base_array_get(struct ViewLayer *view_layer, struct View3D *v3d, unsigned int *r_bases_len);
151
152 void BKE_object_get_parent_matrix(
153         struct Object *ob, struct Object *par, float parentmat[4][4]);
154 void BKE_object_where_is_calc(
155         struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob);
156 void BKE_object_where_is_calc_ex(
157         struct Depsgraph *depsgraph, struct Scene *scene, struct RigidBodyWorld *rbw,
158         struct Object *ob, float r_originmat[3][3]);
159 void BKE_object_where_is_calc_time(
160         struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob, float ctime);
161 void BKE_object_where_is_calc_mat4(struct Object *ob, float obmat[4][4]);
162
163 /* possibly belong in own moduke? */
164 struct BoundBox *BKE_boundbox_alloc_unit(void);
165 void BKE_boundbox_init_from_minmax(struct BoundBox *bb, const float min[3], const float max[3]);
166 void BKE_boundbox_calc_center_aabb(const struct BoundBox *bb, float r_cent[3]);
167 void BKE_boundbox_calc_size_aabb(const struct BoundBox *bb, float r_size[3]);
168 void BKE_boundbox_minmax(const struct BoundBox *bb, float obmat[4][4], float r_min[3], float r_max[3]);
169
170 struct BoundBox *BKE_object_boundbox_get(struct Object *ob);
171 void BKE_object_dimensions_get(struct Object *ob, float vec[3]);
172 void BKE_object_dimensions_set(struct Object *ob, const float value[3], int axis_mask);
173 void BKE_object_empty_draw_type_set(struct Object *ob, const int value);
174 void BKE_object_boundbox_flag(struct Object *ob, int flag, const bool set);
175 void BKE_object_boundbox_calc_from_mesh(struct Object *ob, struct Mesh *me_eval);
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 Depsgraph *depsgraph, struct Scene *scene, struct Object *ob,
179         float r_min[3], float r_max[3], const bool use_hidden);
180
181 /* sometimes min-max isn't enough, we need to loop over each point */
182 void BKE_object_foreach_display_point(
183         struct Object *ob, float obmat[4][4],
184         void (*func_cb)(const float[3], void *), void *user_data);
185 void BKE_scene_foreach_display_point(
186         struct Depsgraph *depsgraph,
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 scale[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 void BKE_object_tfm_copy(
213         struct Object *object_dst,
214         const struct Object *object_src);
215
216 void BKE_object_eval_reset(
217         struct Object *ob_eval);
218
219 /* Dependency graph evaluation callbacks. */
220 void BKE_object_eval_local_transform(
221         struct Depsgraph *depsgraph,
222         struct Object *ob);
223 void BKE_object_eval_parent(
224         struct Depsgraph *depsgraph,
225         struct Object *ob);
226 void BKE_object_eval_constraints(
227         struct Depsgraph *depsgraph,
228         struct Scene *scene,
229         struct Object *ob);
230 void BKE_object_eval_transform_final(
231         struct Depsgraph *depsgraph, struct Object *ob);
232
233 bool BKE_object_eval_proxy_copy(
234         struct Depsgraph *depsgraph,
235         struct Object *object);
236 void BKE_object_eval_uber_transform(
237         struct Depsgraph *depsgraph,
238         struct Object *ob);
239 void BKE_object_eval_uber_data(
240         struct Depsgraph *depsgraph,
241         struct Scene *scene,
242         struct Object *ob);
243
244 void BKE_object_eval_boundbox(struct Depsgraph *depsgraph,
245                               struct Object *object);
246 void BKE_object_synchronize_to_original(struct Depsgraph *depsgraph,
247                                         struct Object *object);
248
249 void BKE_object_eval_ptcache_reset(
250         struct Depsgraph *depsgraph,
251         struct Scene *scene,
252         struct Object *object);
253
254 void BKE_object_eval_transform_all(
255         struct Depsgraph *depsgraph,
256         struct Scene *scene,
257         struct Object *object);
258
259 void BKE_object_eval_update_shading(
260         struct Depsgraph *depsgraph,
261         struct Object *object);
262 void BKE_object_data_select_update(
263         struct Depsgraph *depsgraph,
264         struct ID *object_data);
265
266 void BKE_object_eval_eval_base_flags(
267         struct Depsgraph *depsgraph,
268         struct Scene *scene, const int view_layer_index,
269         struct Object *object, int base_index,
270         const bool is_from_set);
271
272 void BKE_object_handle_data_update(struct Depsgraph *depsgraph,
273         struct Scene *scene,
274         struct Object *ob);
275 void BKE_object_handle_update(struct Depsgraph *depsgraph,
276         struct Scene *scene, struct Object *ob);
277 void BKE_object_handle_update_ex(
278         struct Depsgraph *depsgraph,
279         struct Scene *scene, struct Object *ob,
280         struct RigidBodyWorld *rbw,
281         const bool do_proxy_update);
282 void BKE_object_sculpt_modifiers_changed(struct Object *ob);
283
284 void BKE_object_sculpt_data_create(struct Object *ob);
285
286 int BKE_object_obdata_texspace_get(struct Object *ob, short **r_texflag, float **r_loc, float **r_size, float **r_rot);
287
288 struct Mesh *BKE_object_get_evaluated_mesh(const struct Depsgraph *depsgraph, struct Object *ob);
289 struct Mesh *BKE_object_get_final_mesh(struct Object *object);
290 struct Mesh *BKE_object_get_pre_modified_mesh(struct Object *object);
291 struct Mesh *BKE_object_get_original_mesh(struct Object *object);
292
293 int BKE_object_insert_ptcache(struct Object *ob);
294 void BKE_object_delete_ptcache(struct Object *ob, int index);
295 struct KeyBlock *BKE_object_shapekey_insert(struct Main *bmain, struct Object *ob, const char *name, const bool from_mix);
296 bool BKE_object_shapekey_remove(struct Main *bmain, struct Object *ob, struct KeyBlock *kb);
297 bool BKE_object_shapekey_free(struct Main *bmain, struct Object *ob);
298
299 bool BKE_object_flag_test_recursive(const struct Object *ob, short flag);
300
301 bool BKE_object_is_child_recursive(const struct Object *ob_parent, const struct Object *ob_child);
302 bool BKE_object_is_animated(struct Scene *scene, struct Object *ob);
303
304 /* return ModifierMode flag */
305 int BKE_object_is_modified(struct Scene *scene, struct Object *ob);
306 int BKE_object_is_deform_modified(struct Scene *scene, struct Object *ob);
307
308 int BKE_object_scenes_users_get(struct Main *bmain, struct Object *ob);
309
310 struct MovieClip *BKE_object_movieclip_get(struct Scene *scene, struct Object *ob, bool use_default);
311
312 void BKE_object_runtime_reset(struct Object *object);
313 void BKE_object_runtime_reset_on_copy(struct Object *object, const int flag);
314
315 void BKE_object_batch_cache_dirty_tag(struct Object *ob);
316
317 /* this function returns a superset of the scenes selection based on relationships */
318
319 typedef enum eObRelationTypes {
320         OB_REL_NONE               = 0,        /* just the selection as is */
321         OB_REL_PARENT             = (1 << 0), /* immediate parent */
322         OB_REL_PARENT_RECURSIVE   = (1 << 1), /* parents up to root of selection tree*/
323         OB_REL_CHILDREN           = (1 << 2), /* immediate children */
324         OB_REL_CHILDREN_RECURSIVE = (1 << 3), /* All children */
325         OB_REL_MOD_ARMATURE       = (1 << 4), /* Armatures related to the selected objects */
326         OB_REL_SCENE_CAMERA       = (1 << 5), /* you might want the scene camera too even if unselected? */
327 } eObRelationTypes;
328
329 typedef enum eObjectSet {
330         OB_SET_SELECTED, /* Selected Objects */
331         OB_SET_VISIBLE,  /* Visible Objects  */
332         OB_SET_ALL       /* All Objects      */
333 } eObjectSet;
334
335 struct LinkNode *BKE_object_relational_superset(
336         struct ViewLayer *view_layer, eObjectSet objectSet, eObRelationTypes includeFilter);
337 struct LinkNode *BKE_object_groups(struct Main *bmain, struct Object *ob);
338 void             BKE_object_groups_clear(struct Main *bmain, struct Object *object);
339
340 struct KDTree *BKE_object_as_kdtree(struct Object *ob, int *r_tot);
341
342 bool BKE_object_modifier_use_time(struct Object *ob, struct ModifierData *md);
343
344 bool BKE_object_modifier_update_subframe(
345         struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob,
346         bool update_mesh, int parent_recursion, float frame, int type);
347
348 void BKE_object_type_set_empty_for_versioning(struct Object *ob);
349
350 bool BKE_object_empty_image_is_visible_in_view3d(const struct Object *ob, const struct RegionView3D *rv3d);
351
352 #ifdef __cplusplus
353 }
354 #endif
355
356 #endif