boxdd 0.2.0

Safe, ergonomic Rust bindings for Box2D v3
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273

//! Unchecked, `unsafe` convenience APIs for hot paths.
//!
//! This module is gated behind the `unchecked` feature.
//! All methods here are `unsafe` and skip runtime id validity checks.
// Most APIs here are intentionally minimal; keep clippy's per-item safety doc requirement off.
#![allow(clippy::missing_safety_doc)]

use boxdd_sys::ffi;

use crate::body::{BodyType, OwnedBody};
use crate::joints::OwnedJoint;
use crate::shapes::chain::OwnedChain;
use crate::shapes::{OwnedShape, SurfaceMaterial};
use crate::types::{BodyId, ChainId, JointId, ShapeId, Vec2};
use crate::{Body, Joint, Shape, Transform, World};

pub trait WorldUncheckedExt {
    unsafe fn body_transform_unchecked(&self, body: BodyId) -> Transform;
    unsafe fn body_position_unchecked(&self, body: BodyId) -> Vec2;
    unsafe fn set_body_linear_velocity_unchecked(&mut self, body: BodyId, v: Vec2);
    unsafe fn set_body_angular_velocity_unchecked(&mut self, body: BodyId, w: f32);
    unsafe fn set_body_type_unchecked(&mut self, body: BodyId, t: BodyType);

    unsafe fn shape_body_unchecked(&self, shape: ShapeId) -> BodyId;
    unsafe fn shape_type_unchecked(&self, shape: ShapeId) -> ffi::b2ShapeType;
}

impl WorldUncheckedExt for World {
    unsafe fn body_transform_unchecked(&self, body: BodyId) -> Transform {
        Transform::from(unsafe { ffi::b2Body_GetTransform(body) })
    }
    unsafe fn body_position_unchecked(&self, body: BodyId) -> Vec2 {
        Vec2::from(unsafe { ffi::b2Body_GetPosition(body) })
    }
    unsafe fn set_body_linear_velocity_unchecked(&mut self, body: BodyId, v: Vec2) {
        let vv: ffi::b2Vec2 = v.into();
        unsafe { ffi::b2Body_SetLinearVelocity(body, vv) }
    }
    unsafe fn set_body_angular_velocity_unchecked(&mut self, body: BodyId, w: f32) {
        unsafe { ffi::b2Body_SetAngularVelocity(body, w) }
    }
    unsafe fn set_body_type_unchecked(&mut self, body: BodyId, t: BodyType) {
        unsafe { ffi::b2Body_SetType(body, t.into()) }
    }

    unsafe fn shape_body_unchecked(&self, shape: ShapeId) -> BodyId {
        unsafe { ffi::b2Shape_GetBody(shape) }
    }
    unsafe fn shape_type_unchecked(&self, shape: ShapeId) -> ffi::b2ShapeType {
        unsafe { ffi::b2Shape_GetType(shape) }
    }
}

pub trait BodyUncheckedExt {
    unsafe fn position_unchecked(&self) -> Vec2;
    unsafe fn linear_velocity_unchecked(&self) -> Vec2;
    unsafe fn angular_velocity_unchecked(&self) -> f32;
    unsafe fn transform_unchecked(&self) -> ffi::b2Transform;
    unsafe fn set_linear_velocity_unchecked(&mut self, v: Vec2);
    unsafe fn set_angular_velocity_unchecked(&mut self, w: f32);
    unsafe fn body_type_unchecked(&self) -> BodyType;
    unsafe fn set_body_type_unchecked(&mut self, t: BodyType);
    unsafe fn set_gravity_scale_unchecked(&mut self, v: f32);
    unsafe fn gravity_scale_unchecked(&self) -> f32;
}

impl<'w> BodyUncheckedExt for Body<'w> {
    unsafe fn position_unchecked(&self) -> Vec2 {
        Vec2::from(unsafe { ffi::b2Body_GetPosition(self.id) })
    }
    unsafe fn linear_velocity_unchecked(&self) -> Vec2 {
        Vec2::from(unsafe { ffi::b2Body_GetLinearVelocity(self.id) })
    }
    unsafe fn angular_velocity_unchecked(&self) -> f32 {
        unsafe { ffi::b2Body_GetAngularVelocity(self.id) }
    }
    unsafe fn transform_unchecked(&self) -> ffi::b2Transform {
        unsafe { ffi::b2Body_GetTransform(self.id) }
    }
    unsafe fn set_linear_velocity_unchecked(&mut self, v: Vec2) {
        let vv: ffi::b2Vec2 = v.into();
        unsafe { ffi::b2Body_SetLinearVelocity(self.id, vv) }
    }
    unsafe fn set_angular_velocity_unchecked(&mut self, w: f32) {
        unsafe { ffi::b2Body_SetAngularVelocity(self.id, w) }
    }
    unsafe fn body_type_unchecked(&self) -> BodyType {
        BodyType::from(unsafe { ffi::b2Body_GetType(self.id) })
    }
    unsafe fn set_body_type_unchecked(&mut self, t: BodyType) {
        unsafe { ffi::b2Body_SetType(self.id, t.into()) }
    }
    unsafe fn set_gravity_scale_unchecked(&mut self, v: f32) {
        unsafe { ffi::b2Body_SetGravityScale(self.id, v) }
    }
    unsafe fn gravity_scale_unchecked(&self) -> f32 {
        unsafe { ffi::b2Body_GetGravityScale(self.id) }
    }
}

