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