remove nan copyrights from code added since blender become opensource (copy paste...
[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 Scene;
38 struct Object;
39 struct Camera;
40 struct BoundBox;
41 struct View3D;
42 struct SoftBody;
43 struct BulletSoftBody;
44 struct Group;
45 struct bAction;
46 struct RenderData;
47 struct rctf;
48 struct MovieClip;
49 struct Main;
50 struct RigidBodyWorld;
51
52 void BKE_object_workob_clear(struct Object *workob);
53 void BKE_object_workob_calc_parent(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(struct SoftBody *sb, int copy_caches);
57 struct BulletSoftBody *copy_bulletsoftbody(struct BulletSoftBody *sb);
58 void BKE_object_copy_particlesystems(struct Object *obn, struct Object *ob);
59 void BKE_object_copy_softbody(struct Object *obn, struct Object *ob);
60 void BKE_object_free_particlesystems(struct Object *ob);
61 void BKE_object_free_softbody(struct Object *ob);
62 void BKE_object_free_bulletsoftbody(struct Object *ob);
63 void BKE_object_update_base_layer(struct Scene *scene, struct Object *ob);
64
65 void BKE_object_free(struct Object *ob);
66 void BKE_object_free_derived_caches(struct Object *ob);
67
68 bool BKE_object_support_modifier_type_check(struct Object *ob, int modifier_type);
69
70 void BKE_object_link_modifiers(struct Object *ob, struct Object *from);
71 void BKE_object_free_modifiers(struct Object *ob);
72
73 void BKE_object_make_proxy(struct Object *ob, struct Object *target, struct Object *gob);
74 void BKE_object_copy_proxy_drivers(struct Object *ob, struct Object *target);
75
76 void BKE_object_unlink(struct Object *ob);
77 bool BKE_object_exists_check(struct Object *obtest);
78 bool BKE_object_is_in_editmode(struct Object *ob);
79 bool BKE_object_is_in_editmode_vgroup(struct Object *ob);
80 bool BKE_object_is_in_wpaint_select_vert(struct Object *ob);
81
82 struct Object *BKE_object_add_only_object(struct Main *bmain, int type, const char *name);
83 struct Object *BKE_object_add(struct Main *bmain, struct Scene *scene, int type);
84 void *BKE_object_obdata_add_from_type(struct Main *bmain, int type);
85
86 struct Object *BKE_object_copy_ex(struct Main *bmain, struct Object *ob, int copy_caches);
87 struct Object *BKE_object_copy(struct Object *ob);
88 void BKE_object_make_local(struct Object *ob);
89 bool BKE_object_is_libdata(struct Object *ob);
90 bool BKE_object_obdata_is_libdata(struct Object *ob);
91
92 void BKE_object_scale_to_mat3(struct Object *ob, float mat[3][3]);
93 void BKE_object_rot_to_mat3(struct Object *ob, float mat[3][3], bool use_drot);
94 void BKE_object_mat3_to_rot(struct Object *ob, float mat[3][3], bool use_compat);
95 void BKE_object_to_mat3(struct Object *ob, float mat[3][3]);
96 void BKE_object_to_mat4(struct Object *ob, float mat[4][4]);
97 void BKE_object_apply_mat4(struct Object *ob, float mat[4][4], const bool use_compat, const bool use_parent);
98
99 bool BKE_object_pose_context_check(struct Object *ob);
100 struct Object *BKE_object_pose_armature_get(struct Object *ob);
101
102 void BKE_object_where_is_calc(struct Scene *scene, struct Object *ob);
103 void BKE_object_where_is_calc_ex(struct Scene *scene, struct RigidBodyWorld *rbw, struct Object *ob);
104 void BKE_object_where_is_calc_time(struct Scene *scene, struct Object *ob, float ctime);
105 void BKE_object_where_is_calc_time_ex(struct Scene *scene, struct Object *ob, float ctime,
106                                       struct RigidBodyWorld *rbw);
107 void BKE_object_where_is_calc_simul(struct Scene *scene, struct Object *ob);
108 void BKE_object_where_is_calc_mat4(struct Scene *scene, struct Object *ob, float obmat[4][4]);
109
110 /* possibly belong in own moduke? */
111 struct BoundBox *BKE_boundbox_alloc_unit(void);
112 void BKE_boundbox_init_from_minmax(struct BoundBox *bb, const float min[3], const float max[3]);
113 bool BKE_boundbox_ray_hit_check(struct BoundBox *bb, const float ray_start[3], const float ray_normal[3]);
114
115 struct BoundBox *BKE_object_boundbox_get(struct Object *ob);
116 void BKE_object_dimensions_get(struct Object *ob, float vec[3]);
117 void BKE_object_dimensions_set(struct Object *ob, const float *value);
118 void BKE_object_boundbox_flag(struct Object *ob, int flag, int set);
119 void BKE_object_minmax(struct Object *ob, float r_min[3], float r_max[3], const bool use_hidden);
120 bool BKE_object_minmax_dupli(struct Scene *scene, struct Object *ob, float r_min[3], float r_max[3], const bool use_hidden);
121
122 /* sometimes min-max isn't enough, we need to loop over each point */
123 void BKE_object_foreach_display_point(struct Object *ob, float obmat[4][4],
124                                       void (*func_cb)(const float[3], void *), void *user_data);
125 void BKE_scene_foreach_display_point(struct Scene *scene,
126                                      struct View3D *v3d,
127                                      const short flag,
128                                      void (*func_cb)(const float[3], void *), void *user_data);
129
130 bool BKE_object_parent_loop_check(const struct Object *parent, const struct Object *ob);
131
132 void *BKE_object_tfm_backup(struct Object *ob);
133 void  BKE_object_tfm_restore(struct Object *ob, void *obtfm_pt);
134
135 typedef struct ObjectTfmProtectedChannels {
136         float loc[3],     dloc[3];
137         float size[3],    dscale[3];
138         float rot[3],     drot[3];
139         float quat[4],    dquat[4];
140         float rotAxis[3], drotAxis[3];
141         float rotAngle,   drotAngle;
142 } ObjectTfmProtectedChannels;
143
144 void BKE_object_tfm_protected_backup(const struct Object *ob,
145                                      ObjectTfmProtectedChannels *obtfm);
146
147 void BKE_object_tfm_protected_restore(struct Object *ob,
148                                       const ObjectTfmProtectedChannels *obtfm,
149                                       const short protectflag);
150
151 void BKE_object_handle_update(struct Scene *scene, struct Object *ob);
152 void BKE_object_handle_update_ex(struct Scene *scene, struct Object *ob,
153                                  struct RigidBodyWorld *rbw);
154 void BKE_object_sculpt_modifiers_changed(struct Object *ob);
155
156 int BKE_object_obdata_texspace_get(struct Object *ob, short **r_texflag, float **r_loc, float **r_size, float **r_rot);
157
158 int BKE_object_insert_ptcache(struct Object *ob);
159 // void object_delete_ptcache(struct Object *ob, int index);
160 struct KeyBlock *BKE_object_insert_shape_key(struct Scene *scene, struct Object *ob, const char *name, int from_mix);
161
162 bool BKE_object_is_child_recursive(struct Object *ob_parent, struct Object *ob_child);
163 bool BKE_object_is_animated(struct Scene *scene, struct Object *ob);
164
165 /* return ModifierMode flag */
166 int BKE_object_is_modified(struct Scene *scene, struct Object *ob);
167 int BKE_object_is_deform_modified(struct Scene *scene, struct Object *ob);
168
169 void BKE_object_relink(struct Object *ob);
170
171 struct MovieClip *BKE_object_movieclip_get(struct Scene *scene, struct Object *ob, int use_default);
172
173 /* this function returns a superset of the scenes selection based on relationships */
174
175 typedef enum eObRelationTypes {
176         OB_REL_NONE               = 0,        /* just the selection as is */
177         OB_REL_PARENT             = (1 << 0), /* immediate parent */
178         OB_REL_PARENT_RECURSIVE   = (1 << 1), /* parents up to root of selection tree*/
179         OB_REL_CHILDREN           = (1 << 2), /* immediate children */
180         OB_REL_CHILDREN_RECURSIVE = (1 << 3), /* All children */
181         OB_REL_MOD_ARMATURE       = (1 << 4), /* Armatures related to the selected objects */
182         OB_REL_SCENE_CAMERA       = (1 << 5), /* you might want the scene camera too even if unselected? */
183 } eObRelationTypes;
184
185 typedef enum eObjectSet {
186         OB_SET_SELECTED, /* Selected Objects */
187         OB_SET_VISIBLE,  /* Visible Objects  */
188         OB_SET_ALL       /* All Objects      */
189 } eObjectSet;
190
191 struct LinkNode *BKE_object_relational_superset(struct Scene *scene, eObjectSet objectSet, eObRelationTypes includeFilter);
192 struct LinkNode *BKE_object_groups(struct Object *ob);
193 void             BKE_object_groups_clear(struct Scene *scene, struct Base *base, struct Object *object);
194
195 #ifdef __cplusplus
196 }
197 #endif
198
199 #endif