bevy_vector_shapes 0.12.0

A library for rendering vector shapes using the Bevy game engine
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

use bevy::{prelude::*, reflect::Reflect, render::render_resource::ShaderType, shader::ShaderRef};
use wgpu::vertex_attr_array;

use crate::{
    prelude::*,
    render::{Flags, ShapeComponent, ShapeData, LINE_HANDLE},
};

/// Component containing the data for drawing a line.
#[derive(Component, Reflect)]
pub struct LineComponent {
    pub alignment: Alignment,
    pub cap: Cap,

    /// Position to draw the start of the line in world space relative to it's transform.
    pub start: Vec3,
    /// Position to draw the end of the line in world space relative to it's transform.
    pub end: Vec3,
}

impl LineComponent {
    pub fn new(config: &ShapeConfig, start: Vec3, end: Vec3) -> Self {
        Self {
            alignment: config.alignment,
            cap: config.cap,

            start,
            end,
        }
    }
}

impl Default for LineComponent {
    fn default() -> Self {
        Self {
            alignment: default(),
            cap: default(),

            start: default(),
            end: default(),
        }
    }
}

impl ShapeComponent for LineComponent {
    type Data = LineData;

    fn get_data(&self, tf: &GlobalTransform, fill: &ShapeFill) -> LineData {
        let mut flags = Flags(0);
        let thickness = match fill.ty {
            FillType::Stroke(thickness, thickness_type) => {
                flags.set_thickness_type(thickness_type);
                flags.set_hollow(1);
                thickness
            }
            FillType::Fill => 1.0,
        };
        flags.set_alignment(self.alignment);
        flags.set_cap(self.cap);

        LineData {
            transform: tf.to_matrix().to_cols_array_2d(),

            color: fill.color.to_linear().to_f32_array(),
            thickness,
            flags: flags.0,

            start: self.start,
            end: self.end,
        }
    }
}

/// Raw data sent to the line shader to draw a line
#[derive(Clone, Copy, Reflect, Default, Debug, ShaderType)]
#[repr(C)]
pub struct LineData {
    transform: [[f32; 4]; 4],

    color: [f32; 4],
    thickness: f32,
    flags: u32,

    start: Vec3,
    end: Vec3,
}

impl LineData {
    pub fn new(config: &ShapeConfig, start: Vec3, end: Vec3) -> Self {
        let mut flags = Flags(0);
        flags.set_thickness_type(config.thickness_type);
        flags.set_alignment(config.alignment);
        flags.set_cap(config.cap);

        LineData {
            transform: config.transform.to_matrix().to_cols_array_2d(),

            color: config.color.to_linear().to_f32_array(),
            thickness: config.thickness,
            flags: flags.0,

            start,
            end,
        }
    }
}

impl ShapeData for LineData {
    type Component = LineComponent;

    fn vertex_layout() -> Vec<wgpu::VertexAttribute> {
        vertex_attr_array![
            0 => Float32x4,
            1 => Float32x4,
            2 => Float32x4,
            3 => Float32x4,

            4 => Float32x4,
            5 => Float32,
            6 => Uint32,
            7 => Float32x3,
            8 => Float32x3,
        ]
        .to_vec()
    }

    fn shader() -> ShaderRef {
        LINE_HANDLE.into()
    }

    fn transform(&self) -> Mat4 {
        Mat4::from_cols_array_2d(&self.transform)
    }
}

/// Extension trait for [`ShapePainter`] to enable it to draw lines.
pub trait LinePainter {
    fn line(&mut self, start: Vec3, end: Vec3) -> &mut Self;
}

impl<'w, 's> LinePainter for ShapePainter<'w, 's> {
    fn line(&mut self, start: Vec3, end: Vec3) -> &mut Self {
        self.send(LineData::new(self.config(), start, end))
    }
}

/// Extension trait for [`ShapeBundle`] to enable creation of line bundles.
pub trait LineBundle {
    fn line(config: &ShapeConfig, start: Vec3, end: Vec3) -> Self;
}

impl LineBundle for ShapeBundle<LineComponent> {
    fn line(config: &ShapeConfig, start: Vec3, end: Vec3) -> Self {
        let mut bundle = Self::new(config, LineComponent::new(config, start, end));
        bundle.fill.ty = FillType::Stroke(config.thickness, config.thickness_type);
        bundle
    }
}

/// Extension trait for [`ShapeSpawner`] to enable spawning of line entities.
pub trait LineSpawner<'w>: ShapeSpawner<'w> {
    fn line(&mut self, start: Vec3, end: Vec3) -> ShapeEntityCommands<'_, '_>;
}

impl<'w, T: ShapeSpawner<'w>> LineSpawner<'w> for T {
    fn line(&'_ mut self, start: Vec3, end: Vec3) -> ShapeEntityCommands<'_, '_> {
        self.spawn_shape(ShapeBundle::line(self.config(), start, end))
    }
}