c1c0463ee5a6b20da0680f2863f7d6e2a59186c4
[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 Base;
39 struct EnumPropertyItem;
40 struct ID;
41 struct Main;
42 struct ModifierData;
43 struct Object;
44 struct ObjectBase;
45 struct ReportList;
46 struct Scene;
47 struct SceneLayer;
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 LayerTree;
59
60 /* object_edit.c */
61 struct Object *ED_object_context(struct bContext *C);               /* context.object */
62 struct Object *ED_object_active_context(struct bContext *C); /* context.object or context.active_object */
63
64 /* object_ops.c */
65 void ED_operatortypes_object(void);
66 void ED_operatormacros_object(void);
67 void ED_keymap_object(struct wmKeyConfig *keyconf);
68
69 /* object_relations.c */
70 typedef enum eParentType {
71         PAR_OBJECT,
72         PAR_ARMATURE,
73         PAR_ARMATURE_NAME,
74         PAR_ARMATURE_ENVELOPE,
75         PAR_ARMATURE_AUTO,
76         PAR_BONE,
77         PAR_BONE_RELATIVE,
78         PAR_CURVE,
79         PAR_FOLLOW,
80         PAR_PATH_CONST,
81         PAR_LATTICE,
82         PAR_VERTEX,
83         PAR_VERTEX_TRI,
84 } eParentType;
85
86 #ifdef __RNA_TYPES_H__
87 extern struct EnumPropertyItem prop_clear_parent_types[];
88 extern struct EnumPropertyItem prop_make_parent_types[];
89 #endif
90
91 bool ED_object_parent_set(struct ReportList *reports, struct Main *bmain, struct Scene *scene, struct Object *ob,
92                           struct Object *par, int partype, const bool xmirror, const bool keep_transform,
93                           const int vert_par[3]);
94 void ED_object_parent_clear(struct Object *ob, const int type);
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_object_base_select(struct ObjectBase *base, short mode);
108 void ED_object_base_activate(struct bContext *C, struct ObjectBase *base);
109
110 void ED_base_object_free_and_unlink(struct Main *bmain, struct Scene *scene, struct Object *ob);
111
112 void ED_base_object_sync_from_base(struct Base *base, struct Object *ob);
113 void ED_base_object_sync_from_object(struct Base *base, struct Object *ob);
114
115 /* single object duplicate, if (dupflag == 0), fully linked, else it uses the flags given */
116 struct ObjectBase *ED_object_add_duplicate(struct Main *bmain, struct Scene *scene, struct SceneLayer *sl, struct ObjectBase *base, int dupflag);
117
118 void ED_object_parent(struct Object *ob, struct Object *parent, const int type, const char *substr);
119
120 bool ED_object_mode_compat_set(struct bContext *C, struct Object *ob, int mode, struct ReportList *reports);
121 void ED_object_toggle_modes(struct bContext *C, int mode);
122
123 /* bitflags for enter/exit editmode */
124 #define EM_FREEDATA     1
125 #define EM_FREEUNDO     2
126 #define EM_WAITCURSOR   4
127 #define EM_DO_UNDO      8
128 #define EM_IGNORE_LAYER 16
129 void ED_object_editmode_exit(struct bContext *C, int flag);
130 void ED_object_editmode_enter(struct bContext *C, int flag);
131 bool ED_object_editmode_load(struct Object *obedit);
132
133 bool ED_object_editmode_calc_active_center(struct Object *obedit, const bool select_only, float r_center[3]);
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], const char align_axis);
137 void ED_object_base_init_transform(struct bContext *C, struct ObjectBase *base, const float loc[3], const float rot[3]);
138 float ED_object_new_primitive_matrix(
139         struct bContext *C, struct Object *editob,
140         const float loc[3], const float rot[3], float primmat[4][4]);
141
142
143 /* Avoid allowing too much insane values even by typing (typos can hang/crash Blender otherwise). */
144 #define OBJECT_ADD_SIZE_MAXF 1.0e12f
145
146 void ED_object_add_unit_props(struct wmOperatorType *ot);
147 void ED_object_add_generic_props(struct wmOperatorType *ot, bool do_editmode);
148 void ED_object_add_mesh_props(struct wmOperatorType *ot);
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(
154         struct bContext *C,
155         int type, const char *name, const float loc[3], const float rot[3],
156         bool enter_editmode, unsigned int layer)
157         ATTR_NONNULL(1) ATTR_RETURNS_NONNULL;
158
159 void ED_object_single_users(struct Main *bmain, struct Scene *scene, const bool full, const bool copy_groups);
160 void ED_object_single_user(struct Main *bmain, struct Scene *scene, struct Object *ob);
161
162 /* object motion paths */
163 void ED_objects_clear_paths(struct bContext *C, bool only_selected);
164 void ED_objects_recalculate_paths(struct bContext *C, struct Scene *scene);
165
166 /* constraints */
167 struct ListBase *get_active_constraints(struct Object *ob);
168 struct ListBase *get_constraint_lb(struct Object *ob, struct bConstraint *con, struct bPoseChannel **r_pchan);
169 struct bConstraint *get_active_constraint(struct Object *ob);
170
171 void object_test_constraints(struct Object *ob);
172
173 void ED_object_constraint_set_active(struct Object *ob, struct bConstraint *con);
174 void ED_object_constraint_update(struct Object *ob);
175 void ED_object_constraint_dependency_update(struct Main *bmain, struct Object *ob);
176
177 void ED_object_constraint_tag_update(struct Object *ob, struct bConstraint *con);
178 void ED_object_constraint_dependency_tag_update(struct Main *bmain, struct Object *ob, struct bConstraint *con);
179
180 /* object_lattice.c */
181 bool ED_lattice_select_pick(struct bContext *C, const int mval[2], bool extend, bool deselect, bool toggle);
182 void undo_push_lattice(struct bContext *C, const char *name);
183
184 /* object_lattice.c */
185
186 void ED_lattice_flags_set(struct Object *obedit, int flag);
187
188 /* object_modifier.c */
189 enum {
190         MODIFIER_APPLY_DATA = 1,
191         MODIFIER_APPLY_SHAPE
192 };
193
194 struct ModifierData *ED_object_modifier_add(struct ReportList *reports, struct Main *bmain, struct Scene *scene,
195                                             struct Object *ob, const char *name, int type);
196 bool ED_object_modifier_remove(struct ReportList *reports, struct Main *bmain,
197                                struct Object *ob, struct ModifierData *md);
198 void ED_object_modifier_clear(struct Main *bmain, struct Object *ob);
199 int ED_object_modifier_move_down(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
200 int ED_object_modifier_move_up(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
201 int ED_object_modifier_convert(struct ReportList *reports, struct Main *bmain, struct Scene *scene,
202                                struct SceneLayer *sl, struct Object *ob, struct ModifierData *md);
203 int ED_object_modifier_apply(struct ReportList *reports, struct Scene *scene,
204                              struct Object *ob, struct ModifierData *md, int mode);
205 int ED_object_modifier_copy(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
206
207 bool ED_object_iter_other(struct Main *bmain, struct Object *orig_ob, const bool include_orig,
208                           bool (*callback)(struct Object *ob, void *callback_data),
209                           void *callback_data);
210
211 bool ED_object_multires_update_totlevels_cb(struct Object *ob, void *totlevel_v);
212
213 /* object_select.c */
214 void ED_object_select_linked_by_id(struct bContext *C, struct ID *id);
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__ */