svn merge ^/trunk/blender -r42080:42095
[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 KeyBlock;
44 struct Lattice;
45 struct Main;
46 struct Mesh;
47 struct ModifierData;
48 struct Object;
49 struct ReportList;
50 struct Scene;
51 struct View3D;
52 struct wmEvent;
53 struct wmKeyConfig;
54 struct wmKeyMap;
55 struct wmOperator;
56 struct wmOperatorType;
57
58 /* object_edit.c */
59 struct Object *ED_object_active_context(struct bContext *C);
60
61 /* object_ops.c */
62 void ED_operatortypes_object(void);
63 void ED_operatormacros_object(void);
64 void ED_keymap_object(struct wmKeyConfig *keyconf);
65
66 /* generic editmode keys like pet
67  * do_pet
68  *      0: No
69  *      1: Object
70  *      2: Edit
71  *      3: Edit with connected
72  * */
73 void ED_object_generic_keymap(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap, int do_pet);
74
75         /* send your own notifier for select! */
76 void ED_base_object_select(struct Base *base, short mode);
77         /* includes notifier */
78 void ED_base_object_activate(struct bContext *C, struct Base *base);
79
80 void ED_base_object_free_and_unlink(struct Main *bmain, struct Scene *scene, struct Base *base);
81
82         /* single object duplicate, if dupflag==0, fully linked, else it uses the flags given */
83 struct Base *ED_object_add_duplicate(struct Main *bmain, struct Scene *scene, struct Base *base, int dupflag);
84
85 void ED_object_parent(struct Object *ob, struct Object *parent, int type, const char *substr);
86
87 void ED_object_toggle_modes(struct bContext *C, int mode);
88
89 /* bitflags for enter/exit editmode */
90 #define EM_FREEDATA             1
91 #define EM_FREEUNDO             2
92 #define EM_WAITCURSOR   4
93 #define EM_DO_UNDO              8
94 #define EM_IGNORE_LAYER 16
95 void ED_object_exit_editmode(struct bContext *C, int flag);
96 void ED_object_enter_editmode(struct bContext *C, int flag);
97
98 void ED_object_location_from_view(struct bContext *C, float *loc);
99 void ED_object_rotation_from_view(struct bContext *C, float *rot);
100 void ED_object_base_init_transform(struct bContext *C, struct Base *base, float *loc, float *rot);
101 float ED_object_new_primitive_matrix(struct bContext *C, struct Object *editob, float *loc, float *rot, float primmat[][4]);
102
103 void ED_object_add_generic_props(struct wmOperatorType *ot, int do_editmode);
104 int ED_object_add_generic_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
105 int ED_object_add_generic_get_opts(struct bContext *C, struct wmOperator *op, 
106         float *loc, float *rot, int *enter_editmode, unsigned int *layer, int *is_view_aligned);
107
108 struct Object *ED_object_add_type(struct bContext *C, int type, float *loc,
109         float *rot, int enter_editmode, unsigned int layer);
110
111 void ED_object_single_users(struct Main *bmain, struct Scene *scene, int full);
112 void ED_object_single_user(struct Scene *scene, struct Object *ob);
113
114 /* object motion paths */
115 void ED_objects_clear_paths(struct bContext *C);
116 void ED_objects_recalculate_paths(struct bContext *C, struct Scene *scene);
117
118 /* constraints */
119 struct ListBase *get_active_constraints(struct Object *ob);
120 struct ListBase *get_constraint_lb(struct Object *ob, struct bConstraint *con, struct bPoseChannel **pchan_r);
121 struct bConstraint *get_active_constraint(struct Object *ob);
122
123 void object_test_constraints(struct Object *ob);
124
125 void ED_object_constraint_set_active(struct Object *ob, struct bConstraint *con);
126 void ED_object_constraint_update(struct Object *ob);
127 void ED_object_constraint_dependency_update(struct Main *bmain, struct Scene *scene, struct Object *ob);
128
129 /* object_lattice.c */
130 int  mouse_lattice(struct bContext *C, const int mval[2], int extend);
131 void undo_push_lattice(struct bContext *C, const char *name);
132
133 /* object_lattice.c */
134
135 void ED_setflagsLatt(struct Object *obedit, int flag);
136
137 /* object_modifier.c */
138 enum {
139         MODIFIER_APPLY_DATA=1,
140         MODIFIER_APPLY_SHAPE
141 };
142
143 struct ModifierData *ED_object_modifier_add(struct ReportList *reports, struct Main *bmain, struct Scene *scene, struct Object *ob, const char *name, int type);
144 int ED_object_modifier_remove(struct ReportList *reports, struct Main *bmain, struct Scene *scene, struct Object *ob, struct ModifierData *md);
145 void ED_object_modifier_clear(struct Main *bmain, struct Scene *scene, struct Object *ob);
146 int ED_object_modifier_move_down(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
147 int ED_object_modifier_move_up(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
148 int ED_object_modifier_convert(struct ReportList *reports, struct Main *bmain, struct Scene *scene, struct Object *ob, struct ModifierData *md);
149 int ED_object_modifier_apply(struct ReportList *reports, struct Scene *scene, struct Object *ob, struct ModifierData *md, int mode);
150 int ED_object_modifier_copy(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
151
152 #ifdef __cplusplus
153 }
154 #endif
155
156 #endif /* ED_OBJECT_H */
157