CoCalc -- physics_server_2d_wrap

GitHub Repository: godotengine/godot
Path: blob/master/servers/physics_server_2d_wrap_mt.h
⁹⁸⁸⁷ views
1
/**************************************************************************/
2
/*  physics_server_2d_wrap_mt.h                                           */
3
/**************************************************************************/
4
/*                         This file is part of:                          */
5
/*                             GODOT ENGINE                               */
6
/*                        https://godotengine.org                         */
7
/**************************************************************************/
8
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
10
/*                                                                        */
11
/* Permission is hereby granted, free of charge, to any person obtaining  */
12
/* a copy of this software and associated documentation files (the        */
13
/* "Software"), to deal in the Software without restriction, including    */
14
/* without limitation the rights to use, copy, modify, merge, publish,    */
15
/* distribute, sublicense, and/or sell copies of the Software, and to     */
16
/* permit persons to whom the Software is furnished to do so, subject to  */
17
/* the following conditions:                                              */
18
/*                                                                        */
19
/* The above copyright notice and this permission notice shall be         */
20
/* included in all copies or substantial portions of the Software.        */
21
/*                                                                        */
22
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
23
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
24
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
26
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
27
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
28
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
29
/**************************************************************************/
30

31
#pragma once
32

33
#include "core/object/worker_thread_pool.h"
34
#include "core/os/thread.h"
35
#include "core/templates/command_queue_mt.h"
36
#include "servers/physics_server_2d.h"
37

38
#define ASYNC_COND_PUSH (Thread::get_caller_id() != server_thread)
39
#define ASYNC_COND_PUSH_AND_RET (Thread::get_caller_id() != server_thread && !(doing_sync.is_set() && Thread::is_main_thread()))
40
#define ASYNC_COND_PUSH_AND_SYNC (Thread::get_caller_id() != server_thread && !(doing_sync.is_set() && Thread::is_main_thread()))
41

42
#ifdef DEBUG_SYNC
43
#define SYNC_DEBUG print_line("sync on: " + String(__FUNCTION__));
44
#else
45
#define SYNC_DEBUG
46
#endif
47

48
#ifdef DEBUG_ENABLED
49
#ifdef DEV_ENABLED
50
#define MAIN_THREAD_SYNC_WARN WARN_PRINT("Call to " + String(__FUNCTION__) + " causing PhysicsServer2D synchronizations on every frame. This significantly affects performance.");
51
#else
52
#define MAIN_THREAD_SYNC_WARN
53
#endif
54
#endif
55

