Struct Particle 

pub struct Particle { /* private fields */ }

Single Particle struct. Contains the location and color. Because macroquad does not support 3 dimensional points or single pixels, a Particle is implemented as a small line. This is why it contains the end_location member, as it is used as the ending point of the line.

This design choice can be embraced fully when creating a particle system that operates on a continuous line by setting the end_location somewhere near the the next point of the particle system to imitate continuity.

Implementations

impl Particle

pub fn new( (x, y, z): (f32, f32, f32), (r, g, b, a): (f32, f32, f32, f32), size: f32, length: f32, sloped: bool, ) -> Result<Self, String>

Instantiate a new Particle at (x, y, z) location with (r, g, b, a) color and s size, length l. sloped determines if the particle’s opacity fades out or not.

pub fn new_line( (x, y, z): (f32, f32, f32), (xe, ye, ze): (f32, f32, f32), (r, g, b, a): (f32, f32, f32, f32), length: f32, sloped: bool, ) -> Result<Self, String>

Instantiate a new Particle at (x, y, z) location and ending location (x, y, z) with (r, g, b, a) color, length l. sloped determines if the particle’s opacity fades out or not.

pub fn add_location(self, x: f32, y: f32, z: f32) -> Self

Add the x, y, z argument values to the location of Particle.

pub fn sub_location(self, x: f32, y: f32, z: f32) -> Self

Subtract the x, y, z argument values to the location of Particle.

pub fn set_location(&mut self, x: f32, y: f32, z: f32)

Set the location of the particle to x, y, z argument.

pub fn set_color(&mut self, r: f32, g: f32, b: f32, a: f32)

Set the color of the particle to r, g, b, a argument.

pub fn draw(&mut self) -> bool

Draw the Particle within the macroquad world coords. Returns true if Particle has surpassed its length, else false.

pub fn reset(&mut self)

Reset the ellapsed time for the Particle object

Trait Implementations

impl Clone for Particle

fn clone(&self) -> Particle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Particle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Particle

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Particle

fn eq(&self, other: &Particle) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ParticleSys for Particle

type T = Particle

fn is_active(&self) -> bool

Check if ParticleSys is active. Returns true if ParticleSys is in active state. Else false.

fn is_looping(&self) -> bool

Check if ParticleSys is looping. Return true if ParticleSys is in active looping state. Else false.

fn is_initialized(&mut self) -> bool

Return true if LinearParticles is initialized and ready to use.

fn reset_time(&mut self)

Reset the elapsed time counter for the ParticleSys.

fn elapsed_time(&mut self) -> Option<f32>

Return the Some(elapsed) where elapsed is total elapsed seconds counted by the ParticleSys as f32, or None if that’s desirable.

fn setup(&mut self, _should_loop: bool, _p: Option<f32>) -> Result<(), String>

Set up the ParticleSys such that it is ready to be displayed. This function isn’t intended to be called by the user but by other trait methods.

fn tear_down(&mut self)

Tear down the ParticleSys such that is_active() and is_initialized() return false and any other resetting of variables necessary for the ParticleSys to be able to call setup(). This function isn’t intended to be called by the user, but by other trait methods.

fn next_frame(&mut self, _time: Option<f32>) -> Result<bool, String>

Display the next frame of the ParticleSys Particles with elapsed time time if Some(time), else the ParticleSys own counting mechanism. This function isn’t intended to be called by the user, but by the trait’s run method.

fn iter(&self) -> Option<Iter<'_, Self::T>>

Return an Iterator over the Particle Pieces managed by the ParticleSys.

fn iter_mut(&mut self) -> Option<IterMut<'_, Self::T>>

Return a Mutable Iterator over the Particle Pieces managed by the ParticleSys.

fn with_period(self, p: f32) -> Result<Self, String>

Returns self with period p.

fn start_loop(&mut self) -> Result<(), String>

Set up ParticleSys into its looping active state.

fn start(&mut self) -> Result<(), String>

Set up ParticleSys into its active state.

fn stop(&mut self)

Tear down and deactivate ParticleSys object.

fn run(&mut self) -> Result<bool, String>

Display the next frame available from the LinearParticle.

impl Copy for Particle

impl StructuralPartialEq for Particle