85b059d55741390369d9dcfa3022b1300ebd62b1
[blender.git] / source / blender / editors / physics / rigidbody_constraint.c
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) 2013 Blender Foundation
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Sergej Reich
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file rigidbody_constraint.c
29  *  \ingroup editor_physics
30  *  \brief Rigid Body constraint editing operators
31  */
32
33 #include <stdlib.h>
34 #include <string.h>
35
36 #include "DNA_object_types.h"
37 #include "DNA_rigidbody_types.h"
38 #include "DNA_scene_types.h"
39
40 #include "BKE_context.h"
41 #include "BKE_depsgraph.h"
42 #include "BKE_global.h"
43 #include "BKE_group.h"
44 #include "BKE_report.h"
45 #include "BKE_rigidbody.h"
46
47 #include "RNA_access.h"
48 #include "RNA_define.h"
49 #include "RNA_enum_types.h"
50
51 #include "WM_api.h"
52 #include "WM_types.h"
53
54 #include "ED_physics.h"
55 #include "ED_screen.h"
56
57 #include "physics_intern.h"
58
59 /* ********************************************** */
60 /* Helper API's for RigidBody Constraint Editing */
61
62 static int ED_operator_rigidbody_con_active_poll(bContext *C)
63 {
64         if (ED_operator_object_active_editable(C)) {
65                 Object *ob = CTX_data_active_object(C);
66                 return (ob && ob->rigidbody_constraint);
67         }
68         else
69                 return 0;
70 }
71
72
73 bool ED_rigidbody_constraint_add(Scene *scene, Object *ob, int type, ReportList *reports)
74 {
75         RigidBodyWorld *rbw = BKE_rigidbody_get_world(scene);
76
77         /* check that object doesn't already have a constraint */
78         if (ob->rigidbody_constraint) {
79                 BKE_reportf(reports, RPT_INFO, "Object '%s' already has a Rigid Body Constraint", ob->id.name + 2);
80                 return false;
81         }
82         /* create constraint group if it doesn't already exits */
83         if (rbw->constraints == NULL) {
84                 rbw->constraints = BKE_group_add(G.main, "RigidBodyConstraints");
85         }
86         /* make rigidbody constraint settings */
87         ob->rigidbody_constraint = BKE_rigidbody_create_constraint(scene, ob, type);
88         ob->rigidbody_constraint->flag |= RBC_FLAG_NEEDS_VALIDATE;
89
90         /* add constraint to rigid body constraint group */
91         BKE_group_object_add(rbw->constraints, ob, scene, NULL);
92
93         DAG_id_tag_update(&ob->id, OB_RECALC_OB);
94         return true;
95 }
96
97 void ED_rigidbody_constraint_remove(Scene *scene, Object *ob)
98 {
99         RigidBodyWorld *rbw = BKE_rigidbody_get_world(scene);
100
101         BKE_rigidbody_remove_constraint(scene, ob);
102         if (rbw)
103                 BKE_group_object_unlink(rbw->constraints, ob, scene, NULL);
104
105         DAG_id_tag_update(&ob->id, OB_RECALC_OB);
106 }
107
108 /* ********************************************** */
109 /* Active Object Add/Remove Operators */
110
111 /* ************ Add Rigid Body Constraint ************** */
112
113 static int rigidbody_con_add_exec(bContext *C, wmOperator *op)
114 {
115         Scene *scene = CTX_data_scene(C);
116         RigidBodyWorld *rbw = BKE_rigidbody_get_world(scene);
117         Object *ob = (scene) ? OBACT : NULL;
118         int type = RNA_enum_get(op->ptr, "type");
119         bool changed;
120
121         /* sanity checks */
122         if (ELEM(NULL, scene, rbw)) {
123                 BKE_report(op->reports, RPT_ERROR, "No Rigid Body World to add Rigid Body Constraint to");
124                 return OPERATOR_CANCELLED;
125         }
126         /* apply to active object */
127         changed = ED_rigidbody_constraint_add(scene, ob, type, op->reports);
128
129         if (changed) {
130                 /* send updates */
131                 WM_event_add_notifier(C, NC_OBJECT | ND_TRANSFORM, NULL);
132
133                 /* done */
134                 return OPERATOR_FINISHED;
135         }
136         else {
137                 return OPERATOR_CANCELLED;
138         }
139 }
140
141 void RIGIDBODY_OT_constraint_add(wmOperatorType *ot)
142 {
143         /* identifiers */
144         ot->idname = "RIGIDBODY_OT_constraint_add";
145         ot->name = "Add Rigid Body Constraint";
146         ot->description = "Add Rigid Body Constraint to active object";
147
148         /* callbacks */
149         ot->exec = rigidbody_con_add_exec;
150         ot->poll = ED_operator_object_active_editable;
151
152         /* flags */
153         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
154
155         /* properties */
156         ot->prop = RNA_def_enum(ot->srna, "type", rigidbody_constraint_type_items, RBC_TYPE_FIXED, "Rigid Body Constraint Type", "");
157 }
158
159 /* ************ Remove Rigid Body Constraint ************** */
160
161 static int rigidbody_con_remove_exec(bContext *C, wmOperator *op)
162 {
163         Scene *scene = CTX_data_scene(C);
164         Object *ob = (scene) ? OBACT : NULL;
165
166         /* sanity checks */
167         if (scene == NULL)
168                 return OPERATOR_CANCELLED;
169
170         /* apply to active object */
171         if (ELEM(NULL, ob, ob->rigidbody_constraint)) {
172                 BKE_report(op->reports, RPT_ERROR, "Object has no Rigid Body Constraint to remove");
173                 return OPERATOR_CANCELLED;
174         }
175         else {
176                 ED_rigidbody_constraint_remove(scene, ob);
177         }
178
179         /* send updates */
180         WM_event_add_notifier(C, NC_OBJECT | ND_TRANSFORM, NULL);
181
182         /* done */
183         return OPERATOR_FINISHED;
184 }
185
186 void RIGIDBODY_OT_constraint_remove(wmOperatorType *ot)
187 {
188         /* identifiers */
189         ot->idname = "RIGIDBODY_OT_constraint_remove";
190         ot->name = "Remove Rigid Body Constraint";
191         ot->description = "Remove Rigid Body Constraint from Object";
192
193         /* callbacks */
194         ot->exec = rigidbody_con_remove_exec;
195         ot->poll = ED_operator_rigidbody_con_active_poll;
196
197         /* flags */
198         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
199 }