2f54c242717fd95950aac1d0ed43d71454fb9688
[blender.git] / source / blender / editors / include / ED_object.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28 #ifndef ED_OBJECT_H
29 #define ED_OBJECT_H
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 struct Base;
36 struct bConstraint;
37 struct bContext;
38 struct bPoseChannel;
39 struct Curve;
40 struct KeyBlock;
41 struct Lattice;
42 struct Main;
43 struct Mesh;
44 struct ModifierData;
45 struct Object;
46 struct ReportList;
47 struct Scene;
48 struct View3D;
49 struct wmEvent;
50 struct wmKeyConfig;
51 struct wmKeyMap;
52 struct wmOperator;
53 struct wmOperatorType;
54
55 /* object_edit.c */
56 struct Object *ED_object_active_context(struct bContext *C);
57
58 /* object_ops.c */
59 void ED_operatortypes_object(void);
60 void ED_operatormacros_object(void);
61 void ED_keymap_object(struct wmKeyConfig *keyconf);
62
63 /* generic editmode keys like pet
64  * do_pet
65  *      0: No
66  *      1: Object
67  *      2: Edit
68  *      3: Edit with connected
69  * */
70 void ED_object_generic_keymap(struct wmKeyConfig *keyconf, struct wmKeyMap *keymap, int do_pet);
71
72         /* send your own notifier for select! */
73 void ED_base_object_select(struct Base *base, short mode);
74         /* includes notifier */
75 void ED_base_object_activate(struct bContext *C, struct Base *base);
76
77 void ED_base_object_free_and_unlink(struct Main *bmain, struct Scene *scene, struct Base *base);
78
79         /* single object duplicate, if dupflag==0, fully linked, else it uses the flags given */
80 struct Base *ED_object_add_duplicate(struct Main *bmain, struct Scene *scene, struct Base *base, int dupflag);
81
82 void ED_object_parent(struct Object *ob, struct Object *parent, int type, const char *substr);
83
84 void ED_object_toggle_modes(struct bContext *C, int mode);
85
86 /* bitflags for enter/exit editmode */
87 #define EM_FREEDATA             1
88 #define EM_FREEUNDO             2
89 #define EM_WAITCURSOR   4
90 #define EM_DO_UNDO              8
91 #define EM_IGNORE_LAYER 16
92 void ED_object_exit_editmode(struct bContext *C, int flag);
93 void ED_object_enter_editmode(struct bContext *C, int flag);
94
95 void ED_object_location_from_view(struct bContext *C, float *loc);
96 void ED_object_rotation_from_view(struct bContext *C, float *rot);
97 void ED_object_base_init_transform(struct bContext *C, struct Base *base, float *loc, float *rot);
98 float ED_object_new_primitive_matrix(struct bContext *C, struct Object *editob, float *loc, float *rot, float primmat[][4]);
99
100 void ED_object_add_generic_props(struct wmOperatorType *ot, int do_editmode);
101 int ED_object_add_generic_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
102 int ED_object_add_generic_get_opts(struct bContext *C, struct wmOperator *op, float *loc, float *rot, int *enter_editmode, unsigned int *layer);
103 struct Object *ED_object_add_type(struct bContext *C, int type, float *loc, float *rot, int enter_editmode, unsigned int layer);
104
105 void ED_object_single_users(struct Main *bmain, struct Scene *scene, int full);
106
107
108 /* object motion paths */
109 void ED_objects_clear_paths(struct bContext *C);
110 void ED_objects_recalculate_paths(struct bContext *C, struct Scene *scene);
111
112 /* constraints */
113 struct ListBase *get_active_constraints(struct Object *ob);
114 struct ListBase *get_constraint_lb(struct Object *ob, struct bConstraint *con, struct bPoseChannel **pchan_r);
115 struct bConstraint *get_active_constraint(struct Object *ob);
116
117 void object_test_constraints(struct Object *ob);
118
119 void ED_object_constraint_set_active(struct Object *ob, struct bConstraint *con);
120 void ED_object_constraint_update(struct Object *ob);
121 void ED_object_constraint_dependency_update(struct Main *bmain, struct Scene *scene, struct Object *ob);
122
123 /* object_lattice.c */
124 int  mouse_lattice(struct bContext *C, short mval[2], int extend);
125 void undo_push_lattice(struct bContext *C, const char *name);
126
127 /* object_lattice.c */
128
129 void ED_setflagsLatt(struct Object *obedit, int flag);
130
131 /* object_modifier.c */
132 enum {
133         MODIFIER_APPLY_DATA=1,
134         MODIFIER_APPLY_SHAPE,
135 } eModifier_Apply_Mode;
136
137 struct ModifierData *ED_object_modifier_add(struct ReportList *reports, struct Main *bmain, struct Scene *scene, struct Object *ob, const char *name, int type);
138 int ED_object_modifier_remove(struct ReportList *reports, struct Main *bmain, struct Scene *scene, struct Object *ob, struct ModifierData *md);
139 int ED_object_modifier_move_down(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
140 int ED_object_modifier_move_up(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
141 int ED_object_modifier_convert(struct ReportList *reports, struct Main *bmain, struct Scene *scene, struct Object *ob, struct ModifierData *md);
142 int ED_object_modifier_apply(struct ReportList *reports, struct Scene *scene, struct Object *ob, struct ModifierData *md, int mode);
143 int ED_object_modifier_copy(struct ReportList *reports, struct Object *ob, struct ModifierData *md);
144
145 #ifdef __cplusplus
146 }
147 #endif
148
149 #endif /* ED_OBJECT_H */
150