- UNUSED macro wasn't throwing an error with GCC if a var become used.
[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  * General operations, lookup, etc. for blender objects.
29  */
30
31 #ifndef BKE_OBJECT_H
32 #define BKE_OBJECT_H
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 struct Base;
39 struct Scene;
40 struct Object;
41 struct Camera;
42 struct BoundBox;
43 struct View3D;
44 struct SoftBody;
45 struct BulletSoftBody;
46 struct Group;
47 struct bAction;
48 struct RenderData;
49 struct rctf;
50
51 void clear_workob(struct Object *workob);
52 void what_does_parent(struct Scene *scene, struct Object *ob, struct Object *workob);
53
54 void copy_baseflags(struct Scene *scene);
55 void copy_objectflags(struct Scene *scene);
56 struct SoftBody *copy_softbody(struct SoftBody *sb);
57 struct BulletSoftBody *copy_bulletsoftbody(struct BulletSoftBody *sb);
58 void copy_object_particlesystems(struct Object *obn, struct Object *ob);
59 void copy_object_softbody(struct Object *obn, struct Object *ob);
60 void object_free_particlesystems(struct Object *ob);
61 void object_free_softbody(struct Object *ob);
62 void object_free_bulletsoftbody(struct Object *ob);
63 void update_base_layer(struct Scene *scene, struct Object *ob);
64
65 void free_object(struct Object *ob);
66 void object_free_display(struct Object *ob);
67
68 void object_link_modifiers(struct Object *ob, struct Object *from);
69 void object_free_modifiers(struct Object *ob);
70
71 void object_make_proxy(struct Object *ob, struct Object *target, struct Object *gob);
72 void object_copy_proxy_drivers(struct Object *ob, struct Object *target);
73
74 void unlink_object(struct Scene *scene, struct Object *ob);
75 int exist_object(struct Object *obtest);
76 void *add_camera(char *name);
77 struct Camera *copy_camera(struct Camera *cam);
78 void make_local_camera(struct Camera *cam);
79 float dof_camera(struct Object *ob);
80         
81 void *add_lamp(char *name);
82 struct Lamp *copy_lamp(struct Lamp *la);
83 void make_local_lamp(struct Lamp *la);
84 void free_camera(struct Camera *ca);
85 void free_lamp(struct Lamp *la);
86
87 struct Object *add_only_object(int type, char *name);
88 struct Object *add_object(struct Scene *scene, int type);
89
90 struct Object *copy_object(struct Object *ob);
91 void expand_local_object(struct Object *ob);
92 void make_local_object(struct Object *ob);
93 int object_data_is_libdata(struct Object *ob);
94 void set_mblur_offs(float blur);
95 void set_field_offs(float field);
96 void disable_speed_curve(int val);
97
98 float bsystem_time(struct Scene *scene, struct Object *ob, float cfra, float ofs);
99 void object_scale_to_mat3(struct Object *ob, float mat[][3]);
100 void object_rot_to_mat3(struct Object *ob, float mat[][3]);
101 void object_mat3_to_rot(struct Object *ob, float mat[][3], int use_compat);
102 void object_to_mat3(struct Object *ob, float mat[][3]);
103 void object_to_mat4(struct Object *ob, float mat[][4]);
104 void object_apply_mat4(struct Object *ob, float mat[][4]);
105
106 void set_no_parent_ipo(int val);
107
108 void where_is_object_time(struct Scene *scene, struct Object *ob, float ctime);
109 void where_is_object(struct Scene *scene, struct Object *ob);
110 void where_is_object_simul(struct Scene *scene, struct Object *ob);
111
112 struct BoundBox *unit_boundbox(void);
113 void boundbox_set_from_min_max(struct BoundBox *bb, float min[3], float max[3]);
114 struct BoundBox *object_get_boundbox(struct Object *ob);
115 void object_get_dimensions(struct Object *ob, float *value);
116 void object_set_dimensions(struct Object *ob, const float *value);
117 void object_boundbox_flag(struct Object *ob, int flag, int set);
118 void minmax_object(struct Object *ob, float *min, float *max);
119 int minmax_object_duplis(struct Scene *scene, struct Object *ob, float *min, float *max);
120 void solve_tracking (struct Object *ob, float targetmat[][4]);
121 int ray_hit_boundbox(struct BoundBox *bb, float ray_start[3], float ray_normal[3]);
122
123 void *object_tfm_backup(struct Object *ob);
124 void object_tfm_restore(struct Object *ob, void *obtfm_pt);
125
126 void object_handle_update(struct Scene *scene, struct Object *ob);
127
128 float give_timeoffset(struct Object *ob);
129 int give_obdata_texspace(struct Object *ob, short **texflag, float **loc, float **size, float **rot);
130
131 int object_insert_ptcache(struct Object *ob);
132 // void object_delete_ptcache(struct Object *ob, int index);
133 struct KeyBlock *object_insert_shape_key(struct Scene *scene, struct Object *ob, char *name, int from_mix);
134
135 void object_camera_matrix(
136                 struct RenderData *rd, struct Object *camera, int winx, int winy, short field_second,
137                 float winmat[][4], struct rctf *viewplane, float *clipsta, float *clipend, float *lens, float *ycor,
138                 float *viewdx, float *viewdy);
139
140 #ifdef __cplusplus
141 }
142 #endif
143
144 #endif