boxddd 0.2.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

//! FFI-compatible ids for native Box3D resources.

use super::*;

/// Handle id for a body in a Box3D world.
#[repr(C)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, Hash)]
pub struct BodyId {
    /// One-based native index. Zero is an invalid/null id.
    pub index1: i32,
    /// Native world index this id belongs to.
    pub world0: u16,
    /// Native generation used to reject stale ids.
    pub generation: u16,
}

impl BodyId {
    /// Converts a raw Box3D body id into the Rust value type.
    #[inline]
    pub const fn from_raw(raw: ffi::b3BodyId) -> Self {
        Self {
            index1: raw.index1,
            world0: raw.world0,
            generation: raw.generation,
        }
    }

    /// Converts this value into the raw Box3D representation.
    #[inline]
    pub const fn into_raw(self) -> ffi::b3BodyId {
        ffi::b3BodyId {
            index1: self.index1,
            world0: self.world0,
            generation: self.generation,
        }
    }

    /// Returns whether the native id currently names a valid body.
    #[inline]
    pub fn is_valid(self) -> bool {
        unsafe { ffi::b3Body_IsValid(self.into_raw()) }
    }
}

/// Handle id for a shape in a Box3D world.
#[repr(C)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, Hash)]
pub struct ShapeId {
    /// One-based native index. Zero is an invalid/null id.
    pub index1: i32,
    /// Native world index this id belongs to.
    pub world0: u16,
    /// Native generation used to reject stale ids.
    pub generation: u16,
}

impl ShapeId {
    /// Converts a raw Box3D shape id into the Rust value type.
    #[inline]
    pub const fn from_raw(raw: ffi::b3ShapeId) -> Self {
        Self {
            index1: raw.index1,
            world0: raw.world0,
            generation: raw.generation,
        }
    }

    /// Converts this value into the raw Box3D representation.
    #[inline]
    pub const fn into_raw(self) -> ffi::b3ShapeId {
        ffi::b3ShapeId {
            index1: self.index1,
            world0: self.world0,
            generation: self.generation,
        }
    }

    /// Returns whether the native id currently names a valid shape.
    #[inline]
    pub fn is_valid(self) -> bool {
        unsafe { ffi::b3Shape_IsValid(self.into_raw()) }
    }
}

/// Handle id for a joint in a Box3D world.
#[repr(C)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, Hash)]
pub struct JointId {
    /// One-based native index. Zero is an invalid/null id.
    pub index1: i32,
    /// Native world index this id belongs to.
    pub world0: u16,
    /// Native generation used to reject stale ids.
    pub generation: u16,
}

impl JointId {
    /// Converts a raw Box3D joint id into the Rust value type.
    #[inline]
    pub const fn from_raw(raw: ffi::b3JointId) -> Self {
        Self {
            index1: raw.index1,
            world0: raw.world0,
            generation: raw.generation,
        }
    }

    /// Converts this value into the raw Box3D representation.
    #[inline]
    pub const fn into_raw(self) -> ffi::b3JointId {
        ffi::b3JointId {
            index1: self.index1,
            world0: self.world0,
            generation: self.generation,
        }
    }

    /// Returns whether the native id currently names a valid joint.
    #[inline]
    pub fn is_valid(self) -> bool {
        unsafe { ffi::b3Joint_IsValid(self.into_raw()) }
    }
}

/// Handle id for a contact in a Box3D world.
#[repr(C)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, Hash)]
pub struct ContactId {
    /// One-based native index. Zero is an invalid/null id.
    pub index1: i32,
    /// Native world index this id belongs to.
    pub world0: u16,
    /// Native padding field preserved for ABI compatibility.
    pub padding: i16,
    /// Native generation used to reject stale ids.
    pub generation: u32,
}

impl ContactId {
    /// Converts a raw Box3D contact id into the Rust value type.
    #[inline]
    pub const fn from_raw(raw: ffi::b3ContactId) -> Self {
        Self {
            index1: raw.index1,
            world0: raw.world0,
            padding: raw.padding,
            generation: raw.generation,
        }
    }

    /// Converts this value into the raw Box3D representation.
    #[inline]
    pub const fn into_raw(self) -> ffi::b3ContactId {
        ffi::b3ContactId {
            index1: self.index1,
            world0: self.world0,
            padding: self.padding,
            generation: self.generation,
        }
    }

