Merging r40653 through r40847 from trunk into soc-2011-tomato
[blender.git] / source / blender / blenkernel / BKE_object.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef BKE_OBJECT_H
31 #define BKE_OBJECT_H
32
33 /** \file BKE_object.h
34  *  \ingroup bke
35  *  \brief General operations, lookup, etc. for blender objects.
36  */
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 struct Base;
42 struct Scene;
43 struct Object;
44 struct Camera;
45 struct BoundBox;
46 struct View3D;
47 struct SoftBody;
48 struct BulletSoftBody;
49 struct Group;
50 struct bAction;
51 struct RenderData;
52 struct rctf;
53 struct MovieClip;
54
55 void clear_workob(struct Object *workob);
56 void what_does_parent(struct Scene *scene, struct Object *ob, struct Object *workob);
57
58 void copy_baseflags(struct Scene *scene);
59 void copy_objectflags(struct Scene *scene);
60 struct SoftBody *copy_softbody(struct SoftBody *sb);
61 struct BulletSoftBody *copy_bulletsoftbody(struct BulletSoftBody *sb);
62 void copy_object_particlesystems(struct Object *obn, struct Object *ob);
63 void copy_object_softbody(struct Object *obn, struct Object *ob);
64 void object_free_particlesystems(struct Object *ob);
65 void object_free_softbody(struct Object *ob);
66 void object_free_bulletsoftbody(struct Object *ob);
67 void update_base_layer(struct Scene *scene, struct Object *ob);
68
69 void free_object(struct Object *ob);
70 void object_free_display(struct Object *ob);
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 void *add_camera(const char *name);
81 struct Camera *copy_camera(struct Camera *cam);
82 void make_local_camera(struct Camera *cam);
83 float dof_camera(struct Object *ob);
84         
85 void *add_lamp(const char *name);
86 struct Lamp *copy_lamp(struct Lamp *la);
87 struct Lamp *localize_lamp(struct Lamp *la);
88 void make_local_lamp(struct Lamp *la);
89 void free_camera(struct Camera *ca);
90 void free_lamp(struct Lamp *la);
91
92 struct Object *add_only_object(int type, const char *name);
93 struct Object *add_object(struct Scene *scene, int type);
94
95 struct Object *copy_object(struct Object *ob);
96 void make_local_object(struct Object *ob);
97 int object_is_libdata(struct Object *ob);
98 int object_data_is_libdata(struct Object *ob);
99 void set_mblur_offs(float blur);
100 void set_field_offs(float field);
101 void disable_speed_curve(int val);
102
103 float bsystem_time(struct Scene *scene, struct Object *ob, float cfra, float ofs);
104 void object_scale_to_mat3(struct Object *ob, float mat[][3]);
105 void object_rot_to_mat3(struct Object *ob, float mat[][3]);
106 void object_mat3_to_rot(struct Object *ob, float mat[][3], short use_compat);
107 void object_to_mat3(struct Object *ob, float mat[][3]);
108 void object_to_mat4(struct Object *ob, float mat[][4]);
109 void object_apply_mat4(struct Object *ob, float mat[][4], const short use_compat, const short use_parent);
110
111 void set_no_parent_ipo(int val);
112 struct Object *object_pose_armature_get(struct Object *ob);
113
114 void where_is_object_time(struct Scene *scene, struct Object *ob, float ctime);
115 void where_is_object(struct Scene *scene, struct Object *ob);
116 void where_is_object_simul(struct Scene *scene, struct Object *ob);
117 void where_is_object_mat(struct Scene *scene, struct Object *ob, float obmat[4][4]);
118
119 struct BoundBox *unit_boundbox(void);
120 void boundbox_set_from_min_max(struct BoundBox *bb, float min[3], float max[3]);
121 struct BoundBox *object_get_boundbox(struct Object *ob);
122 void object_get_dimensions(struct Object *ob, float *value);
123 void object_set_dimensions(struct Object *ob, const float *value);
124 void object_boundbox_flag(struct Object *ob, int flag, int set);
125 void minmax_object(struct Object *ob, float *min, float *max);
126 int minmax_object_duplis(struct Scene *scene, struct Object *ob, float *min, float *max);
127 void solve_tracking (struct Object *ob, float targetmat[][4]);
128 int ray_hit_boundbox(struct BoundBox *bb, float ray_start[3], float ray_normal[3]);
129
130 void *object_tfm_backup(struct Object *ob);
131 void object_tfm_restore(struct Object *ob, void *obtfm_pt);
132
133 void object_handle_update(struct Scene *scene, struct Object *ob);
134 void object_sculpt_modifiers_changed(struct Object *ob);
135
136 float give_timeoffset(struct Object *ob);
137 int give_obdata_texspace(struct Object *ob, short **texflag, float **loc, float **size, float **rot);
138
139 int object_insert_ptcache(struct Object *ob);
140 // void object_delete_ptcache(struct Object *ob, int index);
141 struct KeyBlock *object_insert_shape_key(struct Scene *scene, struct Object *ob, const char *name, int from_mix);
142
143 int object_is_modified(struct Scene *scene, struct Object *ob);
144
145 void object_camera_mode(struct RenderData *rd, struct Object *camera);
146 void object_camera_matrix(
147                 struct RenderData *rd, struct Object *camera, int winx, int winy, short field_second,
148                 float winmat[][4], struct rctf *viewplane, float *clipsta, float *clipend, float *lens, float *sensor_x, float *ycor,
149                 float *viewdx, float *viewdy);
150
151 void camera_view_frame_ex(struct Scene *scene, struct Camera *camera, float drawsize, const short do_clip, const float scale[3],
152                           float r_asp[2], float r_shift[2], float *r_drawsize, float r_vec[4][3]);
153
154 void camera_view_frame(struct Scene *scene, struct Camera *camera, float r_vec[4][3]);
155
156 void object_relink(struct Object *ob);
157
158 struct MovieClip *object_get_movieclip(struct Scene *scene, struct Object *ob);
159
160 #ifdef __cplusplus
161 }
162 #endif
163
164 #endif