Cleanup: sync vertex-paint and sculpt from 2.8
[blender-staging.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 Base;
39 struct EnumPropertyItem;
40 struct ID;
41 struct Main;
42 struct ModifierData;
43 struct Object;
44 struct ReportList;
45 struct Scene;
46 struct bConstraint;
47 struct bContext;
48 struct bPoseChannel;
49 struct wmKeyConfig;
50 struct wmKeyMap;
51 struct wmOperator;
52 struct wmOperatorType;
53 struct PointerRNA;
54 struct PropertyRNA;
55 struct EnumPropertyItem;
56
57 #include "DNA_object_enums.h"
58
59 /* object_edit.c */
60 struct Object *ED_object_context(struct bContext *C);               /* context.object */
61 struct Object *ED_object_active_context(struct bContext *C); /* context.object or context.active_object */
62
63 /* object_ops.c */
64 void ED_operatortypes_object(void);
65 void ED_operatormacros_object(void);
66 void ED_keymap_object(struct wmKeyConfig *keyconf);
67
68 /* object_relations.c */
69 typedef enum eParentType {
70         PAR_OBJECT,
71         PAR_ARMATURE,
72         PAR_ARMATURE_NAME,
73         PAR_ARMATURE_ENVELOPE,
74         PAR_ARMATURE_AUTO,
75         PAR_BONE,
76         PAR_BONE_RELATIVE,
77         PAR_CURVE,
78         PAR_FOLLOW,
79         PAR_PATH_CONST,
80         PAR_LATTICE,
81         PAR_VERTEX,
82         PAR_VERTEX_TRI,
83 } eParentType;
84
85 #ifdef __RNA_TYPES_H__
86 extern struct EnumPropertyItem prop_clear_parent_types[];
87 extern struct EnumPropertyItem prop_make_parent_types[];
88 #endif
89
90 bool ED_object_parent_set(struct ReportList *reports, struct Main *bmain, struct Scene *scene, struct Object *ob,
91                           struct Object *par, int partype, const bool xmirror, const bool keep_transform,
92                           const int vert_par[3]);
93 void ED_object_parent_clear(struct Object *ob, const int type);
94 struct Base *ED_object_scene_link(struct Scene *scene, struct Object *ob);
95
96 void ED_keymap_proportional_cycle(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap);
97 void ED_keymap_proportional_obmode(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap);
98 void ED_keymap_proportional_maskmode(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap);
99 void ED_keymap_proportional_editmode(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap,
100                                      const bool do_connected);
101
102 /* send your own notifier for select! */
103 void ED_base_object_select(struct Base *base, short mode);
104 /* includes notifier */
105 void ED_base_object_activate(struct bContext *C, struct Base *base);
106
107 void ED_base_object_free_and_unlink(struct Main *bmain, struct Scene *scene, struct Base *base);
108
109 /* single object duplicate, if (dupflag == 0), fully linked, else it uses the flags given */
110 struct Base *ED_object_add_duplicate(struct Main *bmain, struct Scene *scene, struct Base *base, int dupflag);
111
112 void ED_object_parent(struct Object *ob, struct Object *parent, const int type, const char *substr);
113
114 bool ED_object_mode_compat_set(struct bContext *C, struct Object *ob, eObjectMode mode, struct ReportList *reports);
115 void ED_object_toggle_modes(struct bContext *C, eObjectMode mode);
116
117 /* bitflags for enter/exit editmode */
118 #define EM_FREEDATA     1
119 #define EM_FREEUNDO     2
120 #define EM_WAITCURSOR   4
121 #define EM_DO_UNDO      8
122 #define EM_IGNORE_LAYER 16
123 void ED_object_editmode_exit_ex(struct bContext *C, struct Scene *scene, struct Object *obedit, int flag);
124 void ED_object_editmode_exit(struct bContext *C, int flag);
125 void ED_object_editmode_enter(struct bContext *C, int flag);
126 bool ED_object_editmode_load(struct Object *obedit);
127
128 bool ED_object_editmode_calc_active_center(struct Object *obedit, const bool select_only, float r_center[3]);
129
130
131 void ED_object_vpaintmode_enter_ex(
132         struct wmWindowManager *wm,
133         struct Scene *scene, struct Object *ob);
134 void ED_object_vpaintmode_enter(struct bContext *C);
135 void ED_object_wpaintmode_enter_ex(
136         struct wmWindowManager *wm,
137         struct Scene *scene, struct Object *ob);
138 void ED_object_wpaintmode_enter(struct bContext *C);
139
140 void ED_object_vpaintmode_exit_ex(struct Object *ob);
141 void ED_object_vpaintmode_exit(struct bContext *C);
142 void ED_object_wpaintmode_exit_ex(struct Object *ob);
143 void ED_object_wpaintmode_exit(struct bContext *C);
144
145 void ED_object_sculptmode_exit_ex(
146         struct Scene *scene, struct Object *ob);
147 void ED_object_sculptmode_exit(struct bContext *C);
148
149 void ED_object_location_from_view(struct bContext *C, float loc[3]);
150 void ED_object_rotation_from_view(struct bContext *C, float rot[3], const char align_axis);
151 void ED_object_base_init_transform(struct bContext *C, struct Base *base, const float loc[3], const float rot[3]);
152 float ED_object_new_primitive_matrix(
153         struct bContext *C, struct Object *editob,
154         const float loc[3], const float rot[3], float primmat[4][4]);
155
156
157 /* Avoid allowing too much insane values even by typing (typos can hang/crash Blender otherwise). */
158 #define OBJECT_ADD_SIZE_MAXF 1.0e12f
159
160 void ED_object_add_unit_props(struct wmOperatorType *ot);
161 void ED_object_add_generic_props(struct wmOperatorType *ot, bool do_editmode);
162 void ED_object_add_mesh_props(struct wmOperatorType *ot);
163 bool ED_object_add_generic_get_opts(struct bContext *C, struct wmOperator *op, const char view_align_axis,
164                                     float loc[3], float rot[3],
165                                     bool *enter_editmode, unsigned int *layer, bool *is_view_aligned);
166
167 struct Object *ED_object_add_type(
168         struct bContext *C,
169         int type, const char *name, const float loc[3], const float rot[3],
170         bool enter_editmode, unsigned int layer)
171         ATTR_NONNULL(1) ATTR_RETURNS_NONNULL;
172
173 void ED_object_single_users(struct Main *bmain, struct Scene *scene, const bool full, const bool copy_groups);
174 void ED_object_single_user(struct Main *bmain, struct Scene *scene, struct Object *ob);
175
176 /* object motion paths */
177 void ED_objects_clear_paths(struct bContext *C, bool only_selected);
178 void ED_objects_recalculate_paths(struct bContext *C, struct Scene *scene);
179
180 /* constraints */
181 struct ListBase *get_active_constraints(struct Object *ob);
182 struct ListBase *get_constraint_lb(struct Object *ob, struct bConstraint *con, struct bPoseChannel **r_pchan);
183 struct bConstraint *get_active_constraint(struct Object *ob);
184
185 void object_test_constraints(struct Object *ob);
186
187 void ED_object_constraint_set_active(struct Object *ob, struct bConstraint *con);
188 void ED_object_constraint_update(struct Object *ob);
189 void ED_object_constraint_dependency_update(struct Main *bmain, struct Object *ob);
190
191 void ED_object_constraint_tag_update(struct Object *ob, struct bConstraint *con);
192 void ED_object_constraint_dependency_tag_update(struct Main *bmain, struct Object *ob, struct bConstraint *con);
193
194 /* object_lattice.c */
195 bool ED_lattice_select_pick(struct bContext *C, const int mval[2], bool extend, bool deselect, bool toggle);
196 void undo_push_lattice(struct bContext *C, const char *name);
197
198 /* object_lattice.c */
199
200 void ED_lattice_flags_set(struct Object *obedit, int flag);
201
202 /* object_modifier.c */
203 enum {
204         MODIFIER_APPLY_DATA = 1,
205         MODIFIER_APPLY_SHAPE
206 };
207
208 struct ModifierData *ED_object_modifier_add(
209         struct ReportList *reports, struct Main *bmain, struct Scene *scene,
210         struct Object *ob, const char *name, int type);
211 bool ED_object_modifier_remove(struct ReportList *reports, struct Main *bmain,
212                                struct Object *ob, struct ModifierData *md);
213 void ED_object_modifier_clear(struct Main *bmain, struct Object *ob);
214 int ED_object_modifier_move_down(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
215 int ED_object_modifier_move_up(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
216 int ED_object_modifier_convert(
217         struct ReportList *reports, struct Main *bmain, struct Scene *scene,
218         struct Object *ob, struct ModifierData *md);
219 int ED_object_modifier_apply(struct ReportList *reports, struct Scene *scene,
220                              struct Object *ob, struct ModifierData *md, int mode);
221 int ED_object_modifier_copy(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
222
223 bool ED_object_iter_other(
224         struct Main *bmain, struct Object *orig_ob, const bool include_orig,
225         bool (*callback)(struct Object *ob, void *callback_data),
226         void *callback_data);
227
228 bool ED_object_multires_update_totlevels_cb(struct Object *ob, void *totlevel_v);
229
230 /* object_select.c */
231 void ED_object_select_linked_by_id(struct bContext *C, struct ID *id);
232
233 const struct EnumPropertyItem *ED_object_vgroup_selection_itemf_helper(
234         const struct bContext *C,
235         struct PointerRNA *ptr,
236         struct PropertyRNA *prop,
237         bool *r_free,
238         const unsigned int selection_mask);
239
240 void ED_object_check_force_modifiers(
241         struct Main *bmain, struct Scene *scene, struct Object *object);
242
243 #ifdef __cplusplus
244 }
245 #endif
246
247 #endif /* __ED_OBJECT_H__ */