boxddd 0.3.0

Safe, ergonomic Rust bindings for Box3D
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

use super::*;

impl World {
    /// Tries to create a body in this world.
    pub fn create_body(&mut self, def: BodyDef) -> Result<BodyId> {
        callback_state::check_not_in_callback()?;
        let prepared = def.prepare()?;
        let pending = self.state.ledger.reserve_body()?;
        let _guard = box3d_lock::lock();
        self.check_world_valid_locked()?;
        let raw_def = prepared.lower_locked();
        let raw = unsafe { ffi::b3CreateBody(self.raw, &raw_def) };
        if unsafe { ffi::b3Body_IsValid(raw) } {
            Ok(self.state.ledger.publish_body(raw, pending))
        } else {
            Err(Error::NativeFailure)
        }
    }

    /// Tries to attach a sphere shape to a body.
    pub fn create_sphere_shape(
        &mut self,
        body_id: BodyId,
        def: &ShapeDef,
        sphere: &Sphere,
    ) -> Result<ShapeId> {
        callback_state::check_not_in_callback()?;
        let mut prepared = def.prepare(ShapeMaterialUsage::BaseOnly)?;
        sphere.validate()?;
        let pending = self.state.ledger.reserve_shape(body_id, None)?;
        let _guard = self.lock_body_checked(body_id)?;
        let raw_def = prepared.lower_locked();
        let raw = unsafe { ffi::b3CreateSphereShape(body_id.into_raw(), &raw_def, sphere.raw()) };
        if unsafe { ffi::b3Shape_IsValid(raw) } {
            Ok(self.state.ledger.publish_shape(raw, pending))
        } else {
            Err(Error::NativeFailure)
        }
    }

    /// Tries to attach a box-hull shape to a body.
    pub fn create_hull_shape(
        &mut self,
        body_id: BodyId,
        def: &ShapeDef,
        hull: &BoxHull,
    ) -> Result<ShapeId> {
        callback_state::check_not_in_callback()?;
        let mut prepared = def.prepare(ShapeMaterialUsage::BaseOnly)?;
        let pending = self.state.ledger.reserve_shape(body_id, None)?;
        let _guard = self.lock_body_checked(body_id)?;
        let raw_def = prepared.lower_locked();
        let raw = unsafe { ffi::b3CreateHullShape(body_id.into_raw(), &raw_def, hull.hull_data()) };
        if unsafe { ffi::b3Shape_IsValid(raw) } {
            Ok(self.state.ledger.publish_shape(raw, pending))
        } else {
            Err(Error::NativeFailure)
        }
    }

    /// Tries to attach a capsule shape to a body.
    pub fn create_capsule_shape(
        &mut self,
        body_id: BodyId,
        def: &ShapeDef,
        capsule: &Capsule,
    ) -> Result<ShapeId> {
        callback_state::check_not_in_callback()?;
        let mut prepared = def.prepare(ShapeMaterialUsage::BaseOnly)?;
        capsule.validate()?;
        let pending = self.state.ledger.reserve_shape(body_id, None)?;
        let _guard = self.lock_body_checked(body_id)?;
        let raw_def = prepared.lower_locked();
        let raw = unsafe { ffi::b3CreateCapsuleShape(body_id.into_raw(), &raw_def, capsule.raw()) };
        if unsafe { ffi::b3Shape_IsValid(raw) } {
            Ok(self.state.ledger.publish_shape(raw, pending))
        } else {
            Err(Error::NativeFailure)
        }
    }

    /// Tries to attach an owned convex hull resource to a body.
    pub fn create_created_hull_shape(
        &mut self,
        body_id: BodyId,
        def: &ShapeDef,
        hull: &Hull,
    ) -> Result<ShapeId> {
        callback_state::check_not_in_callback()?;
        let mut prepared = def.prepare(ShapeMaterialUsage::BaseOnly)?;
        let pending = self.state.ledger.reserve_shape(body_id, None)?;
        let _guard = self.lock_body_checked(body_id)?;
        let raw_def = prepared.lower_locked();
        let raw = unsafe { ffi::b3CreateHullShape(body_id.into_raw(), &raw_def, hull.as_ptr()) };
        if unsafe { ffi::b3Shape_IsValid(raw) } {
            Ok(self.state.ledger.publish_shape(raw, pending))
        } else {
            Err(Error::NativeFailure)
        }
    }

