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