Struct FlowField 

pub struct FlowField {
    pub width: usize,
    pub height: usize,
    pub cell_size: f32,
    pub costs: Vec<f32>,
    pub integration: Vec<f32>,
    pub directions: Vec<Vec2>,
    pub origin: Vec2,
}

A grid-based flow field.

Build order:

1. set_cost for any impassable/expensive cells.
2. build_integration_field — BFS/Dijkstra from goals.
3. build_direction_field — gradient from integration field.
4. get_direction — per-agent query.

Fields

width: usize

height: usize

cell_size: f32

costs: Vec<f32>

Per-cell traversal cost (>= 1.0; INFINITY = impassable).

integration: Vec<f32>

Integration (distance) field — lowest value near goals.

directions: Vec<Vec2>

Direction field — normalised Vec2 pointing toward nearest goal.

origin: Vec2

Implementations

impl FlowField

pub fn new(width: usize, height: usize, cell_size: f32) -> Self

Create a new uniform-cost flow field.

pub fn with_origin(self, origin: Vec2) -> Self

pub fn set_cost(&mut self, x: usize, y: usize, cost: f32)

Set the traversal cost of a cell. Use f32::INFINITY for impassable.

pub fn reset_costs(&mut self)

Reset all costs to 1.0.

pub fn world_to_grid(&self, pos: Vec2) -> (usize, usize)

World position → grid cell.

pub fn grid_to_world(&self, x: usize, y: usize) -> Vec2

Grid cell → world-space centre.

pub fn build_integration_field(&mut self, goals: &[(usize, usize)])

Build the integration (distance-weighted) field from a set of goal cells using a priority-queue Dijkstra.

pub fn build_direction_field(&mut self)

Build the direction field by gradient-descent from the integration field.

pub fn get_direction(&self, world_pos: Vec2) -> Vec2

Sample the flow field at a world position using bilinear interpolation.

pub fn get_integration(&self, world_pos: Vec2) -> f32

Get the integration value at a world position.

pub fn is_passable(&self, x: usize, y: usize) -> bool

Check if a cell is passable.

pub fn len(&self) -> usize

Total cell count.

Trait Implementations

impl Clone for FlowField

fn clone(&self) -> FlowField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlowField

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

Formats the value using the given formatter.