boxdd 0.6.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

//! Shapes API
//!
//! Safe wrappers around Box2D shapes. Shapes are attached to bodies and can be
//! modified at runtime. Use `ShapeDef` plus a borrowed `Body` capability to create shapes.
pub mod chain;
mod creation;
mod definition;
pub mod geometry;
pub mod helpers;
mod runtime;
mod scoped;

use crate::body::Body;
use crate::error::{Error, Result};
use crate::filter::Filter;
use crate::query::Aabb;
use crate::types::{
    BodyId, ChainId, ContactData, MassData, Position, ShapeId, Vec2, WorldCastOutput,
};
use boxdd_sys::ffi;
use std::os::raw::c_void;

pub(crate) use runtime::*;

pub use definition::{ShapeDef, ShapeDefBuilder, SurfaceMaterial};
pub use geometry::{
    Capsule, ChainSegment, Circle, MAX_POLYGON_VERTICES, Polygon, Segment, box_polygon, capsule,
    chain_segment, circle, offset_box_polygon, offset_polygon_from_points,
    offset_rounded_box_polygon, polygon_from_points, polygon_hull_is_valid, rounded_box_polygon,
    segment, square_polygon,
};
pub use scoped::Shape;

/// Shape kinds reported by Box2D.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub enum ShapeType {
    Circle,
    Capsule,
    Segment,
    Polygon,
    ChainSegment,
}

impl ShapeType {
    #[inline]
    pub const fn from_raw(raw: ffi::b2ShapeType) -> Option<Self> {
        match raw {
            ffi::b2ShapeType_b2_circleShape => Some(Self::Circle),
            ffi::b2ShapeType_b2_capsuleShape => Some(Self::Capsule),
            ffi::b2ShapeType_b2_segmentShape => Some(Self::Segment),
            ffi::b2ShapeType_b2_polygonShape => Some(Self::Polygon),
            ffi::b2ShapeType_b2_chainSegmentShape => Some(Self::ChainSegment),
            _ => None,
        }
    }

    #[inline]
    pub const fn into_raw(self) -> ffi::b2ShapeType {
        match self {
            Self::Circle => ffi::b2ShapeType_b2_circleShape,
            Self::Capsule => ffi::b2ShapeType_b2_capsuleShape,
            Self::Segment => ffi::b2ShapeType_b2_segmentShape,
            Self::Polygon => ffi::b2ShapeType_b2_polygonShape,
            Self::ChainSegment => ffi::b2ShapeType_b2_chainSegmentShape,
        }
    }

    #[inline]
    pub(crate) fn decode_native(raw: ffi::b2ShapeType) -> Result<Self> {
        Self::from_raw(raw).ok_or(Error::InvalidNativeShapeType { raw })
    }
}

impl TryFrom<ffi::b2ShapeType> for ShapeType {
    type Error = ffi::b2ShapeType;

    #[inline]
    fn try_from(value: ffi::b2ShapeType) -> std::result::Result<Self, Self::Error> {
        Self::from_raw(value).ok_or(value)
    }
}