Skip to main content

PlanarMask

Struct PlanarMask 

Source
pub struct PlanarMask { /* private fields */ }
Expand description

A dense row-major boolean mask aligned with a field’s cell grid.

Implementations§

Source§

impl PlanarMask

Source

pub fn empty(width: usize, height: usize) -> Result<Self, LayeredFieldError>

Construct an all-false mask.

Source

pub fn from_field(field: &LayeredField, channel: FieldChannel) -> Self

Derive a mask from one channel of a field.

Source

pub const fn dimensions(&self) -> (usize, usize)

Mask dimensions.

Source

pub fn count(&self) -> usize

Number of set cells.

Source

pub fn get(&self, x: usize, y: usize) -> Option<bool>

Read a cell, or None when outside the mask.

Source

pub fn set( &mut self, x: usize, y: usize, value: bool, ) -> Result<(), LayeredFieldError>

Write a cell.

Source

pub fn inverted(&self) -> Self

Set-complement.

Source

pub fn intersect(&self, other: &Self) -> Result<Self, LayeredFieldError>

Set-intersection with an identically sized mask.

Source

pub fn dilate( &self, config: &FieldConfig, radius: Scalar, ) -> Result<Self, LayeredFieldError>

Metric dilation by radius in local units.

The radius is converted to a cell count by ceiling division on the configured cell size, so the result never under-covers the requested distance. A zero radius is the identity.

Source

pub fn erode( &self, config: &FieldConfig, radius: Scalar, ) -> Result<Self, LayeredFieldError>

Metric erosion by radius in local units.

Source

pub fn connected_components(&self) -> ComponentLabels

Label 4-connected components of set cells.

Labels are assigned in row-major discovery order, so the labelling is stable across runs.

Trait Implementations§

Source§

impl Clone for PlanarMask

Source§

fn clone(&self) -> PlanarMask

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PlanarMask

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for PlanarMask

Source§

impl PartialEq for PlanarMask

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PlanarMask

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.