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