OUTLINER_OT_scene_drop -- "Drag object to scene in Outliner" operator
[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 bContext *C, int type);
89 struct Base *ED_object_scene_link(struct ReportList *reports, struct Scene *scene, struct Object *ob);
90
91 /* generic editmode keys like pet
92  * do_pet
93  *  0: No
94  *  1: Object
95  *  2: Edit
96  *  3: Edit with connected
97  * */
98 void ED_object_generic_keymap(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap, int do_pet);
99
100 /* send your own notifier for select! */
101 void ED_base_object_select(struct Base *base, short mode);
102 /* includes notifier */
103 void ED_base_object_activate(struct bContext *C, struct Base *base);
104
105 void ED_base_object_free_and_unlink(struct Main *bmain, struct Scene *scene, struct Base *base);
106
107 /* single object duplicate, if dupflag==0, fully linked, else it uses the flags given */
108 struct Base *ED_object_add_duplicate(struct Main *bmain, struct Scene *scene, struct Base *base, int dupflag);
109
110 void ED_object_parent(struct Object *ob, struct Object *parent, int type, const char *substr);
111
112 void ED_object_toggle_modes(struct bContext *C, int mode);
113
114 /* bitflags for enter/exit editmode */
115 #define EM_FREEDATA     1
116 #define EM_FREEUNDO     2
117 #define EM_WAITCURSOR   4
118 #define EM_DO_UNDO      8
119 #define EM_IGNORE_LAYER 16
120 void ED_object_exit_editmode(struct bContext *C, int flag);
121 void ED_object_enter_editmode(struct bContext *C, int flag);
122
123 void ED_object_location_from_view(struct bContext *C, float loc[3]);
124 void ED_object_rotation_from_view(struct bContext *C, float rot[3]);
125 void ED_object_base_init_transform(struct bContext *C, struct Base *base, const float loc[3], const float rot[3]);
126 float ED_object_new_primitive_matrix(struct bContext *C, struct Object *editob,
127                                      const float loc[3], const float rot[3], float primmat[][4]);
128
129 void ED_object_add_generic_props(struct wmOperatorType *ot, int do_editmode);
130 int ED_object_add_generic_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
131 int ED_object_add_generic_get_opts(struct bContext *C, struct wmOperator *op,  float loc[3], float rot[3],
132                                    int *enter_editmode, unsigned int *layer, int *is_view_aligned);
133
134 struct Object *ED_object_add_type(struct bContext *C, int type, const float loc[3], const float rot[3],
135                                   int enter_editmode, unsigned int layer);
136
137 void ED_object_single_users(struct Main *bmain, struct Scene *scene, int full);
138 void ED_object_single_user(struct Scene *scene, struct Object *ob);
139
140 /* object motion paths */
141 void ED_objects_clear_paths(struct bContext *C);
142 void ED_objects_recalculate_paths(struct bContext *C, struct Scene *scene);
143
144 /* constraints */
145 struct ListBase *get_active_constraints(struct Object *ob);
146 struct ListBase *get_constraint_lb(struct Object *ob, struct bConstraint *con, struct bPoseChannel **pchan_r);
147 struct bConstraint *get_active_constraint(struct Object *ob);
148
149 void object_test_constraints(struct Object *ob);
150
151 void ED_object_constraint_set_active(struct Object *ob, struct bConstraint *con);
152 void ED_object_constraint_update(struct Object *ob);
153 void ED_object_constraint_dependency_update(struct Main *bmain, struct Scene *scene, struct Object *ob);
154
155 /* object_lattice.c */
156 int  mouse_lattice(struct bContext *C, const int mval[2], int extend, int deselect, int toggle);
157 void undo_push_lattice(struct bContext *C, const char *name);
158
159 /* object_lattice.c */
160
161 void ED_setflagsLatt(struct Object *obedit, int flag);
162
163 /* object_modifier.c */
164 enum {
165         MODIFIER_APPLY_DATA = 1,
166         MODIFIER_APPLY_SHAPE
167 };
168
169 struct ModifierData *ED_object_modifier_add(struct ReportList *reports, struct Main *bmain, struct Scene *scene,
170                                             struct Object *ob, const char *name, int type);
171 int ED_object_modifier_remove(struct ReportList *reports, struct Main *bmain, struct Scene *scene,
172                               struct Object *ob, struct ModifierData *md);
173 void ED_object_modifier_clear(struct Main *bmain, struct Scene *scene, struct Object *ob);
174 int ED_object_modifier_move_down(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
175 int ED_object_modifier_move_up(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
176 int ED_object_modifier_convert(struct ReportList *reports, struct Main *bmain, struct Scene *scene,
177                                struct Object *ob, struct ModifierData *md);
178 int ED_object_modifier_apply(struct ReportList *reports, struct Scene *scene,
179                              struct Object *ob, struct ModifierData *md, int mode);
180 int ED_object_modifier_copy(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
181
182 #ifdef __cplusplus
183 }
184 #endif
185
186 #endif /* __ED_OBJECT_H__ */
187