Boids Effect

Copyright 2023 Ethan Christensen

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class bruhanimate.bruheffect.boids_effect.BoidsEffect(buffer: Buffer, background: str, settings: BoidsSettings = None)

Bases: BaseEffect

Reynolds flocking simulation.

Each boid obeys three rules: - Separation — steer away from close neighbours - Alignment — match average velocity of nearby flock - Cohesion — move toward average position of nearby flock

Boids wrap around screen edges. Speed is colour-mapped hot (fast) to cool (slow) when color is enabled.

__init__(buffer: Buffer, background: str, settings: BoidsSettings = None)

Base class for all effects.

Parameters:

• buffer (Buffer) – Effect buffer to push updates to.

• background (str) – character or string to use for the background.

render_frame(frame_number: int)

To be defined by each effect.