Struct DensityMap

pub struct DensityMap { /* private fields */ }

Density map that contains density data and steepness per pixel.

Implementations

impl DensityMap

pub fn new( width: usize, height: usize, scale: usize, data: Vec<u8>, ) -> Result<Self, DensityMapError>

Create new density map.

Arguments

• width - Columns.
• height - Rows.
• scale - Scale.
• data - Raw pixel data.

Returns

Density map or error.

Examples

use density_mesh_core::prelude::*;

assert!(DensityMap::new(2, 2, 1, vec![0, 1, 2, 3]).is_ok());
assert_eq!(
    DensityMap::new(1, 2, 1, vec![0, 1, 2, 3]),
    Err(DensityMapError::WrongDataLength(4, 2)),
);

pub fn scale(&self) -> usize

Returns scale.

pub fn width(&self) -> usize

Returns scaled width.

pub fn height(&self) -> usize

Returns scaled height.

pub fn unscaled_width(&self) -> usize

Returns unscaled width.

pub fn unscaled_height(&self) -> usize

Returns unscaled height.

pub fn values(&self) -> &[Scalar]

Returns values buffer.

pub fn steepness(&self) -> &[Scalar]

Returns steepness buffer.

pub fn value_at_point(&self, point: (isize, isize)) -> Scalar

Returns value at given point or 0 if out of bounds.

Arguments

• point - (X, Y)

pub fn steepness_at_point(&self, point: (isize, isize)) -> Scalar

Returns steepness at given point or 0 if out of bounds.

Arguments

• point - (X, Y)

pub fn value_steepness_iter<'a>( &'a self, ) -> impl Iterator<Item = (usize, usize, Scalar, Scalar)> + 'a

Returns iterator over values and steepness buffers.

Examples

use density_mesh_core::prelude::*;

let map = DensityMap::new(2, 2, 1, vec![2, 2, 4, 4])
    .unwrap()
    .value_steepness_iter()
    .collect::<Vec<_>>();
assert_eq!(
    map,
    vec![
        (0, 0, 0.007843138, 0.011764706),
        (1, 0, 0.007843138, 0.011764707),
        (0, 1, 0.015686275, 0.01633987),
        (1, 1, 0.015686275, 0.01633987),
    ],
);

pub fn change( &mut self, col: usize, row: usize, width: usize, height: usize, data: Vec<u8>, ) -> Result<(), DensityMapError>

Change density map region data (replace “pixels”) - this recalculates internals.

Arguments

• col - Column index.
• row - Row index.
• width - Number of columns.
• height - Number of rows.
• data - Data to replace with.

Trait Implementations

impl Clone for DensityMap

fn clone(&self) -> DensityMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DensityMap

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

Formats the value using the given formatter.

impl Default for DensityMap

fn default() -> DensityMap

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DensityMap

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DensityMap

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DensityMap

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DensityMap