{{pkg.description}}
The API of this package is still unstable, but the underlying implementations have been used in many of the author's projects since ~2005... The agent/boid behaviors are fully modular and can be highly customized via the given parameters (which can also be dynamically/spatially adjusted). As with other thi.ng packages, the visual representation of the boids is entirely separate and out of scope of this package. This package only deals with the simulation of agents, their behavioral aspects and essentially only processes points in space (and their directions, forces)...
The following behavior building blocks are provided. All of them can be freely combined (incl. multiple instances with different configurations) and assigned to individual boids (or groups of them). Each behavior also has an associated weight to adjust its impact on the overall movement of the boids (also dynamically adjustable).
alignment()
: Steer towards the average direction of neighbors within given radiusattractPolyline()
: Steer towards the nearest point on a pre-configured polyline (or polygon)braitenberg2()
: Field-based 3-sensor (left/right/center) Braitenberg vehicle steeringcohesion()
: Steer towards the centroid of neighbors within given radiusdynamicTarget()
: Steer towards user defined (dynamically changeable) location(s)followPolyline()
: Steer towards the following/next point on a pre-configured polyline (or polygon)separation()
: Steer away from neighbors within given radius
Intended for behaviors requiring neighbor lookups, the package defines &
utilizes the IBoidAccel
interface. It's
recommended to use a compatible spatial acceleration structure such as
HashGrid2
or
HashGrid3
from the @thi.ng/geom-accel
package.
For cases where this isn't needed, the
noAccel
dummy
implementation of this interface can be used... In all cases, an acceleration
structure has to be provided to the boid ctor and factory functions
defBoid2()
/
defBoid3()
.
{{meta.status}}
{{repo.supportPackages}}
{{repo.relatedPackages}}
{{meta.blogPosts}}
{{pkg.install}}
{{pkg.size}}
{{pkg.deps}}
{{repo.examples}}
{{pkg.docs}}
TODO