Merging r44227 through r45619 from trunk into soc-2011-tomato
[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
53 void clear_workob(struct Object *workob);
54 void what_does_parent(struct Scene *scene, struct Object *ob, struct Object *workob);
55
56 void copy_baseflags(struct Scene *scene);
57 void copy_objectflags(struct Scene *scene);
58 struct SoftBody *copy_softbody(struct SoftBody *sb);
59 struct BulletSoftBody *copy_bulletsoftbody(struct BulletSoftBody *sb);
60 void copy_object_particlesystems(struct Object *obn, struct Object *ob);
61 void copy_object_softbody(struct Object *obn, struct Object *ob);
62 void object_free_particlesystems(struct Object *ob);
63 void object_free_softbody(struct Object *ob);
64 void object_free_bulletsoftbody(struct Object *ob);
65 void update_base_layer(struct Scene *scene, struct Object *ob);
66
67 void free_object(struct Object *ob);
68 void object_free_display(struct Object *ob);
69
70 int object_support_modifier_type(struct Object *ob, int modifier_type);
71
72 void object_link_modifiers(struct Object *ob, struct Object *from);
73 void object_free_modifiers(struct Object *ob);
74
75 void object_make_proxy(struct Object *ob, struct Object *target, struct Object *gob);
76 void object_copy_proxy_drivers(struct Object *ob, struct Object *target);
77
78 void unlink_object(struct Object *ob);
79 int exist_object(struct Object *obtest);
80         
81 struct Object *add_only_object(int type, const char *name);
82 struct Object *add_object(struct Scene *scene, int type);
83
84 struct Object *copy_object(struct Object *ob);
85 void make_local_object(struct Object *ob);
86 int object_is_libdata(struct Object *ob);
87 int object_data_is_libdata(struct Object *ob);
88
89 void object_scale_to_mat3(struct Object *ob, float mat[][3]);
90 void object_rot_to_mat3(struct Object *ob, float mat[][3]);
91 void object_mat3_to_rot(struct Object *ob, float mat[][3], short use_compat);
92 void object_to_mat3(struct Object *ob, float mat[][3]);
93 void object_to_mat4(struct Object *ob, float mat[][4]);
94 void object_apply_mat4(struct Object *ob, float mat[][4], const short use_compat, const short use_parent);
95
96 struct Object *object_pose_armature_get(struct Object *ob);
97
98 void where_is_object_time(struct Scene *scene, struct Object *ob, float ctime);
99 void where_is_object(struct Scene *scene, struct Object *ob);
100 void where_is_object_simul(struct Scene *scene, struct Object *ob);
101 void where_is_object_mat(struct Scene *scene, struct Object *ob, float obmat[4][4]);
102
103 struct BoundBox *unit_boundbox(void);
104 void boundbox_set_from_min_max(struct BoundBox *bb, float min[3], float max[3]);
105 struct BoundBox *object_get_boundbox(struct Object *ob);
106 void object_get_dimensions(struct Object *ob, float vec[3]);
107 void object_set_dimensions(struct Object *ob, const float *value);
108 void object_boundbox_flag(struct Object *ob, int flag, int set);
109 void minmax_object(struct Object *ob, float min[3], float max[3]);
110 int minmax_object_duplis(struct Scene *scene, struct Object *ob, float min[3], float max[3]);
111
112 /* sometimes min-max isn't enough, we need to loop over each point */
113 void BKE_object_foreach_display_point(
114         struct Object *ob, float obmat[4][4],
115         void (*func_cb)(const float[3], void *), void *user_data);
116 void BKE_scene_foreach_display_point(
117         struct Scene *scene,
118         struct View3D *v3d,
119         const short flag,
120         void (*func_cb)(const float[3], void *), void *user_data);
121
122 int BKE_object_parent_loop_check(const struct Object *parent, const struct Object *ob);
123
124 int ray_hit_boundbox(struct BoundBox *bb, float ray_start[3], float ray_normal[3]);
125
126 void *object_tfm_backup(struct Object *ob);
127 void object_tfm_restore(struct Object *ob, void *obtfm_pt);
128
129 typedef struct ObjectTfmProtectedChannels {
130         float loc[3],     dloc[3];
131         float size[3],    dscale[3];
132         float rot[3],     drot[3];
133         float quat[4],    dquat[4];
134         float rotAxis[3], drotAxis[3];
135         float rotAngle,   drotAngle;
136 } ObjectTfmProtectedChannels;
137
138 void object_tfm_protected_backup(const struct Object *ob,
139                                  ObjectTfmProtectedChannels *obtfm);
140
141 void object_tfm_protected_restore(struct Object *ob,
142                                   const ObjectTfmProtectedChannels *obtfm,
143                                   const short protectflag);
144
145 void object_handle_update(struct Scene *scene, struct Object *ob);
146 void object_sculpt_modifiers_changed(struct Object *ob);
147
148 int give_obdata_texspace(struct Object *ob, short **texflag, float **loc, float **size, float **rot);
149
150 int object_insert_ptcache(struct Object *ob);
151 // void object_delete_ptcache(struct Object *ob, int index);
152 struct KeyBlock *object_insert_shape_key(struct Scene *scene, struct Object *ob, const char *name, int from_mix);
153
154 int object_is_modified(struct Scene *scene, struct Object *ob);
155
156 void object_relink(struct Object *ob);
157
158 struct MovieClip *object_get_movieclip(struct Scene *scene, struct Object *ob, int use_default);
159
160 #ifdef __cplusplus
161 }
162 #endif
163
164 #endif