Merging r38898 through r38940 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
54 void clear_workob(struct Object *workob);
55 void what_does_parent(struct Scene *scene, struct Object *ob, struct Object *workob);
56
57 void copy_baseflags(struct Scene *scene);
58 void copy_objectflags(struct Scene *scene);
59 struct SoftBody *copy_softbody(struct SoftBody *sb);
60 struct BulletSoftBody *copy_bulletsoftbody(struct BulletSoftBody *sb);
61 void copy_object_particlesystems(struct Object *obn, struct Object *ob);
62 void copy_object_softbody(struct Object *obn, struct Object *ob);
63 void object_free_particlesystems(struct Object *ob);
64 void object_free_softbody(struct Object *ob);
65 void object_free_bulletsoftbody(struct Object *ob);
66 void update_base_layer(struct Scene *scene, struct Object *ob);
67
68 void free_object(struct Object *ob);
69 void object_free_display(struct Object *ob);
70
71 void object_link_modifiers(struct Object *ob, struct Object *from);
72 void object_free_modifiers(struct Object *ob);
73
74 void object_make_proxy(struct Object *ob, struct Object *target, struct Object *gob);
75 void object_copy_proxy_drivers(struct Object *ob, struct Object *target);
76
77 void unlink_object(struct Object *ob);
78 int exist_object(struct Object *obtest);
79 void *add_camera(const char *name);
80 struct Camera *copy_camera(struct Camera *cam);
81 void make_local_camera(struct Camera *cam);
82 float dof_camera(struct Object *ob);
83         
84 void *add_lamp(const char *name);
85 struct Lamp *copy_lamp(struct Lamp *la);
86 struct Lamp *localize_lamp(struct Lamp *la);
87 void make_local_lamp(struct Lamp *la);
88 void free_camera(struct Camera *ca);
89 void free_lamp(struct Lamp *la);
90
91 struct Object *add_only_object(int type, const char *name);
92 struct Object *add_object(struct Scene *scene, int type);
93
94 struct Object *copy_object(struct Object *ob);
95 void make_local_object(struct Object *ob);
96 int object_is_libdata(struct Object *ob);
97 int object_data_is_libdata(struct Object *ob);
98 void set_mblur_offs(float blur);
99 void set_field_offs(float field);
100 void disable_speed_curve(int val);
101
102 float bsystem_time(struct Scene *scene, struct Object *ob, float cfra, float ofs);
103 void object_scale_to_mat3(struct Object *ob, float mat[][3]);
104 void object_rot_to_mat3(struct Object *ob, float mat[][3]);
105 void object_mat3_to_rot(struct Object *ob, float mat[][3], short use_compat);
106 void object_to_mat3(struct Object *ob, float mat[][3]);
107 void object_to_mat4(struct Object *ob, float mat[][4]);
108 void object_apply_mat4(struct Object *ob, float mat[][4], const short use_compat, const short use_parent);
109
110 void set_no_parent_ipo(int val);
111
112 void where_is_object_time(struct Scene *scene, struct Object *ob, float ctime);
113 void where_is_object(struct Scene *scene, struct Object *ob);
114 void where_is_object_simul(struct Scene *scene, struct Object *ob);
115 void where_is_object_mat(struct Scene *scene, struct Object *ob, float obmat[4][4]);
116
117 struct BoundBox *unit_boundbox(void);
118 void boundbox_set_from_min_max(struct BoundBox *bb, float min[3], float max[3]);
119 struct BoundBox *object_get_boundbox(struct Object *ob);
120 void object_get_dimensions(struct Object *ob, float *value);
121 void object_set_dimensions(struct Object *ob, const float *value);
122 void object_boundbox_flag(struct Object *ob, int flag, int set);
123 void minmax_object(struct Object *ob, float *min, float *max);
124 int minmax_object_duplis(struct Scene *scene, struct Object *ob, float *min, float *max);
125 void solve_tracking (struct Object *ob, float targetmat[][4]);
126 int ray_hit_boundbox(struct BoundBox *bb, float ray_start[3], float ray_normal[3]);
127
128 void *object_tfm_backup(struct Object *ob);
129 void object_tfm_restore(struct Object *ob, void *obtfm_pt);
130
131 void object_handle_update(struct Scene *scene, struct Object *ob);
132
133 float give_timeoffset(struct Object *ob);
134 int give_obdata_texspace(struct Object *ob, short **texflag, float **loc, float **size, float **rot);
135
136 int object_insert_ptcache(struct Object *ob);
137 // void object_delete_ptcache(struct Object *ob, int index);
138 struct KeyBlock *object_insert_shape_key(struct Scene *scene, struct Object *ob, const char *name, int from_mix);
139
140 int object_is_modified(struct Scene *scene, struct Object *ob);
141
142 void object_camera_mode(struct RenderData *rd, struct Object *camera);
143 void object_camera_matrix(
144                 struct RenderData *rd, struct Object *camera, int winx, int winy, short field_second,
145                 float winmat[][4], struct rctf *viewplane, float *clipsta, float *clipend, float *lens, float *sensor_x, float *ycor,
146                 float *viewdx, float *viewdy);
147
148 void object_relink(struct Object *ob);
149
150 #ifdef __cplusplus
151 }
152 #endif
153
154 #endif