    /// Tries to attach a transformed owned convex hull resource to a body.
    pub fn create_transformed_hull_shape(
        &mut self,
        body_id: BodyId,
        def: &ShapeDef,
        hull: &Hull,
        transform: impl Into<crate::types::Transform>,
        scale: impl Into<Vec3>,
    ) -> Result<ShapeId> {
        callback_state::check_not_in_callback()?;
        let mut prepared = def.prepare(ShapeMaterialUsage::BaseOnly)?;
        let transform = transform.into();
        transform.validate()?;
        let scale = scale.into().validate()?;
        let pending = self.state.ledger.reserve_shape(body_id, None)?;
        let _guard = self.lock_body_checked(body_id)?;
        let raw_def = prepared.lower_locked();
        let raw = unsafe {
            ffi::b3CreateTransformedHullShape(
                body_id.into_raw(),
                &raw_def,
                hull.as_ptr(),
                transform.into_raw(),
                scale.into_raw(),
            )
        };
        if unsafe { ffi::b3Shape_IsValid(raw) } {
            Ok(self.state.ledger.publish_shape(raw, pending))
        } else {
            Err(Error::NativeFailure)
        }
    }

    /// Tries to attach a triangle mesh shape to a static body.
    pub fn create_mesh_shape(
        &mut self,
        body_id: BodyId,
        def: &ShapeDef,
        mesh: MeshData,
        scale: impl Into<Vec3>,
    ) -> Result<ShapeId> {
        callback_state::check_not_in_callback()?;
        let mut prepared = def.prepare(ShapeMaterialUsage::PerTriangle)?;
        let scale = validate_mesh_scale(scale.into())?;
        if self.body_type(body_id)? != BodyType::Static {
            return Err(validation::invalid(
                "mesh_shape.body_type",
                crate::error::InvalidValueReason::InvalidCombination,
            ));
        }
        let mesh_ptr = mesh.as_ptr();
        let pending = self
            .state
            .ledger
            .reserve_shape(body_id, Some(ShapeResource::Mesh { _data: mesh }))?;
        let _guard = self.lock_body_checked(body_id)?;
        let raw_def = prepared.lower_locked();
        let raw = unsafe {
            ffi::b3CreateMeshShape(body_id.into_raw(), &raw_def, mesh_ptr, scale.into_raw())
        };
        if !unsafe { ffi::b3Shape_IsValid(raw) } {
            return Err(Error::NativeFailure);
        }
        Ok(self.state.ledger.publish_shape(raw, pending))
    }

    /// Tries to attach a height-field shape to a static body.
    pub fn create_height_field_shape(
        &mut self,
        body_id: BodyId,
        def: &ShapeDef,
        height_field: HeightField,
    ) -> Result<ShapeId> {
        callback_state::check_not_in_callback()?;
        let mut prepared = def.prepare(ShapeMaterialUsage::PerTriangle)?;
        if self.body_type(body_id)? != BodyType::Static {
            return Err(validation::invalid(
                "height_field_shape.body_type",
                crate::error::InvalidValueReason::InvalidCombination,
            ));
        }
        let height_field_ptr = height_field.as_ptr();
        let pending = self.state.ledger.reserve_shape(
            body_id,
            Some(ShapeResource::HeightField {
                _data: height_field,
            }),
        )?;
        let _guard = self.lock_body_checked(body_id)?;
        let raw_def = prepared.lower_locked();
        let raw = unsafe {
            ffi::b3CreateHeightFieldShape(body_id.into_raw(), &raw_def, height_field_ptr)
        };
        if !unsafe { ffi::b3Shape_IsValid(raw) } {
            return Err(Error::NativeFailure);
        }
        Ok(self.state.ledger.publish_shape(raw, pending))
    }

    /// Tries to attach a compound shape to a static body.
    pub fn create_compound_shape(
        &mut self,
        body_id: BodyId,
        def: &ShapeDef,
        compound: Compound,
    ) -> Result<ShapeId> {
        callback_state::check_not_in_callback()?;
        let mut prepared = def.prepare(ShapeMaterialUsage::BaseOnly)?;
        if def.sensor {
            return Err(validation::invalid(
                "compound_shape.sensor",
                crate::error::InvalidValueReason::InvalidCombination,
            ));
        }
        if self.body_type(body_id)? != BodyType::Static {
            return Err(validation::invalid(
                "compound_shape.body_type",
                crate::error::InvalidValueReason::InvalidCombination,
            ));
        }
        let compound_ptr = compound.as_ptr();
        let pending = self
            .state
            .ledger
            .reserve_shape(body_id, Some(ShapeResource::Compound { _data: compound }))?;
        let _guard = self.lock_body_checked(body_id)?;
        let mut raw_def = prepared.lower_locked();
        let raw = unsafe {
            ffi::b3CreateBakedCompoundShape(body_id.into_raw(), &mut raw_def, compound_ptr)
        };
        if !unsafe { ffi::b3Shape_IsValid(raw) } {
            return Err(Error::NativeFailure);
        }
        Ok(self.state.ledger.publish_shape(raw, pending))
    }
}