Merge branch 'master' into blender2.8
[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_collection.h"
41 #include "BKE_context.h"
42 #include "BKE_main.h"
43 #include "BKE_report.h"
44 #include "BKE_rigidbody.h"
45
46 #include "DEG_depsgraph.h"
47 #include "DEG_depsgraph_build.h"
48
49 #include "RNA_access.h"
50 #include "RNA_define.h"
51 #include "RNA_enum_types.h"
52
53 #include "WM_api.h"
54 #include "WM_types.h"
55
56 #include "ED_physics.h"
57 #include "ED_screen.h"
58
59 #include "physics_intern.h"
60
61 /* ********************************************** */
62 /* Helper API's for RigidBody Constraint Editing */
63
64 static bool ED_operator_rigidbody_con_active_poll(bContext *C)
65 {
66         if (ED_operator_object_active_editable(C)) {
67                 Object *ob = CTX_data_active_object(C);
68                 return (ob && ob->rigidbody_constraint);
69         }
70         else
71                 return 0;
72 }
73
74
75 bool ED_rigidbody_constraint_add(Main *bmain, Scene *scene, Object *ob, int type, ReportList *reports)
76 {
77         RigidBodyWorld *rbw = BKE_rigidbody_get_world(scene);
78
79         /* check that object doesn't already have a constraint */
80         if (ob->rigidbody_constraint) {
81                 BKE_reportf(reports, RPT_INFO, "Object '%s' already has a Rigid Body Constraint", ob->id.name + 2);
82                 return false;
83         }
84         /* create constraint group if it doesn't already exits */
85         if (rbw->constraints == NULL) {
86                 rbw->constraints = BKE_collection_add(bmain, NULL, "RigidBodyConstraints");
87                 id_fake_user_set(&rbw->constraints->id);
88         }
89         /* make rigidbody constraint settings */
90         ob->rigidbody_constraint = BKE_rigidbody_create_constraint(scene, ob, type);
91         ob->rigidbody_constraint->flag |= RBC_FLAG_NEEDS_VALIDATE;
92
93         /* add constraint to rigid body constraint group */
94         BKE_collection_object_add(bmain, rbw->constraints, ob);
95
96         DEG_relations_tag_update(bmain);
97         DEG_id_tag_update(&ob->id, OB_RECALC_OB);
98         DEG_id_tag_update(&rbw->constraints->id, DEG_TAG_COPY_ON_WRITE);
99
100         return true;
101 }
102
103 void ED_rigidbody_constraint_remove(Main *bmain, Scene *scene, Object *ob)
104 {
105         RigidBodyWorld *rbw = BKE_rigidbody_get_world(scene);
106
107         BKE_rigidbody_remove_constraint(scene, ob);
108         if (rbw) {
109                 BKE_collection_object_remove(bmain, rbw->constraints, ob, false);
110                 DEG_id_tag_update(&rbw->constraints->id, DEG_TAG_COPY_ON_WRITE);
111         }
112
113         DEG_relations_tag_update(bmain);
114         DEG_id_tag_update(&ob->id, OB_RECALC_OB);
115 }
116
117 /* ********************************************** */
118 /* Active Object Add/Remove Operators */
119
120 /* ************ Add Rigid Body Constraint ************** */
121
122 static int rigidbody_con_add_exec(bContext *C, wmOperator *op)
123 {
124         Main *bmain = CTX_data_main(C);
125         Scene *scene = CTX_data_scene(C);
126         ViewLayer *view_layer = CTX_data_view_layer(C);
127         RigidBodyWorld *rbw = BKE_rigidbody_get_world(scene);
128         Object *ob = OBACT(view_layer);
129         int type = RNA_enum_get(op->ptr, "type");
130         bool changed;
131
132         /* sanity checks */
133         if (ELEM(NULL, scene, rbw)) {
134                 BKE_report(op->reports, RPT_ERROR, "No Rigid Body World to add Rigid Body Constraint to");
135                 return OPERATOR_CANCELLED;
136         }
137         /* apply to active object */
138         changed = ED_rigidbody_constraint_add(bmain, scene, ob, type, op->reports);
139
140         if (changed) {
141                 /* send updates */
142                 WM_event_add_notifier(C, NC_OBJECT | ND_TRANSFORM, NULL);
143
144                 /* done */
145                 return OPERATOR_FINISHED;
146         }
147         else {
148                 return OPERATOR_CANCELLED;
149         }
150 }
151
152 void RIGIDBODY_OT_constraint_add(wmOperatorType *ot)
153 {
154         /* identifiers */
155         ot->idname = "RIGIDBODY_OT_constraint_add";
156         ot->name = "Add Rigid Body Constraint";
157         ot->description = "Add Rigid Body Constraint to active object";
158
159         /* callbacks */
160         ot->exec = rigidbody_con_add_exec;
161         ot->poll = ED_operator_object_active_editable;
162
163         /* flags */
164         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
165
166         /* properties */
167         ot->prop = RNA_def_enum(ot->srna, "type", rna_enum_rigidbody_constraint_type_items, RBC_TYPE_FIXED, "Rigid Body Constraint Type", "");
168 }
169
170 /* ************ Remove Rigid Body Constraint ************** */
171
172 static int rigidbody_con_remove_exec(bContext *C, wmOperator *op)
173 {
174         Main *bmain = CTX_data_main(C);
175         Scene *scene = CTX_data_scene(C);
176         ViewLayer *view_layer = CTX_data_view_layer(C);
177         Object *ob = OBACT(view_layer);
178
179         /* apply to active object */
180         if (ELEM(NULL, ob, ob->rigidbody_constraint)) {
181                 BKE_report(op->reports, RPT_ERROR, "Object has no Rigid Body Constraint to remove");
182                 return OPERATOR_CANCELLED;
183         }
184         else {
185                 ED_rigidbody_constraint_remove(bmain, scene, ob);
186         }
187
188         /* send updates */
189         WM_event_add_notifier(C, NC_OBJECT | ND_TRANSFORM, NULL);
190
191         /* done */
192         return OPERATOR_FINISHED;
193 }
194
195 void RIGIDBODY_OT_constraint_remove(wmOperatorType *ot)
196 {
197         /* identifiers */
198         ot->idname = "RIGIDBODY_OT_constraint_remove";
199         ot->name = "Remove Rigid Body Constraint";
200         ot->description = "Remove Rigid Body Constraint from Object";
201
202         /* callbacks */
203         ot->exec = rigidbody_con_remove_exec;
204         ot->poll = ED_operator_rigidbody_con_active_poll;
205
206         /* flags */
207         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
208 }