Struct tahga::pursuit::boids::boid::Boid

pub struct Boid {
    pub position: Vec2,
    pub velocity: Vec2,
    pub color: Alpha<Hsl, f32>,
    pub visual_range: f32,
    pub max_speed: f32,
    pub max_affect: f32,
    pub border: f32,
    pub path: Vec<Vec2>,
    /* private fields */
}

A Boid is a single member of a flock

Fields

position: Vec2

The current position

velocity: Vec2

The current velocity

color: Alpha<Hsl, f32>

The color of this boid

visual_range: f32

The range at which this boid can see other boids

max_speed: f32

The max speed of this boid

max_affect: f32

Not currently used

border: f32

Not currently used

path: Vec<Vec2>

A record of past positions

Implementations

impl Boid

pub fn new(id: u32, position: Vec2, velocity: Vec2) -> Self

Create a new Boid instance

Arguments

id - A unique id for this Boid

position - The current position

velocity - The current velocity

Examples

use nannou::prelude::*;
use tahga::pursuit::boids::boid::Boid;
let b = Boid::new(0, vec2(0., 0.), vec2(10., 10.));
assert_eq!(b.visual_range, 75.);
assert_eq!(b.max_speed, 15.);
assert_eq!(b.max_affect, 0.8);

pub fn color(self, color: Alpha<Hsl, f32>) -> Self

Set a single color for a Boid and return a new instance

This is intended to be chained with new() in a builder pattern

Arguments

color: The color to use

Examples

use nannou::prelude::*;
use tahga::pursuit::boids::boid::Boid;
let b = Boid::new(0, vec2(0., 0.), vec2(10., 10.)).color(hsla(0.7,0.5,0.1,0.3));
 let c = b.color.into_components();
assert_eq!(c.1, 0.5);

pub fn visual_range(self, visual_range: f32) -> Self

Set the visual_range for a Boid

This is intended to be chained with new() in a builder pattern

Arguments

visual_range: the new visual_range

Examples

use nannou::prelude::*;
use tahga::pursuit::boids::boid::Boid;
let b = Boid::new(0, vec2(0., 0.), vec2(10., 10.)).visual_range(10.);
assert_eq!(b.visual_range, 10.);

pub fn max_speed(self, max_speed: f32) -> Self

Set the max_speed for a Boid

This is intended to be chained with new() in a builder pattern

Arguments

max_speed: the new max_speed

Examples

use nannou::prelude::*;
use tahga::pursuit::boids::boid::Boid;
let b = Boid::new(0, vec2(0., 0.), vec2(10., 10.)).max_speed(10.);
assert_eq!(b.max_speed, 10.);

pub fn max_affect(self, max_affect: f32) -> Self

Set the max_affect for a Boid

This is intended to be chained with new() in a builder pattern

Arguments

max_affect: the new max_affect

Examples

use nannou::prelude::*;
use tahga::pursuit::boids::boid::Boid;
let b = Boid::new(0, vec2(0., 0.), vec2(10., 10.)).max_affect(10.);
assert_eq!(b.max_affect, 10.);

pub fn border(self, border: f32) -> Self

Set the border for a Boid

This is intended to be chained with new() in a builder pattern

Arguments

border: the new border

Examples

use nannou::prelude::*;
use tahga::pursuit::boids::boid::Boid;
let b = Boid::new(0, vec2(0., 0.), vec2(10., 10.)).border(10.);
assert_eq!(b.border, 10.);

pub fn update(&mut self, boids: &Vec<Boid>, rect: &Rect)

Update the position and velocity of a Boid

boids - A reference to the Vec of all boids

rect - The canvas rectangle

Trait Implementations

impl Clone for Boid

fn clone(&self) -> Boid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Boid

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

Formats the value using the given formatter.