proportional editing keys now work when editing masks.
[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 bConstraint;
40 struct bContext;
41 struct bPoseChannel;
42 struct Curve;
43 struct EnumPropertyItem;
44 struct KeyBlock;
45 struct Lattice;
46 struct Main;
47 struct Mesh;
48 struct ModifierData;
49 struct Object;
50 struct ReportList;
51 struct Scene;
52 struct View3D;
53 struct wmEvent;
54 struct wmKeyConfig;
55 struct wmKeyMap;
56 struct wmOperator;
57 struct wmOperatorType;
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_CURVE,
77         PAR_FOLLOW,
78         PAR_PATH_CONST,
79         PAR_LATTICE,
80         PAR_VERTEX,
81         PAR_TRIA
82 } eParentType;
83
84 extern struct EnumPropertyItem prop_clear_parent_types[];
85 extern struct EnumPropertyItem prop_make_parent_types[];
86
87 int ED_object_parent_set(struct ReportList *reports, struct Main *bmain, struct Scene *scene, struct Object *ob, struct Object *par, int partype);
88 void ED_object_parent_clear(struct Object *ob, int type);
89 struct Base *ED_object_scene_link(struct Scene *scene, struct Object *ob);
90
91 void ED_keymap_proportional_cycle(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap);
92 void ED_keymap_proportional_obmode(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap);
93 void ED_keymap_proportional_maskmode(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap);
94 void ED_keymap_proportional_editmode(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap,
95                                      const short do_connected);
96
97 /* send your own notifier for select! */
98 void ED_base_object_select(struct Base *base, short mode);
99 /* includes notifier */
100 void ED_base_object_activate(struct bContext *C, struct Base *base);
101
102 void ED_base_object_free_and_unlink(struct Main *bmain, struct Scene *scene, struct Base *base);
103
104 /* single object duplicate, if dupflag==0, fully linked, else it uses the flags given */
105 struct Base *ED_object_add_duplicate(struct Main *bmain, struct Scene *scene, struct Base *base, int dupflag);
106
107 void ED_object_parent(struct Object *ob, struct Object *parent, int type, const char *substr);
108
109 void ED_object_toggle_modes(struct bContext *C, int mode);
110
111 /* bitflags for enter/exit editmode */
112 #define EM_FREEDATA     1
113 #define EM_FREEUNDO     2
114 #define EM_WAITCURSOR   4
115 #define EM_DO_UNDO      8
116 #define EM_IGNORE_LAYER 16
117 void ED_object_exit_editmode(struct bContext *C, int flag);
118 void ED_object_enter_editmode(struct bContext *C, int flag);
119
120 void ED_object_location_from_view(struct bContext *C, float loc[3]);
121 void ED_object_rotation_from_view(struct bContext *C, float rot[3]);
122 void ED_object_base_init_transform(struct bContext *C, struct Base *base, const float loc[3], const float rot[3]);
123 float ED_object_new_primitive_matrix(struct bContext *C, struct Object *editob,
124                                      const float loc[3], const float rot[3], float primmat[][4]);
125
126 void ED_object_add_generic_props(struct wmOperatorType *ot, int do_editmode);
127 int ED_object_add_generic_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
128 int ED_object_add_generic_get_opts(struct bContext *C, struct wmOperator *op,  float loc[3], float rot[3],
129                                    int *enter_editmode, unsigned int *layer, int *is_view_aligned);
130
131 struct Object *ED_object_add_type(struct bContext *C, int type, const float loc[3], const float rot[3],
132                                   int enter_editmode, unsigned int layer);
133
134 void ED_object_single_users(struct Main *bmain, struct Scene *scene, int full);
135 void ED_object_single_user(struct Scene *scene, struct Object *ob);
136
137 /* object motion paths */
138 void ED_objects_clear_paths(struct bContext *C);
139 void ED_objects_recalculate_paths(struct bContext *C, struct Scene *scene);
140
141 /* constraints */
142 struct ListBase *get_active_constraints(struct Object *ob);
143 struct ListBase *get_constraint_lb(struct Object *ob, struct bConstraint *con, struct bPoseChannel **pchan_r);
144 struct bConstraint *get_active_constraint(struct Object *ob);
145
146 void object_test_constraints(struct Object *ob);
147
148 void ED_object_constraint_set_active(struct Object *ob, struct bConstraint *con);
149 void ED_object_constraint_update(struct Object *ob);
150 void ED_object_constraint_dependency_update(struct Main *bmain, struct Scene *scene, struct Object *ob);
151
152 /* object_lattice.c */
153 int  mouse_lattice(struct bContext *C, const int mval[2], int extend, int deselect, int toggle);
154 void undo_push_lattice(struct bContext *C, const char *name);
155
156 /* object_lattice.c */
157
158 void ED_setflagsLatt(struct Object *obedit, int flag);
159
160 /* object_modifier.c */
161 enum {
162         MODIFIER_APPLY_DATA = 1,
163         MODIFIER_APPLY_SHAPE
164 };
165
166 struct ModifierData *ED_object_modifier_add(struct ReportList *reports, struct Main *bmain, struct Scene *scene,
167                                             struct Object *ob, const char *name, int type);
168 int ED_object_modifier_remove(struct ReportList *reports, struct Main *bmain, struct Scene *scene,
169                               struct Object *ob, struct ModifierData *md);
170 void ED_object_modifier_clear(struct Main *bmain, struct Scene *scene, struct Object *ob);
171 int ED_object_modifier_move_down(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
172 int ED_object_modifier_move_up(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
173 int ED_object_modifier_convert(struct ReportList *reports, struct Main *bmain, struct Scene *scene,
174                                struct Object *ob, struct ModifierData *md);
175 int ED_object_modifier_apply(struct ReportList *reports, struct Scene *scene,
176                              struct Object *ob, struct ModifierData *md, int mode);
177 int ED_object_modifier_copy(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
178
179 #ifdef __cplusplus
180 }
181 #endif
182
183 #endif /* __ED_OBJECT_H__ */
184