Code cleanup: use r_ prefix for return args
[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 struct Base;
37 struct EvaluationContext;
38 struct Scene;
39 struct Object;
40 struct Camera;
41 struct BoundBox;
42 struct View3D;
43 struct SoftBody;
44 struct BulletSoftBody;
45 struct Group;
46 struct bAction;
47 struct RenderData;
48 struct rctf;
49 struct MovieClip;
50 struct Main;
51 struct RigidBodyWorld;
52 struct HookModifierData;
53
54 void BKE_object_workob_clear(struct Object *workob);
55 void BKE_object_workob_calc_parent(struct Scene *scene, struct Object *ob, struct Object *workob);
56
57 void BKE_object_transform_copy(struct Object *ob_tar, const struct Object *ob_src);
58 struct SoftBody *copy_softbody(struct SoftBody *sb, int copy_caches);
59 struct BulletSoftBody *copy_bulletsoftbody(struct BulletSoftBody *sb);
60 void BKE_object_copy_particlesystems(struct Object *obn, struct Object *ob);
61 void BKE_object_copy_softbody(struct Object *obn, struct Object *ob);
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_ex(struct Object *ob, bool do_id_user);
70 void BKE_object_free_derived_caches(struct Object *ob);
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, struct Object *from);
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 void BKE_object_unlink(struct Object *ob);
83 bool BKE_object_exists_check(struct Object *obtest);
84 bool BKE_object_is_in_editmode(struct Object *ob);
85 bool BKE_object_is_in_editmode_vgroup(struct Object *ob);
86 bool BKE_object_is_in_wpaint_select_vert(struct Object *ob);
87
88 struct Object *BKE_object_add_only_object(struct Main *bmain, int type, const char *name);
89 struct Object *BKE_object_add(struct Main *bmain, struct Scene *scene, int type);
90 void *BKE_object_obdata_add_from_type(struct Main *bmain, int type);
91
92 void BKE_object_lod_add(struct Object *ob);
93 void BKE_object_lod_sort(struct Object *ob);
94 bool BKE_object_lod_remove(struct Object *ob, int level);
95 bool BKE_object_lod_update(struct Object *ob, float camera_position[3]);
96 bool BKE_object_lod_is_usable(struct Object *ob, struct Scene *scene);
97 struct Object *BKE_object_lod_meshob_get(struct Object *ob, struct Scene *scene);
98 struct Object *BKE_object_lod_matob_get(struct Object *ob, struct Scene *scene);
99
100 struct Object *BKE_object_copy_ex(struct Main *bmain, struct Object *ob, int copy_caches);
101 struct Object *BKE_object_copy(struct Object *ob);
102 void BKE_object_make_local(struct Object *ob);
103 bool BKE_object_is_libdata(struct Object *ob);
104 bool BKE_object_obdata_is_libdata(struct Object *ob);
105
106 void BKE_object_scale_to_mat3(struct Object *ob, float mat[3][3]);
107 void BKE_object_rot_to_mat3(struct Object *ob, float mat[3][3], bool use_drot);
108 void BKE_object_mat3_to_rot(struct Object *ob, float mat[3][3], bool use_compat);
109 void BKE_object_to_mat3(struct Object *ob, float mat[3][3]);
110 void BKE_object_to_mat4(struct Object *ob, float mat[4][4]);
111 void BKE_object_apply_mat4(struct Object *ob, float mat[4][4], const bool use_compat, const bool use_parent);
112 void BKE_object_matrix_local_get(struct Object *ob, float mat[4][4]);
113
114 bool BKE_object_pose_context_check(struct Object *ob);
115 struct Object *BKE_object_pose_armature_get(struct Object *ob);
116
117 void BKE_object_where_is_calc(struct Scene *scene, struct Object *ob);
118 void BKE_object_where_is_calc_ex(struct Scene *scene, struct RigidBodyWorld *rbw, struct Object *ob, float r_originmat[3][3]);
119 void BKE_object_where_is_calc_time(struct Scene *scene, struct Object *ob, float ctime);
120 void BKE_object_where_is_calc_time_ex(struct Scene *scene, struct Object *ob, float ctime,
121                                       struct RigidBodyWorld *rbw, float r_originmat[3][3]);
122 void BKE_object_where_is_calc_mat4(struct Scene *scene, struct Object *ob, float obmat[4][4]);
123
124 /* possibly belong in own moduke? */
125 struct BoundBox *BKE_boundbox_alloc_unit(void);
126 void BKE_boundbox_init_from_minmax(struct BoundBox *bb, const float min[3], const float max[3]);
127 bool BKE_boundbox_ray_hit_check(struct BoundBox *bb, const float ray_start[3], const float ray_normal[3],
128                                 float *r_lambda);
129
130 struct BoundBox *BKE_object_boundbox_get(struct Object *ob);
131 void BKE_object_dimensions_get(struct Object *ob, float vec[3]);
132 void BKE_object_dimensions_set(struct Object *ob, const float *value);
133 void BKE_object_empty_draw_type_set(struct Object *ob, const int value);
134 void BKE_object_boundbox_flag(struct Object *ob, int flag, int set);
135 void BKE_object_minmax(struct Object *ob, float r_min[3], float r_max[3], const bool use_hidden);
136 bool BKE_object_minmax_dupli(struct Scene *scene, struct Object *ob, float r_min[3], float r_max[3], const bool use_hidden);
137
138 /* sometimes min-max isn't enough, we need to loop over each point */
139 void BKE_object_foreach_display_point(struct Object *ob, float obmat[4][4],
140                                       void (*func_cb)(const float[3], void *), void *user_data);
141 void BKE_scene_foreach_display_point(struct Scene *scene,
142                                      struct View3D *v3d,
143                                      const short flag,
144                                      void (*func_cb)(const float[3], void *), void *user_data);
145
146 bool BKE_object_parent_loop_check(const struct Object *parent, const struct Object *ob);
147
148 void *BKE_object_tfm_backup(struct Object *ob);
149 void  BKE_object_tfm_restore(struct Object *ob, void *obtfm_pt);
150
151 typedef struct ObjectTfmProtectedChannels {
152         float loc[3],     dloc[3];
153         float size[3],    dscale[3];
154         float rot[3],     drot[3];
155         float quat[4],    dquat[4];
156         float rotAxis[3], drotAxis[3];
157         float rotAngle,   drotAngle;
158 } ObjectTfmProtectedChannels;
159
160 void BKE_object_tfm_protected_backup(const struct Object *ob,
161                                      ObjectTfmProtectedChannels *obtfm);
162
163 void BKE_object_tfm_protected_restore(struct Object *ob,
164                                       const ObjectTfmProtectedChannels *obtfm,
165                                       const short protectflag);
166
167 void BKE_object_handle_update(struct EvaluationContext *eval_ctx, struct Scene *scene, struct Object *ob);
168 void BKE_object_handle_update_ex(struct EvaluationContext *eval_ctx,
169                                  struct Scene *scene, struct Object *ob,
170                                  struct RigidBodyWorld *rbw);
171 void BKE_object_sculpt_modifiers_changed(struct Object *ob);
172
173 int BKE_object_obdata_texspace_get(struct Object *ob, short **r_texflag, float **r_loc, float **r_size, float **r_rot);
174
175 int BKE_object_insert_ptcache(struct Object *ob);
176 void BKE_object_delete_ptcache(struct Object *ob, int index);
177 struct KeyBlock *BKE_object_insert_shape_key(struct Scene *scene, struct Object *ob, const char *name, const bool from_mix);
178
179 bool BKE_object_is_child_recursive(struct Object *ob_parent, struct Object *ob_child);
180 bool BKE_object_is_animated(struct Scene *scene, struct Object *ob);
181
182 /* return ModifierMode flag */
183 int BKE_object_is_modified(struct Scene *scene, struct Object *ob);
184 int BKE_object_is_deform_modified(struct Scene *scene, struct Object *ob);
185
186 void BKE_object_relink(struct Object *ob);
187
188 struct MovieClip *BKE_object_movieclip_get(struct Scene *scene, struct Object *ob, bool use_default);
189
190 /* this function returns a superset of the scenes selection based on relationships */
191
192 typedef enum eObRelationTypes {
193         OB_REL_NONE               = 0,        /* just the selection as is */
194         OB_REL_PARENT             = (1 << 0), /* immediate parent */
195         OB_REL_PARENT_RECURSIVE   = (1 << 1), /* parents up to root of selection tree*/
196         OB_REL_CHILDREN           = (1 << 2), /* immediate children */
197         OB_REL_CHILDREN_RECURSIVE = (1 << 3), /* All children */
198         OB_REL_MOD_ARMATURE       = (1 << 4), /* Armatures related to the selected objects */
199         OB_REL_SCENE_CAMERA       = (1 << 5), /* you might want the scene camera too even if unselected? */
200 } eObRelationTypes;
201
202 typedef enum eObjectSet {
203         OB_SET_SELECTED, /* Selected Objects */
204         OB_SET_VISIBLE,  /* Visible Objects  */
205         OB_SET_ALL       /* All Objects      */
206 } eObjectSet;
207
208 struct LinkNode *BKE_object_relational_superset(struct Scene *scene, eObjectSet objectSet, eObRelationTypes includeFilter);
209 struct LinkNode *BKE_object_groups(struct Object *ob);
210 void             BKE_object_groups_clear(struct Scene *scene, struct Base *base, struct Object *object);
211
212 struct KDTree *BKE_object_as_kdtree(struct Object *ob, int *r_tot);
213
214 #ifdef __cplusplus
215 }
216 #endif
217
218 #endif