impl BodyUncheckedExt for OwnedBody {
    unsafe fn position_unchecked(&self) -> Vec2 {
        Vec2::from(unsafe { ffi::b2Body_GetPosition(self.id()) })
    }
    unsafe fn linear_velocity_unchecked(&self) -> Vec2 {
        Vec2::from(unsafe { ffi::b2Body_GetLinearVelocity(self.id()) })
    }
    unsafe fn angular_velocity_unchecked(&self) -> f32 {
        unsafe { ffi::b2Body_GetAngularVelocity(self.id()) }
    }
    unsafe fn transform_unchecked(&self) -> ffi::b2Transform {
        unsafe { ffi::b2Body_GetTransform(self.id()) }
    }
    unsafe fn set_linear_velocity_unchecked(&mut self, v: Vec2) {
        let vv: ffi::b2Vec2 = v.into();
        unsafe { ffi::b2Body_SetLinearVelocity(self.id(), vv) }
    }
    unsafe fn set_angular_velocity_unchecked(&mut self, w: f32) {
        unsafe { ffi::b2Body_SetAngularVelocity(self.id(), w) }
    }
    unsafe fn body_type_unchecked(&self) -> BodyType {
        BodyType::from(unsafe { ffi::b2Body_GetType(self.id()) })
    }
    unsafe fn set_body_type_unchecked(&mut self, t: BodyType) {
        unsafe { ffi::b2Body_SetType(self.id(), t.into()) }
    }
    unsafe fn set_gravity_scale_unchecked(&mut self, v: f32) {
        unsafe { ffi::b2Body_SetGravityScale(self.id(), v) }
    }
    unsafe fn gravity_scale_unchecked(&self) -> f32 {
        unsafe { ffi::b2Body_GetGravityScale(self.id()) }
    }
}

pub trait ShapeUncheckedExt {
    unsafe fn shape_type_unchecked(&self) -> ffi::b2ShapeType;
    unsafe fn body_id_unchecked(&self) -> BodyId;
    unsafe fn density_unchecked(&self) -> f32;
    unsafe fn set_density_unchecked(&mut self, density: f32, update_body_mass: bool);
    unsafe fn set_surface_material_unchecked(&mut self, material: &SurfaceMaterial);
}

impl<'w> ShapeUncheckedExt for Shape<'w> {
    unsafe fn shape_type_unchecked(&self) -> ffi::b2ShapeType {
        unsafe { ffi::b2Shape_GetType(self.id) }
    }
    unsafe fn body_id_unchecked(&self) -> BodyId {
        unsafe { ffi::b2Shape_GetBody(self.id) }
    }
    unsafe fn density_unchecked(&self) -> f32 {
        unsafe { ffi::b2Shape_GetDensity(self.id) }
    }
    unsafe fn set_density_unchecked(&mut self, density: f32, update_body_mass: bool) {
        unsafe { ffi::b2Shape_SetDensity(self.id, density, update_body_mass) }
    }
    unsafe fn set_surface_material_unchecked(&mut self, material: &SurfaceMaterial) {
        unsafe { ffi::b2Shape_SetSurfaceMaterial(self.id, &material.0) }
    }
}

impl ShapeUncheckedExt for OwnedShape {
    unsafe fn shape_type_unchecked(&self) -> ffi::b2ShapeType {
        unsafe { ffi::b2Shape_GetType(self.id()) }
    }
    unsafe fn body_id_unchecked(&self) -> BodyId {
        unsafe { ffi::b2Shape_GetBody(self.id()) }
    }
    unsafe fn density_unchecked(&self) -> f32 {
        unsafe { ffi::b2Shape_GetDensity(self.id()) }
    }
    unsafe fn set_density_unchecked(&mut self, density: f32, update_body_mass: bool) {
        unsafe { ffi::b2Shape_SetDensity(self.id(), density, update_body_mass) }
    }
    unsafe fn set_surface_material_unchecked(&mut self, material: &SurfaceMaterial) {
        unsafe { ffi::b2Shape_SetSurfaceMaterial(self.id(), &material.0) }
    }
}

