move api functions from r57909 into BKE.
[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 Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BKE_OBJECT_H__
29 #define __BKE_OBJECT_H__
30
31 /** \file BKE_object.h
32  *  \ingroup bke
33  *  \brief General operations, lookup, etc. for blender objects.
34  */
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 struct Base;
40 struct Scene;
41 struct Object;
42 struct Camera;
43 struct BoundBox;
44 struct View3D;
45 struct SoftBody;
46 struct BulletSoftBody;
47 struct Group;
48 struct bAction;
49 struct RenderData;
50 struct rctf;
51 struct MovieClip;
52 struct Main;
53 struct RigidBodyWorld;
54
55 void BKE_object_workob_clear(struct Object *workob);
56 void BKE_object_workob_calc_parent(struct Scene *scene, struct Object *ob, struct Object *workob);
57
58 void BKE_object_transform_copy(struct Object *ob_tar, const struct Object *ob_src);
59 struct SoftBody *copy_softbody(struct SoftBody *sb, int copy_caches);
60 struct BulletSoftBody *copy_bulletsoftbody(struct BulletSoftBody *sb);
61 void BKE_object_copy_particlesystems(struct Object *obn, struct Object *ob);
62 void BKE_object_copy_softbody(struct Object *obn, struct Object *ob);
63 void BKE_object_free_particlesystems(struct Object *ob);
64 void BKE_object_free_softbody(struct Object *ob);
65 void BKE_object_free_bulletsoftbody(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
71 bool BKE_object_support_modifier_type_check(struct Object *ob, int modifier_type);
72
73 void BKE_object_link_modifiers(struct Object *ob, struct Object *from);
74 void BKE_object_free_modifiers(struct Object *ob);
75
76 void BKE_object_make_proxy(struct Object *ob, struct Object *target, struct Object *gob);
77 void BKE_object_copy_proxy_drivers(struct Object *ob, struct Object *target);
78
79 void BKE_object_unlink(struct Object *ob);
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
85 struct Object *BKE_object_add_only_object(struct Main *bmain, int type, const char *name);
86 struct Object *BKE_object_add(struct Main *bmain, struct Scene *scene, int type);
87 void *BKE_object_obdata_add_from_type(struct Main *bmain, int type);
88
89 struct Object *BKE_object_copy_ex(struct Main *bmain, struct Object *ob, int copy_caches);
90 struct Object *BKE_object_copy(struct Object *ob);
91 void BKE_object_make_local(struct Object *ob);
92 bool BKE_object_is_libdata(struct Object *ob);
93 bool BKE_object_obdata_is_libdata(struct Object *ob);
94
95 void BKE_object_scale_to_mat3(struct Object *ob, float mat[3][3]);
96 void BKE_object_rot_to_mat3(struct Object *ob, float mat[3][3], bool use_drot);
97 void BKE_object_mat3_to_rot(struct Object *ob, float mat[3][3], bool use_compat);
98 void BKE_object_to_mat3(struct Object *ob, float mat[3][3]);
99 void BKE_object_to_mat4(struct Object *ob, float mat[4][4]);
100 void BKE_object_apply_mat4(struct Object *ob, float mat[4][4], const bool use_compat, const bool use_parent);
101
102 bool BKE_object_pose_context_check(struct Object *ob);
103 struct Object *BKE_object_pose_armature_get(struct Object *ob);
104
105 void BKE_object_where_is_calc(struct Scene *scene, struct Object *ob);
106 void BKE_object_where_is_calc_ex(struct Scene *scene, struct RigidBodyWorld *rbw, struct Object *ob);
107 void BKE_object_where_is_calc_time(struct Scene *scene, struct Object *ob, float ctime);
108 void BKE_object_where_is_calc_time_ex(struct Scene *scene, struct Object *ob, float ctime,
109                                       struct RigidBodyWorld *rbw);
110 void BKE_object_where_is_calc_simul(struct Scene *scene, struct Object *ob);
111 void BKE_object_where_is_calc_mat4(struct Scene *scene, struct Object *ob, float obmat[4][4]);
112
113 /* possibly belong in own moduke? */
114 struct BoundBox *BKE_boundbox_alloc_unit(void);
115 void BKE_boundbox_init_from_minmax(struct BoundBox *bb, const float min[3], const float max[3]);
116 bool BKE_boundbox_ray_hit_check(struct BoundBox *bb, const float ray_start[3], const float ray_normal[3]);
117
118 struct BoundBox *BKE_object_boundbox_get(struct Object *ob);
119 void BKE_object_dimensions_get(struct Object *ob, float vec[3]);
120 void BKE_object_dimensions_set(struct Object *ob, const float *value);
121 void BKE_object_boundbox_flag(struct Object *ob, int flag, int set);
122 void BKE_object_minmax(struct Object *ob, float r_min[3], float r_max[3], const bool use_hidden);
123 bool BKE_object_minmax_dupli(struct Scene *scene, struct Object *ob, float r_min[3], float r_max[3], const bool use_hidden);
124
125 /* sometimes min-max isn't enough, we need to loop over each point */
126 void BKE_object_foreach_display_point(struct Object *ob, float obmat[4][4],
127                                       void (*func_cb)(const float[3], void *), void *user_data);
128 void BKE_scene_foreach_display_point(struct Scene *scene,
129                                      struct View3D *v3d,
130                                      const short flag,
131                                      void (*func_cb)(const float[3], void *), void *user_data);
132
133 bool BKE_object_parent_loop_check(const struct Object *parent, const struct Object *ob);
134
135 void *BKE_object_tfm_backup(struct Object *ob);
136 void  BKE_object_tfm_restore(struct Object *ob, void *obtfm_pt);
137
138 typedef struct ObjectTfmProtectedChannels {
139         float loc[3],     dloc[3];
140         float size[3],    dscale[3];
141         float rot[3],     drot[3];
142         float quat[4],    dquat[4];
143         float rotAxis[3], drotAxis[3];
144         float rotAngle,   drotAngle;
145 } ObjectTfmProtectedChannels;
146
147 void BKE_object_tfm_protected_backup(const struct Object *ob,
148                                      ObjectTfmProtectedChannels *obtfm);
149
150 void BKE_object_tfm_protected_restore(struct Object *ob,
151                                       const ObjectTfmProtectedChannels *obtfm,
152                                       const short protectflag);
153
154 void BKE_object_handle_update(struct Scene *scene, struct Object *ob);
155 void BKE_object_handle_update_ex(struct Scene *scene, struct Object *ob,
156                                  struct RigidBodyWorld *rbw);
157 void BKE_object_sculpt_modifiers_changed(struct Object *ob);
158
159 int BKE_object_obdata_texspace_get(struct Object *ob, short **r_texflag, float **r_loc, float **r_size, float **r_rot);
160
161 int BKE_object_insert_ptcache(struct Object *ob);
162 // void object_delete_ptcache(struct Object *ob, int index);
163 struct KeyBlock *BKE_object_insert_shape_key(struct Scene *scene, struct Object *ob, const char *name, int from_mix);
164
165 bool BKE_object_is_child_recursive(struct Object *ob_parent, struct Object *ob_child);
166 bool BKE_object_is_animated(struct Scene *scene, struct Object *ob);
167
168 /* return ModifierMode flag */
169 int BKE_object_is_modified(struct Scene *scene, struct Object *ob);
170 int BKE_object_is_deform_modified(struct Scene *scene, struct Object *ob);
171
172 void BKE_object_relink(struct Object *ob);
173
174 struct MovieClip *BKE_object_movieclip_get(struct Scene *scene, struct Object *ob, int use_default);
175
176 /* this function returns a superset of the scenes selection based on relationships */
177
178 typedef enum eObRelationTypes {
179         OB_REL_NONE               = 0,        /* just the selection as is */
180         OB_REL_PARENT             = (1 << 0), /* immediate parent */
181         OB_REL_PARENT_RECURSIVE   = (1 << 1), /* parents up to root of selection tree*/
182         OB_REL_CHILDREN           = (1 << 2), /* immediate children */
183         OB_REL_CHILDREN_RECURSIVE = (1 << 3), /* All children */
184         OB_REL_MOD_ARMATURE       = (1 << 4), /* Armatures related to the selected objects */
185         OB_REL_SCENE_CAMERA       = (1 << 5), /* you might want the scene camera too even if unselected? */
186 } eObRelationTypes;
187
188 typedef enum eObjectSet {
189         OB_SET_SELECTED, /* Selected Objects */
190         OB_SET_VISIBLE,  /* Visible Objects  */
191         OB_SET_ALL       /* All Objects      */
192 } eObjectSet;
193
194 struct LinkNode *BKE_object_relational_superset(struct Scene *scene, eObjectSet objectSet, eObRelationTypes includeFilter);
195 struct LinkNode *BKE_object_groups(struct Object *ob);
196 void             BKE_object_groups_clear(struct Scene *scene, struct Base *base, struct Object *object);
197
198 #ifdef __cplusplus
199 }
200 #endif
201
202 #endif