bevy_collider_gen 0.3.0

a library for generating colliders, for bevy apps, from images with transparency
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

use bevy_rapier2d::prelude::Collider;
use edges::{Edges, Vec2};

use crate::{utils::heights_and_scale, ColliderType};

fn to_collider(collider_type: ColliderType, points: Vec<Vec2>) -> Option<Collider> {
    match collider_type {
        ColliderType::Polyline => Some(Collider::polyline(points, None)),
        ColliderType::ConvexPolyline => Collider::convex_polyline(points),
        ColliderType::ConvexHull => Collider::convex_hull(&points),
        ColliderType::Heightfield => {
            let (heights, scale) = heights_and_scale(points);
            Some(Collider::heightfield(heights, scale))
        }
    }
}

/// Generates a collider from the provided image.
///
/// This function processes the input image and creates a collider of the specified type.
/// The collider can be translated based on the `translate` flag.
///
/// # Parameters
/// - `image`: The input image from which to generate the collider. The type `I` must implement `From<I>` for `Edges`.
/// - `collider_type`: Specifies the type of collider to create (e.g., `Polyline`, `ConvexHull`, etc.).
/// - `translate`: A boolean flag indicating whether to apply translation during collider generation.
///
/// # Returns
/// Returns an `Option<Collider>`. If the collider is successfully generated, it returns `Some(Collider)`,
/// otherwise, it returns `None` if the generation fails.
///
/// # Example
/// ```
/// let collider = generate_collider(image, ColliderType::Polyline, true);
/// ```
#[must_use]
pub fn generate_collider<I>(
    image: I,
    collider_type: ColliderType,
    translate: bool,
) -> Option<Collider>
where
    Edges: From<I>,
{
    crate::utils::generate_collider(
        image,
        |points| to_collider(collider_type, points),
        translate,
    )
}

/// Generates multiple colliders from the provided image.
///
/// This function processes the input image and creates a vector of colliders of the specified type.
/// Each collider can be translated based on the `translate` flag.
///
/// # Parameters
/// - `image`: The input image from which to generate the colliders. The type `I` must implement `From<I>` for `Edges`.
/// - `collider_type`: Specifies the type of colliders to create (e.g., `Polyline`, `ConvexHull`, etc.).
/// - `translate`: A boolean flag indicating whether to apply translation during collider generation.
///
/// # Returns
/// Returns a `Vec<Option<Collider>>`, which is a vector of optional colliders. Each element may be `Some(Collider)`
/// if the collider is successfully generated, or `None` if the generation fails for that particular collider.
///
/// # Example
/// ```
/// let colliders = generate_colliders(image, ColliderType::Polyline, true);
/// ```
#[must_use]
pub fn generate_colliders<I>(
    image: I,
    collider_type: ColliderType,
    translate: bool,
) -> Vec<Option<Collider>>
where
    Edges: From<I>,
{
    crate::utils::generate_colliders(
        image,
        |points| to_collider(collider_type, points),
        translate,
    )
}