code cleanup: rename editmode functions so we have ED_object_editmode_load/enter...
[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 Nurb;
55 struct Object;
56 struct ReportList;
57 struct Scene;
58 struct View3D;
59 struct ViewContext;
60 struct bConstraint;
61 struct bContext;
62 struct bPoseChannel;
63 struct wmEvent;
64 struct wmKeyConfig;
65 struct wmKeyMap;
66 struct wmOperator;
67 struct wmOperatorType;
68
69 /* object_edit.c */
70 struct Object *ED_object_context(struct bContext *C);               /* context.object */
71 struct Object *ED_object_active_context(struct bContext *C); /* context.object or context.active_object */
72
73 /* object_ops.c */
74 void ED_operatortypes_object(void);
75 void ED_operatormacros_object(void);
76 void ED_keymap_object(struct wmKeyConfig *keyconf);
77
78 /* object_relations.c */
79 typedef enum eParentType {
80         PAR_OBJECT,
81         PAR_ARMATURE,
82         PAR_ARMATURE_NAME,
83         PAR_ARMATURE_ENVELOPE,
84         PAR_ARMATURE_AUTO,
85         PAR_BONE,
86         PAR_BONE_RELATIVE,
87         PAR_CURVE,
88         PAR_FOLLOW,
89         PAR_PATH_CONST,
90         PAR_LATTICE,
91         PAR_VERTEX,
92         PAR_TRIA
93 } eParentType;
94
95 #ifdef __RNA_TYPES_H__
96 extern struct EnumPropertyItem prop_clear_parent_types[];
97 extern struct EnumPropertyItem prop_make_parent_types[];
98 #endif
99
100 int ED_object_parent_set(struct ReportList *reports, struct Main *bmain, struct Scene *scene, struct Object *ob,
101                          struct Object *par, int partype, int xmirror, int keep_transform);
102 void ED_object_parent_clear(struct Object *ob, int type);
103 struct Base *ED_object_scene_link(struct Scene *scene, struct Object *ob);
104
105 void ED_keymap_proportional_cycle(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap);
106 void ED_keymap_proportional_obmode(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap);
107 void ED_keymap_proportional_maskmode(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap);
108 void ED_keymap_proportional_editmode(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap,
109                                      const short do_connected);
110
111 /* send your own notifier for select! */
112 void ED_base_object_select(struct Base *base, short mode);
113 /* includes notifier */
114 void ED_base_object_activate(struct bContext *C, struct Base *base);
115
116 void ED_base_object_free_and_unlink(struct Main *bmain, struct Scene *scene, struct Base *base);
117
118 /* single object duplicate, if (dupflag == 0), fully linked, else it uses the flags given */
119 struct Base *ED_object_add_duplicate(struct Main *bmain, struct Scene *scene, struct Base *base, int dupflag);
120
121 void ED_object_parent(struct Object *ob, struct Object *parent, int type, const char *substr);
122
123 void ED_object_toggle_modes(struct bContext *C, int mode);
124
125 /* bitflags for enter/exit editmode */
126 #define EM_FREEDATA     1
127 #define EM_FREEUNDO     2
128 #define EM_WAITCURSOR   4
129 #define EM_DO_UNDO      8
130 #define EM_IGNORE_LAYER 16
131 void ED_object_editmode_exit(struct bContext *C, int flag);
132 void ED_object_editmode_enter(struct bContext *C, int flag);
133 bool ED_object_editmode_load(struct Object *obedit);
134
135 void ED_object_location_from_view(struct bContext *C, float loc[3]);
136 void ED_object_rotation_from_view(struct bContext *C, float rot[3]);
137 void ED_object_base_init_transform(struct bContext *C, struct Base *base, const float loc[3], const float rot[3]);
138 float ED_object_new_primitive_matrix(struct bContext *C, struct Object *editob,
139                                      const float loc[3], const float rot[3], float primmat[4][4],
140                                      int apply_diameter);
141
142 void ED_object_add_generic_props(struct wmOperatorType *ot, int do_editmode);
143 int ED_object_add_generic_get_opts(struct bContext *C, struct wmOperator *op,  float loc[3], float rot[3],
144                                    int *enter_editmode, unsigned int *layer, int *is_view_aligned);
145
146 struct Object *ED_object_add_type(struct bContext *C, int type, const float loc[3], const float rot[3],
147                                   int enter_editmode, unsigned int layer);
148
149 void ED_object_single_users(struct Main *bmain, struct Scene *scene, int full);
150 void ED_object_single_user(struct Scene *scene, struct Object *ob);
151
152 /* object motion paths */
153 void ED_objects_clear_paths(struct bContext *C);
154 void ED_objects_recalculate_paths(struct bContext *C, struct Scene *scene);
155
156 /* constraints */
157 struct ListBase *get_active_constraints(struct Object *ob);
158 struct ListBase *get_constraint_lb(struct Object *ob, struct bConstraint *con, struct bPoseChannel **pchan_r);
159 struct bConstraint *get_active_constraint(struct Object *ob);
160
161 void object_test_constraints(struct Object *ob);
162
163 void ED_object_constraint_set_active(struct Object *ob, struct bConstraint *con);
164 void ED_object_constraint_update(struct Object *ob);
165 void ED_object_constraint_dependency_update(struct Main *bmain, struct Object *ob);
166
167 /* object_lattice.c */
168 bool mouse_lattice(struct bContext *C, const int mval[2], bool extend, bool deselect, bool toggle);
169 void undo_push_lattice(struct bContext *C, const char *name);
170
171 /* object_lattice.c */
172
173 void ED_setflagsLatt(struct Object *obedit, int flag);
174
175 /* object_modifier.c */
176 enum {
177         MODIFIER_APPLY_DATA = 1,
178         MODIFIER_APPLY_SHAPE
179 };
180
181 struct ModifierData *ED_object_modifier_add(struct ReportList *reports, struct Main *bmain, struct Scene *scene,
182                                             struct Object *ob, const char *name, int type);
183 int ED_object_modifier_remove(struct ReportList *reports, struct Main *bmain,
184                               struct Object *ob, struct ModifierData *md);
185 void ED_object_modifier_clear(struct Main *bmain, struct Object *ob);
186 int ED_object_modifier_move_down(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
187 int ED_object_modifier_move_up(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
188 int ED_object_modifier_convert(struct ReportList *reports, struct Main *bmain, struct Scene *scene,
189                                struct Object *ob, struct ModifierData *md);
190 int ED_object_modifier_apply(struct ReportList *reports, struct Scene *scene,
191                              struct Object *ob, struct ModifierData *md, int mode);
192 int ED_object_modifier_copy(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
193
194 int ED_object_iter_other(struct Main *bmain, struct Object *orig_ob, const bool include_orig,
195                          int (*callback)(struct Object *ob, void *callback_data),
196                          void *callback_data);
197
198 int ED_object_multires_update_totlevels_cb(struct Object *ob, void *totlevel_v);
199
200 /* object_select.c */
201 void ED_object_select_linked_by_id(struct bContext *C, struct ID *id);
202
203 #ifdef __cplusplus
204 }
205 #endif
206
207 #endif /* __ED_OBJECT_H__ */