berdicles 0.0.3

Expressive CPU particle system for the bevy 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
170
171
172
173
174
175

use bevy::{
    asset::{Asset, Handle},
    color::LinearRgba,
    pbr::Material,
    prelude::{Bundle, Deref, DerefMut, Entity},
    reflect::TypePath,
    render::{
        mesh::Mesh,
        render_resource::{AsBindGroup, ShaderRef},
        texture::Image,
        view::VisibilityBundle,
    },
    transform::components::{GlobalTransform, Transform},
};

use crate::{
    shader::{PARTICLE_DBG_FRAGMENT, PARTICLE_FRAGMENT, PARTICLE_VERTEX},
    sub::{ParticleEventBuffer, ParticleParent},
    ParticleBuffer, ParticleInstance, ParticleRef,
};

/// [`Material`] that displays an unlit combination of `base_color` and `texture` on a mesh.
#[derive(Debug, Clone, Default, PartialEq, TypePath, Asset, AsBindGroup)]
pub struct StandardParticle {
    #[uniform(0)]
    pub base_color: LinearRgba,
    #[texture(1)]
    #[sampler(2)]
    pub texture: Handle<Image>,
}

impl Material for StandardParticle {
    fn vertex_shader() -> ShaderRef {
        ShaderRef::Handle(PARTICLE_VERTEX.clone())
    }
    fn fragment_shader() -> ShaderRef {
        ShaderRef::Handle(PARTICLE_FRAGMENT.clone())
    }
}

/// [`Material`] that displays useful debug info of a particle.
#[derive(Debug, Clone, Default, PartialEq, TypePath, Asset, AsBindGroup)]
pub struct DebugParticle {}

impl Material for DebugParticle {
    fn vertex_shader() -> ShaderRef {
        ShaderRef::Handle(PARTICLE_VERTEX.clone())
    }
    fn fragment_shader() -> ShaderRef {
        ShaderRef::Handle(PARTICLE_DBG_FRAGMENT.clone())
    }
}

/// A Bundle of a particle system.
#[derive(Debug, Bundle)]
pub struct ParticleSystemBundle<M: Material> {
    /// A type erased [`ParticleSystem`](crate::ParticleSystem).
    pub particle_system: ParticleInstance,
    /// Does not need to be created by the user.
    pub particle_buffer: ParticleBuffer,
    /// Mesh shape of the particle.
    pub mesh: Handle<Mesh>,
    /// Material of the particle.
    pub material: Handle<M>,
    pub transform: Transform,
    pub global_transform: GlobalTransform,
    pub visibility: VisibilityBundle,
}

impl<M: Material> Default for ParticleSystemBundle<M> {
    fn default() -> Self {
        Self {
            particle_system: Default::default(),
            particle_buffer: Default::default(),
            mesh: Default::default(),
            material: Default::default(),
            transform: Default::default(),
            global_transform: Default::default(),
            visibility: Default::default(),
        }
    }
}

#[doc(hidden)]
#[derive(Debug, Bundle, Deref, DerefMut)]
pub struct ParentedParticleSystemBundle<M: Material> {
    #[deref]
    bundle: ParticleSystemBundle<M>,
    pub parent: ParticleParent,
}

#[doc(hidden)]
#[derive(Debug, Bundle, Deref, DerefMut)]
pub struct EventParticleSystemBundle<M: Material> {
    #[deref]
    bundle: ParticleSystemBundle<M>,
    pub events: ParticleEventBuffer,
}

#[doc(hidden)]
#[derive(Debug, Bundle, Deref, DerefMut)]
pub struct ParentedEventParticleSystemBundle<M: Material> {
    #[deref]
    bundle: ParticleSystemBundle<M>,
    pub parent: ParticleParent,
    pub events: ParticleEventBuffer,
}

impl<M: Material> ParticleSystemBundle<M> {
    /// Add a parent to the particle system.
    pub fn parented(self, entity: Entity) -> ParentedParticleSystemBundle<M> {
        ParentedParticleSystemBundle {
            bundle: self,
            parent: ParticleParent(entity),
        }
    }

    /// Add an [`ParticleEventBuffer`] to the current particle system.
    pub fn with_events(self) -> EventParticleSystemBundle<M> {
        EventParticleSystemBundle {
            bundle: self,
            events: ParticleEventBuffer::default(),
        }
    }
}

impl<M: Material> ParentedParticleSystemBundle<M> {
    /// Add an [`ParticleEventBuffer`] to the current particle system.
    pub fn with_events(self) -> ParentedEventParticleSystemBundle<M> {
        ParentedEventParticleSystemBundle {
            bundle: self.bundle,
            parent: self.parent,
            events: ParticleEventBuffer::default(),
        }
    }
}

impl<M: Material> EventParticleSystemBundle<M> {
    /// Add a parent to the particle system.
    pub fn parented(self, entity: Entity) -> ParentedEventParticleSystemBundle<M> {
        ParentedEventParticleSystemBundle {
            bundle: self.bundle,
            events: self.events,
            parent: ParticleParent(entity),
        }
    }
}

/// A [`Material`] and [`Mesh`] that renders based on
/// another [`ParticleInstance`]'s output.
#[derive(Debug, Bundle)]
pub struct ParticleRefBundle<M: Material> {
    /// Reference to a [`ParticleInstance`].
    pub particles: ParticleRef,
    /// Mesh shape of the particle.
    pub mesh: Handle<Mesh>,
    /// Material of the particle.
    pub material: Handle<M>,
    pub transform: Transform,
    pub global_transform: GlobalTransform,
    pub visibility: VisibilityBundle,
}

impl<M: Material> Default for ParticleRefBundle<M> {
    fn default() -> Self {
        Self {
            particles: Default::default(),
            mesh: Default::default(),
            material: Default::default(),
            transform: Default::default(),
            global_transform: Default::default(),
            visibility: Default::default(),
        }
    }
}