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