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