56
class PhysicsServer2DWrapMT : public PhysicsServer2D {
57
	mutable PhysicsServer2D *physics_server_2d = nullptr;
58

59
	mutable CommandQueueMT command_queue;
60

61
	Thread::ID server_thread = Thread::UNASSIGNED_ID;
62
	WorkerThreadPool::TaskID server_task_id = WorkerThreadPool::INVALID_TASK_ID;
63
	bool exit = false;
64
	bool create_thread = false;
65
	SafeFlag doing_sync;
66

67
	void _assign_mt_ids(WorkerThreadPool::TaskID p_pump_task_id);
68
	void _thread_exit();
69
	void _thread_loop();
70
	void _thread_sync();
71

72
public:
73
#define ServerName PhysicsServer2D
74
#define ServerNameWrapMT PhysicsServer2DWrapMT
75
#define server_name physics_server_2d
76
#define WRITE_ACTION
77

78
#include "servers/server_wrap_mt_common.h"
79

80
	//FUNC1RID(shape,ShapeType); todo fix
81
	FUNCRID(world_boundary_shape)
82
	FUNCRID(separation_ray_shape)
83
	FUNCRID(segment_shape)
84
	FUNCRID(circle_shape)
85
	FUNCRID(rectangle_shape)
86
	FUNCRID(capsule_shape)
87
	FUNCRID(convex_polygon_shape)
88
	FUNCRID(concave_polygon_shape)
89

90
	FUNC2(shape_set_data, RID, const Variant &);
91
	FUNC2(shape_set_custom_solver_bias, RID, real_t);
92

93
	FUNC1RC(ShapeType, shape_get_type, RID);
94
	FUNC1RC(Variant, shape_get_data, RID);
95
	FUNC1RC(real_t, shape_get_custom_solver_bias, RID);
96

97
	//these work well, but should be used from the main thread only
98
	bool shape_collide(RID p_shape_A, const Transform2D &p_xform_A, const Vector2 &p_motion_A, RID p_shape_B, const Transform2D &p_xform_B, const Vector2 &p_motion_B, Vector2 *r_results, int p_result_max, int &r_result_count) override {
99
		ERR_FAIL_COND_V(!Thread::is_main_thread(), false);
100
		return physics_server_2d->shape_collide(p_shape_A, p_xform_A, p_motion_A, p_shape_B, p_xform_B, p_motion_B, r_results, p_result_max, r_result_count);
101
	}
102

103
	/* SPACE API */
104

105
	FUNCRID(space);
106
	FUNC2(space_set_active, RID, bool);
107
	FUNC1RC(bool, space_is_active, RID);
108

109
	FUNC3(space_set_param, RID, SpaceParameter, real_t);
110
	FUNC2RC(real_t, space_get_param, RID, SpaceParameter);
111

112
	// this function only works on physics process, errors and returns null otherwise
113
	PhysicsDirectSpaceState2D *space_get_direct_state(RID p_space) override {
114
		ERR_FAIL_COND_V(!Thread::is_main_thread(), nullptr);
115
		return physics_server_2d->space_get_direct_state(p_space);
116
	}
117

118
	FUNC2(space_set_debug_contacts, RID, int);
119
	virtual Vector<Vector2> space_get_contacts(RID p_space) const override {
120
		ERR_FAIL_COND_V(!Thread::is_main_thread(), Vector<Vector2>());
121
		return physics_server_2d->space_get_contacts(p_space);
122
	}
123

124
	virtual int space_get_contact_count(RID p_space) const override {
125
		ERR_FAIL_COND_V(!Thread::is_main_thread(), 0);
126
		return physics_server_2d->space_get_contact_count(p_space);
127
	}
128

129
	/* AREA API */
130

131
	//FUNC0RID(area);
132
	FUNCRID(area);
133

134
	FUNC2(area_set_space, RID, RID);
135
	FUNC1RC(RID, area_get_space, RID);
136

137
	FUNC4(area_add_shape, RID, RID, const Transform2D &, bool);
138
	FUNC3(area_set_shape, RID, int, RID);
139
	FUNC3(area_set_shape_transform, RID, int, const Transform2D &);
140
	FUNC3(area_set_shape_disabled, RID, int, bool);
141

142
	FUNC1RC(int, area_get_shape_count, RID);
143
	FUNC2RC(RID, area_get_shape, RID, int);
144
	FUNC2RC(Transform2D, area_get_shape_transform, RID, int);
145
	FUNC2(area_remove_shape, RID, int);
146
	FUNC1(area_clear_shapes, RID);
147

148
	FUNC2(area_attach_object_instance_id, RID, ObjectID);
149
	FUNC1RC(ObjectID, area_get_object_instance_id, RID);
150

151
	FUNC2(area_attach_canvas_instance_id, RID, ObjectID);
152
	FUNC1RC(ObjectID, area_get_canvas_instance_id, RID);
153

154
	FUNC3(area_set_param, RID, AreaParameter, const Variant &);
155
	FUNC2(area_set_transform, RID, const Transform2D &);
156

157
	FUNC2RC(Variant, area_get_param, RID, AreaParameter);
158
	FUNC1RC(Transform2D, area_get_transform, RID);
159

160
	FUNC2(area_set_collision_layer, RID, uint32_t);
161
	FUNC1RC(uint32_t, area_get_collision_layer, RID);
162

163
	FUNC2(area_set_collision_mask, RID, uint32_t);
164
	FUNC1RC(uint32_t, area_get_collision_mask, RID);
165

166
	FUNC2(area_set_monitorable, RID, bool);
167
	FUNC2(area_set_pickable, RID, bool);
168

169
	FUNC2(area_set_monitor_callback, RID, const Callable &);
170
	FUNC2(area_set_area_monitor_callback, RID, const Callable &);
171

172
	/* BODY API */
173

174
	//FUNC2RID(body,BodyMode,bool);
175
	FUNCRID(body)
176

177
	FUNC2(body_set_space, RID, RID);
178
	FUNC1RC(RID, body_get_space, RID);
179

180
	FUNC2(body_set_mode, RID, BodyMode);
181
	FUNC1RC(BodyMode, body_get_mode, RID);
182

183
	FUNC4(body_add_shape, RID, RID, const Transform2D &, bool);
184
	FUNC3(body_set_shape, RID, int, RID);
185
	FUNC3(body_set_shape_transform, RID, int, const Transform2D &);
186

187
	FUNC1RC(int, body_get_shape_count, RID);
188
	FUNC2RC(Transform2D, body_get_shape_transform, RID, int);
189
	FUNC2RC(RID, body_get_shape, RID, int);
190

191
	FUNC3(body_set_shape_disabled, RID, int, bool);
192
	FUNC4(body_set_shape_as_one_way_collision, RID, int, bool, real_t);
193

194
	FUNC2(body_remove_shape, RID, int);
195
	FUNC1(body_clear_shapes, RID);
196

197
	FUNC2(body_attach_object_instance_id, RID, ObjectID);
198
	FUNC1RC(ObjectID, body_get_object_instance_id, RID);
199

200
	FUNC2(body_attach_canvas_instance_id, RID, ObjectID);
201
	FUNC1RC(ObjectID, body_get_canvas_instance_id, RID);
202

203
	FUNC2(body_set_continuous_collision_detection_mode, RID, CCDMode);
204
	FUNC1RC(CCDMode, body_get_continuous_collision_detection_mode, RID);
205

206
	FUNC2(body_set_collision_layer, RID, uint32_t);
207
	FUNC1RC(uint32_t, body_get_collision_layer, RID);
208

209
	FUNC2(body_set_collision_mask, RID, uint32_t);
210
	FUNC1RC(uint32_t, body_get_collision_mask, RID);
211

212
	FUNC2(body_set_collision_priority, RID, real_t);
213
	FUNC1RC(real_t, body_get_collision_priority, RID);
214

215
	FUNC3(body_set_param, RID, BodyParameter, const Variant &);
216
	FUNC2RC(Variant, body_get_param, RID, BodyParameter);
217

218
	FUNC1(body_reset_mass_properties, RID);
219

220
	FUNC3(body_set_state, RID, BodyState, const Variant &);
221
	FUNC2RC(Variant, body_get_state, RID, BodyState);
222

223
	FUNC2(body_apply_central_impulse, RID, const Vector2 &);
224
	FUNC2(body_apply_torque_impulse, RID, real_t);
225
	FUNC3(body_apply_impulse, RID, const Vector2 &, const Vector2 &);
226

227
	FUNC2(body_apply_central_force, RID, const Vector2 &);
228
	FUNC3(body_apply_force, RID, const Vector2 &, const Vector2 &);
229
	FUNC2(body_apply_torque, RID, real_t);
230

231
	FUNC2(body_add_constant_central_force, RID, const Vector2 &);
232
	FUNC3(body_add_constant_force, RID, const Vector2 &, const Vector2 &);
233
	FUNC2(body_add_constant_torque, RID, real_t);
234

235
	FUNC2(body_set_constant_force, RID, const Vector2 &);
236
	FUNC1RC(Vector2, body_get_constant_force, RID);
237

238
	FUNC2(body_set_constant_torque, RID, real_t);
239
	FUNC1RC(real_t, body_get_constant_torque, RID);
240

241
	FUNC2(body_set_axis_velocity, RID, const Vector2 &);
242

243
	FUNC2(body_add_collision_exception, RID, RID);
244
	FUNC2(body_remove_collision_exception, RID, RID);
245
	FUNC2S(body_get_collision_exceptions, RID, List<RID> *);
246

247
	FUNC2(body_set_max_contacts_reported, RID, int);
248
	FUNC1RC(int, body_get_max_contacts_reported, RID);
249

250
	FUNC2(body_set_contacts_reported_depth_threshold, RID, real_t);
251
	FUNC1RC(real_t, body_get_contacts_reported_depth_threshold, RID);
252

253
	FUNC2(body_set_omit_force_integration, RID, bool);
254
	FUNC1RC(bool, body_is_omitting_force_integration, RID);
255

256
	FUNC2(body_set_state_sync_callback, RID, const Callable &);
257
	FUNC3(body_set_force_integration_callback, RID, const Callable &, const Variant &);
258

259
	bool body_collide_shape(RID p_body, int p_body_shape, RID p_shape, const Transform2D &p_shape_xform, const Vector2 &p_motion, Vector2 *r_results, int p_result_max, int &r_result_count) override {
260
		return physics_server_2d->body_collide_shape(p_body, p_body_shape, p_shape, p_shape_xform, p_motion, r_results, p_result_max, r_result_count);
261
	}
262

263
	FUNC2(body_set_pickable, RID, bool);
264

265
	bool body_test_motion(RID p_body, const MotionParameters &p_parameters, MotionResult *r_result = nullptr) override {
266
		ERR_FAIL_COND_V(!Thread::is_main_thread(), false);
267
		return physics_server_2d->body_test_motion(p_body, p_parameters, r_result);
268
	}
269

270
	// this function only works on physics process, errors and returns null otherwise
271
	PhysicsDirectBodyState2D *body_get_direct_state(RID p_body) override {
272
		ERR_FAIL_COND_V(!Thread::is_main_thread(), nullptr);
273
		return physics_server_2d->body_get_direct_state(p_body);
274
	}
275

276
	/* JOINT API */
277

278
	FUNCRID(joint)
279

280
	FUNC1(joint_clear, RID)
281

282
	FUNC3(joint_set_param, RID, JointParam, real_t);
283
	FUNC2RC(real_t, joint_get_param, RID, JointParam);
284

285
	FUNC2(joint_disable_collisions_between_bodies, RID, const bool);
286
	FUNC1RC(bool, joint_is_disabled_collisions_between_bodies, RID);
287

288
	///FUNC3RID(pin_joint,const Vector2&,RID,RID);
289
	///FUNC5RID(groove_joint,const Vector2&,const Vector2&,const Vector2&,RID,RID);
290
	///FUNC4RID(damped_spring_joint,const Vector2&,const Vector2&,RID,RID);
291

292
	//TODO need to convert this to FUNCRID, but it's a hassle..
293

294
	FUNC4(joint_make_pin, RID, const Vector2 &, RID, RID);
295
	FUNC6(joint_make_groove, RID, const Vector2 &, const Vector2 &, const Vector2 &, RID, RID);
296
	FUNC5(joint_make_damped_spring, RID, const Vector2 &, const Vector2 &, RID, RID);
297

298
	FUNC3(pin_joint_set_param, RID, PinJointParam, real_t);
299
	FUNC2RC(real_t, pin_joint_get_param, RID, PinJointParam);
300

301
	FUNC3(pin_joint_set_flag, RID, PinJointFlag, bool);
302
	FUNC2RC(bool, pin_joint_get_flag, RID, PinJointFlag);
303

304
	FUNC3(damped_spring_joint_set_param, RID, DampedSpringParam, real_t);
305
	FUNC2RC(real_t, damped_spring_joint_get_param, RID, DampedSpringParam);
306

307
	FUNC1RC(JointType, joint_get_type, RID);
308

309
	/* MISC */
310

311
	FUNC1(free, RID);
312
	FUNC1(set_active, bool);
313

314
	virtual void init() override;
315
	virtual void step(real_t p_step) override;
316
	virtual void sync() override;
317
	virtual void end_sync() override;
318
	virtual void flush_queries() override;
319
	virtual void finish() override;
320

321
	virtual bool is_flushing_queries() const override {
322
		return physics_server_2d->is_flushing_queries();
323
	}
324

325
	int get_process_info(ProcessInfo p_info) override {
326
		return physics_server_2d->get_process_info(p_info);
327
	}
328

329
	PhysicsServer2DWrapMT(PhysicsServer2D *p_contained, bool p_create_thread);
330
	~PhysicsServer2DWrapMT();
331

332
#undef ServerNameWrapMT
333
#undef ServerName
334
#undef server_name
335
#undef WRITE_ACTION
336
};
337

338
#ifdef DEBUG_SYNC
339
#undef DEBUG_SYNC
340
#endif
341
#undef SYNC_DEBUG
342

343
#ifdef DEBUG_ENABLED
344
#undef MAIN_THREAD_SYNC_WARN
345
#endif
346

347
Product

Resources

Company
