4e3526fac7dedcec587c80a6ca03efb7be30e55a
[blender.git] / source / blender / editors / include / ED_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) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file ED_object.h
28  *  \ingroup editors
29  */
30
31 #ifndef __ED_OBJECT_H__
32 #define __ED_OBJECT_H__
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 struct BMEdge;
39 struct BMFace;
40 struct BMVert;
41 struct BPoint;
42 struct Base;
43 struct BezTriple;
44 struct Curve;
45 struct EditBone;
46 struct EnumPropertyItem;
47 struct ID;
48 struct KeyBlock;
49 struct Lattice;
50 struct Main;
51 struct Mesh;
52 struct MetaElem;
53 struct ModifierData;
54 struct HookModifierData;
55 struct Nurb;
56 struct Object;
57 struct ReportList;
58 struct Scene;
59 struct View3D;
60 struct ViewContext;
61 struct bConstraint;
62 struct bContext;
63 struct bPoseChannel;
64 struct wmEvent;
65 struct wmKeyConfig;
66 struct wmKeyMap;
67 struct wmOperator;
68 struct wmOperatorType;
69 struct PointerRNA;
70 struct PropertyRNA;
71 struct EnumPropertyItem;
72
73 /* object_edit.c */
74 struct Object *ED_object_context(struct bContext *C);               /* context.object */
75 struct Object *ED_object_active_context(struct bContext *C); /* context.object or context.active_object */
76
77 /* object_ops.c */
78 void ED_operatortypes_object(void);
79 void ED_operatormacros_object(void);
80 void ED_keymap_object(struct wmKeyConfig *keyconf);
81
82 /* object_relations.c */
83 typedef enum eParentType {
84         PAR_OBJECT,
85         PAR_ARMATURE,
86         PAR_ARMATURE_NAME,
87         PAR_ARMATURE_ENVELOPE,
88         PAR_ARMATURE_AUTO,
89         PAR_BONE,
90         PAR_BONE_RELATIVE,
91         PAR_CURVE,
92         PAR_FOLLOW,
93         PAR_PATH_CONST,
94         PAR_LATTICE,
95         PAR_VERTEX,
96         PAR_VERTEX_TRI
97 } eParentType;
98
99 #ifdef __RNA_TYPES_H__
100 extern struct EnumPropertyItem prop_clear_parent_types[];
101 extern struct EnumPropertyItem prop_make_parent_types[];
102 #endif
103
104 int ED_object_parent_set(struct ReportList *reports, struct Main *bmain, struct Scene *scene, struct Object *ob,
105                          struct Object *par, int partype, bool xmirror, bool keep_transform, const int vert_par[3]);
106 void ED_object_parent_clear(struct Object *ob, int type);
107 struct Base *ED_object_scene_link(struct Scene *scene, struct Object *ob);
108
109 void ED_keymap_proportional_cycle(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap);
110 void ED_keymap_proportional_obmode(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap);
111 void ED_keymap_proportional_maskmode(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap);
112 void ED_keymap_proportional_editmode(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap,
113                                      const short do_connected);
114
115 /* send your own notifier for select! */
116 void ED_base_object_select(struct Base *base, short mode);
117 /* includes notifier */
118 void ED_base_object_activate(struct bContext *C, struct Base *base);
119
120 void ED_base_object_free_and_unlink(struct Main *bmain, struct Scene *scene, struct Base *base);
121
122 /* single object duplicate, if (dupflag == 0), fully linked, else it uses the flags given */
123 struct Base *ED_object_add_duplicate(struct Main *bmain, struct Scene *scene, struct Base *base, int dupflag);
124
125 void ED_object_parent(struct Object *ob, struct Object *parent, int type, const char *substr);
126
127 bool ED_object_mode_compat_set(struct bContext *C, struct Object *ob, int mode, struct ReportList *reports);
128 void ED_object_toggle_modes(struct bContext *C, int mode);
129
130 /* bitflags for enter/exit editmode */
131 #define EM_FREEDATA     1
132 #define EM_FREEUNDO     2
133 #define EM_WAITCURSOR   4
134 #define EM_DO_UNDO      8
135 #define EM_IGNORE_LAYER 16
136 void ED_object_editmode_exit(struct bContext *C, int flag);
137 void ED_object_editmode_enter(struct bContext *C, int flag);
138 bool ED_object_editmode_load(struct Object *obedit);
139
140 void ED_object_location_from_view(struct bContext *C, float loc[3]);
141 void ED_object_rotation_from_view(struct bContext *C, float rot[3], const char align_axis);
142 void ED_object_base_init_transform(struct bContext *C, struct Base *base, const float loc[3], const float rot[3]);
143 float ED_object_new_primitive_matrix(struct bContext *C, struct Object *editob,
144                                      const float loc[3], const float rot[3], float primmat[4][4],
145                                      bool apply_diameter);
146
147 void ED_object_add_unit_props(struct wmOperatorType *ot);
148 void ED_object_add_generic_props(struct wmOperatorType *ot, bool do_editmode);
149 bool ED_object_add_generic_get_opts(struct bContext *C, struct wmOperator *op, const char view_align_axis,
150                                     float loc[3], float rot[3],
151                                     bool *enter_editmode, unsigned int *layer, bool *is_view_aligned);
152
153 struct Object *ED_object_add_type(struct bContext *C, int type, const float loc[3], const float rot[3],
154                                   bool enter_editmode, unsigned int layer);
155
156 void ED_object_single_users(struct Main *bmain, struct Scene *scene, bool full, bool copy_groups);
157 void ED_object_single_user(struct Main *bmain, struct Scene *scene, struct Object *ob);
158
159 /* object motion paths */
160 void ED_objects_clear_paths(struct bContext *C);
161 void ED_objects_recalculate_paths(struct bContext *C, struct Scene *scene);
162
163 /* constraints */
164 struct ListBase *get_active_constraints(struct Object *ob);
165 struct ListBase *get_constraint_lb(struct Object *ob, struct bConstraint *con, struct bPoseChannel **r_pchan);
166 struct bConstraint *get_active_constraint(struct Object *ob);
167
168 void object_test_constraints(struct Object *ob);
169
170 void ED_object_constraint_set_active(struct Object *ob, struct bConstraint *con);
171 void ED_object_constraint_update(struct Object *ob);
172 void ED_object_constraint_dependency_update(struct Main *bmain, struct Object *ob);
173
174 /* object_lattice.c */
175 bool mouse_lattice(struct bContext *C, const int mval[2], bool extend, bool deselect, bool toggle);
176 void undo_push_lattice(struct bContext *C, const char *name);
177
178 /* object_lattice.c */
179
180 void ED_setflagsLatt(struct Object *obedit, int flag);
181
182 /* object_modifier.c */
183 enum {
184         MODIFIER_APPLY_DATA = 1,
185         MODIFIER_APPLY_SHAPE
186 };
187
188 struct ModifierData *ED_object_modifier_add(struct ReportList *reports, struct Main *bmain, struct Scene *scene,
189                                             struct Object *ob, const char *name, int type);
190 bool ED_object_modifier_remove(struct ReportList *reports, struct Main *bmain,
191                                struct Object *ob, struct ModifierData *md);
192 void ED_object_modifier_clear(struct Main *bmain, struct Object *ob);
193 int ED_object_modifier_move_down(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
194 int ED_object_modifier_move_up(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
195 int ED_object_modifier_convert(struct ReportList *reports, struct Main *bmain, struct Scene *scene,
196                                struct Object *ob, struct ModifierData *md);
197 int ED_object_modifier_apply(struct ReportList *reports, struct Scene *scene,
198                              struct Object *ob, struct ModifierData *md, int mode);
199 int ED_object_modifier_copy(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
200
201 bool ED_object_iter_other(struct Main *bmain, struct Object *orig_ob, const bool include_orig,
202                           bool (*callback)(struct Object *ob, void *callback_data),
203                           void *callback_data);
204
205 bool ED_object_multires_update_totlevels_cb(struct Object *ob, void *totlevel_v);
206
207 /* object_select.c */
208 void ED_object_select_linked_by_id(struct bContext *C, struct ID *id);
209
210
211 bool *ED_vgroup_subset_from_select_type(struct Object *ob, enum eVGroupSelect subset_type,
212                                         int *r_vgroup_tot, int *r_subset_count);
213 void ED_vgroup_subset_to_index_array(const bool *vgroup_validmap, const int vgroup_tot,
214                                      int *r_vgroup_subset_map);
215
216 struct EnumPropertyItem *ED_object_vgroup_selection_itemf_helper(
217         const struct bContext *C,
218         struct PointerRNA *ptr,
219         struct PropertyRNA *prop,
220         bool *r_free,
221         const unsigned int selection_mask);
222
223 void ED_object_check_force_modifiers(struct Main *bmain, struct Scene *scene, struct Object *object);
224
225 #ifdef __cplusplus
226 }
227 #endif
228
229 #endif /* __ED_OBJECT_H__ */