svn merge -r41779:41847 ^/trunk/blender
[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 void object_link_modifiers(struct Object *ob, struct Object *from);
71 void object_free_modifiers(struct Object *ob);
72
73 void object_make_proxy(struct Object *ob, struct Object *target, struct Object *gob);
74 void object_copy_proxy_drivers(struct Object *ob, struct Object *target);
75
76 void unlink_object(struct Object *ob);
77 int exist_object(struct Object *obtest);
78         
79 struct Object *add_only_object(int type, const char *name);
80 struct Object *add_object(struct Scene *scene, int type);
81
82 struct Object *copy_object(struct Object *ob);
83 void make_local_object(struct Object *ob);
84 int object_is_libdata(struct Object *ob);
85 int object_data_is_libdata(struct Object *ob);
86 void set_mblur_offs(float blur);
87 void set_field_offs(float field);
88 void disable_speed_curve(int val);
89
90 void object_scale_to_mat3(struct Object *ob, float mat[][3]);
91 void object_rot_to_mat3(struct Object *ob, float mat[][3]);
92 void object_mat3_to_rot(struct Object *ob, float mat[][3], short use_compat);
93 void object_to_mat3(struct Object *ob, float mat[][3]);
94 void object_to_mat4(struct Object *ob, float mat[][4]);
95 void object_apply_mat4(struct Object *ob, float mat[][4], const short use_compat, const short use_parent);
96
97 void set_no_parent_ipo(int val);
98 struct Object *object_pose_armature_get(struct Object *ob);
99
100 void where_is_object_time(struct Scene *scene, struct Object *ob, float ctime);
101 void where_is_object(struct Scene *scene, struct Object *ob);
102 void where_is_object_simul(struct Scene *scene, struct Object *ob);
103 void where_is_object_mat(struct Scene *scene, struct Object *ob, float obmat[4][4]);
104
105 struct BoundBox *unit_boundbox(void);
106 void boundbox_set_from_min_max(struct BoundBox *bb, float min[3], float max[3]);
107 struct BoundBox *object_get_boundbox(struct Object *ob);
108 void object_get_dimensions(struct Object *ob, float *value);
109 void object_set_dimensions(struct Object *ob, const float *value);
110 void object_boundbox_flag(struct Object *ob, int flag, int set);
111 void minmax_object(struct Object *ob, float min[3], float max[3]);
112 int minmax_object_duplis(struct Scene *scene, struct Object *ob, float *min, float *max);
113
114 /* sometimes min-max isnt enough, we need to loop over each point */
115 void BKE_object_foreach_display_point(
116         struct Object *ob, float obmat[4][4],
117         void (*func_cb)(const float[3], void *), void *user_data);
118 void BKE_scene_foreach_display_point(
119         struct Scene *scene,
120         struct View3D *v3d,
121         const short flag,
122         void (*func_cb)(const float[3], void *), void *user_data);
123
124 void solve_tracking (struct Object *ob, float targetmat[][4]);
125 int ray_hit_boundbox(struct BoundBox *bb, float ray_start[3], float ray_normal[3]);
126
127 void *object_tfm_backup(struct Object *ob);
128 void object_tfm_restore(struct Object *ob, void *obtfm_pt);
129
130 typedef struct ObjectTfmProtectedChannels {
131         float loc[3],     dloc[3];
132         float size[3],    dsize[3];
133         float rot[3],     drot[3];
134         float quat[4],    dquat[4];
135         float rotAxis[3], drotAxis[3];
136         float rotAngle,   drotAngle;
137 } ObjectTfmProtectedChannels;
138
139 void object_tfm_protected_backup(const struct Object *ob,
140                                  ObjectTfmProtectedChannels *obtfm);
141
142 void object_tfm_protected_restore(struct Object *ob,
143                                   const ObjectTfmProtectedChannels *obtfm,
144                                   const short protectflag);
145
146 void object_handle_update(struct Scene *scene, struct Object *ob);
147 void object_sculpt_modifiers_changed(struct Object *ob);
148
149 int give_obdata_texspace(struct Object *ob, short **texflag, float **loc, float **size, float **rot);
150
151 int object_insert_ptcache(struct Object *ob);
152 // void object_delete_ptcache(struct Object *ob, int index);
153 struct KeyBlock *object_insert_shape_key(struct Scene *scene, struct Object *ob, const char *name, int from_mix);
154
155 int object_is_modified(struct Scene *scene, struct Object *ob);
156
157 void object_relink(struct Object *ob);
158
159 struct MovieClip *object_get_movieclip(struct Scene *scene, struct Object *ob, int use_default);
160
161 #ifdef __cplusplus
162 }
163 #endif
164
165 #endif