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