    /// Returns whether the native id currently names a valid contact.
    #[inline]
    pub fn is_valid(self) -> bool {
        unsafe { ffi::b3Contact_IsValid(self.into_raw()) }
    }
}

const _: () = {
    assert!(::core::mem::size_of::<Vec2>() == ::core::mem::size_of::<ffi::b3Vec2>());
    assert!(::core::mem::align_of::<Vec2>() == ::core::mem::align_of::<ffi::b3Vec2>());
    assert!(::core::mem::size_of::<Vec3>() == ::core::mem::size_of::<ffi::b3Vec3>());
    assert!(::core::mem::align_of::<Vec3>() == ::core::mem::align_of::<ffi::b3Vec3>());
    assert!(::core::mem::size_of::<Quat>() == ::core::mem::size_of::<ffi::b3Quat>());
    assert!(::core::mem::align_of::<Quat>() == ::core::mem::align_of::<ffi::b3Quat>());
    assert!(::core::mem::size_of::<Transform>() == ::core::mem::size_of::<ffi::b3Transform>());
    assert!(::core::mem::align_of::<Transform>() == ::core::mem::align_of::<ffi::b3Transform>());
    assert!(::core::mem::size_of::<Pos>() == ::core::mem::size_of::<ffi::b3Pos>());
    assert!(::core::mem::align_of::<Pos>() == ::core::mem::align_of::<ffi::b3Pos>());
    assert!(
        ::core::mem::size_of::<WorldTransform>() == ::core::mem::size_of::<ffi::b3WorldTransform>()
    );
    assert!(
        ::core::mem::align_of::<WorldTransform>()
            == ::core::mem::align_of::<ffi::b3WorldTransform>()
    );
    assert!(::core::mem::size_of::<Matrix3>() == ::core::mem::size_of::<ffi::b3Matrix3>());
    assert!(::core::mem::align_of::<Matrix3>() == ::core::mem::align_of::<ffi::b3Matrix3>());
    assert!(::core::mem::size_of::<Aabb>() == ::core::mem::size_of::<ffi::b3AABB>());
    assert!(::core::mem::align_of::<Aabb>() == ::core::mem::align_of::<ffi::b3AABB>());
    assert!(::core::mem::size_of::<Plane>() == ::core::mem::size_of::<ffi::b3Plane>());
    assert!(::core::mem::align_of::<Plane>() == ::core::mem::align_of::<ffi::b3Plane>());
    assert!(::core::mem::size_of::<Filter>() == ::core::mem::size_of::<ffi::b3Filter>());
    assert!(::core::mem::align_of::<Filter>() == ::core::mem::align_of::<ffi::b3Filter>());
    assert!(::core::mem::size_of::<MassData>() == ::core::mem::size_of::<ffi::b3MassData>());
    assert!(::core::mem::align_of::<MassData>() == ::core::mem::align_of::<ffi::b3MassData>());
    assert!(::core::mem::size_of::<MotionLocks>() == ::core::mem::size_of::<ffi::b3MotionLocks>());
    assert!(
        ::core::mem::align_of::<MotionLocks>() == ::core::mem::align_of::<ffi::b3MotionLocks>()
    );
    assert!(::core::mem::size_of::<Capacity>() == ::core::mem::size_of::<ffi::b3Capacity>());
    assert!(::core::mem::align_of::<Capacity>() == ::core::mem::align_of::<ffi::b3Capacity>());
    assert!(::core::mem::size_of::<BodyId>() == ::core::mem::size_of::<ffi::b3BodyId>());
    assert!(::core::mem::align_of::<BodyId>() == ::core::mem::align_of::<ffi::b3BodyId>());
    assert!(::core::mem::size_of::<ShapeId>() == ::core::mem::size_of::<ffi::b3ShapeId>());
    assert!(::core::mem::align_of::<ShapeId>() == ::core::mem::align_of::<ffi::b3ShapeId>());
    assert!(::core::mem::size_of::<JointId>() == ::core::mem::size_of::<ffi::b3JointId>());
    assert!(::core::mem::align_of::<JointId>() == ::core::mem::align_of::<ffi::b3JointId>());
    assert!(::core::mem::size_of::<ContactId>() == ::core::mem::size_of::<ffi::b3ContactId>());
    assert!(::core::mem::align_of::<ContactId>() == ::core::mem::align_of::<ffi::b3ContactId>());
};