pub trait JointUncheckedExt {
    unsafe fn force_threshold_unchecked(&self) -> f32;
    unsafe fn set_force_threshold_unchecked(&mut self, threshold: f32);
    unsafe fn user_data_ptr_unchecked(&self) -> *mut core::ffi::c_void;
    unsafe fn set_user_data_ptr_unchecked(&mut self, p: *mut core::ffi::c_void);
}

impl<'w> JointUncheckedExt for Joint<'w> {
    unsafe fn force_threshold_unchecked(&self) -> f32 {
        unsafe { ffi::b2Joint_GetForceThreshold(self.id) }
    }
    unsafe fn set_force_threshold_unchecked(&mut self, threshold: f32) {
        unsafe { ffi::b2Joint_SetForceThreshold(self.id, threshold) }
    }
    unsafe fn user_data_ptr_unchecked(&self) -> *mut core::ffi::c_void {
        unsafe { ffi::b2Joint_GetUserData(self.id) }
    }
    unsafe fn set_user_data_ptr_unchecked(&mut self, p: *mut core::ffi::c_void) {
        unsafe { ffi::b2Joint_SetUserData(self.id, p) }
    }
}

impl JointUncheckedExt for OwnedJoint {
    unsafe fn force_threshold_unchecked(&self) -> f32 {
        unsafe { ffi::b2Joint_GetForceThreshold(self.id()) }
    }
    unsafe fn set_force_threshold_unchecked(&mut self, threshold: f32) {
        unsafe { ffi::b2Joint_SetForceThreshold(self.id(), threshold) }
    }
    unsafe fn user_data_ptr_unchecked(&self) -> *mut core::ffi::c_void {
        unsafe { ffi::b2Joint_GetUserData(self.id()) }
    }
    unsafe fn set_user_data_ptr_unchecked(&mut self, p: *mut core::ffi::c_void) {
        unsafe { ffi::b2Joint_SetUserData(self.id(), p) }
    }
}

pub trait ChainUncheckedExt {
    unsafe fn segment_count_unchecked(&self) -> i32;
    unsafe fn segments_unchecked(&self) -> Vec<ShapeId>;
    unsafe fn surface_material_unchecked(&self, index: i32) -> SurfaceMaterial;
    unsafe fn set_surface_material_unchecked(&mut self, index: i32, material: &SurfaceMaterial);
}

impl ChainUncheckedExt for OwnedChain {
    unsafe fn segment_count_unchecked(&self) -> i32 {
        unsafe { ffi::b2Chain_GetSegmentCount(self.id()) }
    }
    unsafe fn segments_unchecked(&self) -> Vec<ShapeId> {
        let count = unsafe { ffi::b2Chain_GetSegmentCount(self.id()) }.max(0) as usize;
        if count == 0 {
            return Vec::new();
        }
        let mut vec: Vec<ShapeId> = Vec::with_capacity(count);
        let wrote = unsafe { ffi::b2Chain_GetSegments(self.id(), vec.as_mut_ptr(), count as i32) }
            .max(0) as usize;
        unsafe { vec.set_len(wrote.min(count)) };
        vec
    }
    unsafe fn surface_material_unchecked(&self, index: i32) -> SurfaceMaterial {
        SurfaceMaterial(unsafe { ffi::b2Chain_GetSurfaceMaterial(self.id(), index) })
    }
    unsafe fn set_surface_material_unchecked(&mut self, index: i32, material: &SurfaceMaterial) {
        unsafe { ffi::b2Chain_SetSurfaceMaterial(self.id(), &material.0, index) }
    }
}

impl<'w> ChainUncheckedExt for crate::shapes::chain::Chain<'w> {
    unsafe fn segment_count_unchecked(&self) -> i32 {
        unsafe { ffi::b2Chain_GetSegmentCount(self.id) }
    }
    unsafe fn segments_unchecked(&self) -> Vec<ShapeId> {
        let count = unsafe { ffi::b2Chain_GetSegmentCount(self.id) }.max(0) as usize;
        if count == 0 {
            return Vec::new();
        }
        let mut vec: Vec<ShapeId> = Vec::with_capacity(count);
        let wrote = unsafe { ffi::b2Chain_GetSegments(self.id, vec.as_mut_ptr(), count as i32) }
            .max(0) as usize;
        unsafe { vec.set_len(wrote.min(count)) };
        vec
    }
    unsafe fn surface_material_unchecked(&self, index: i32) -> SurfaceMaterial {
        SurfaceMaterial(unsafe { ffi::b2Chain_GetSurfaceMaterial(self.id, index) })
    }
    unsafe fn set_surface_material_unchecked(&mut self, index: i32, material: &SurfaceMaterial) {
        unsafe { ffi::b2Chain_SetSurfaceMaterial(self.id, &material.0, index) }
    }
}

// Re-export some ids to make `unchecked` imports feel self-contained.
pub type UncheckedBodyId = BodyId;
pub type UncheckedShapeId = ShapeId;
pub type UncheckedJointId = JointId;
pub type UncheckedChainId = ChainId;