Struct quantized_density_fields::lod::LOD

pub struct LOD<S>where
    S: State,{ /* private fields */ }

Object that represents space level of details. This gives you the ability to sample space area states at different zoom levels (LOD mechanism).

Implementations

impl<S> LOD<S>where
    S: State,

pub fn new(dimensions: usize, count: usize, root_state: S) -> Self

Creates new LOD information universe.

Arguments

• dimensions - Number of dimensions which space contains.
• count - Number of levels.
• root_state - State of root level.

Examples

use quantized_density_fields::LOD;

// Create 2D space with 1 level of details and `16` as root space.
let lod = LOD::new(2, 1, 16);
assert_eq!(*lod.state(), 16);
// LOD has 4 children level objects.
assert_eq!(lod.level(lod.root()).data().as_sublevels().len(), 4);
// sampled state at level 1 equals to `4` (`16 / 4`).
assert_eq!(*lod.level(lod.level(lod.root()).data().as_sublevels()[0]).state(), 4);

pub fn id(&self) -> ID

Gets LOD id.

pub fn root(&self) -> ID

Gets LOD root level node id.

pub fn dimensions(&self) -> usize

Gets LOD dimensions number.

Examples

use quantized_density_fields::LOD;

let lod = LOD::new(2, 1, 16);
assert_eq!(lod.dimensions(), 2);

pub fn levels_count(&self) -> usize

Gets LOD zoom levels number.

Examples

use quantized_density_fields::LOD;

let lod = LOD::new(2, 1, 16);
assert_eq!(lod.levels_count(), 1);

pub fn state(&self) -> &S

Gets LOD root level state.

Examples

use quantized_density_fields::LOD;

let lod = LOD::new(2, 1, 16);
assert_eq!(*lod.state(), 16);

pub fn level_exists(&self, id: ID) -> bool

Tells if space level with given id exists in LOD.

Arguments

• id - level id.

Examples

use quantized_density_fields::LOD;

let lod = LOD::new(2, 1, 16);
assert!(lod.level_exists(lod.root()));

pub fn try_get_level(&self, id: ID) -> Option<&Level<S>>

Try to get reference to given space level.

Arguments

• id - level id.

Examples

use quantized_density_fields::LOD;

let lod = LOD::new(2, 1, 16);
if let Some(level) = lod.try_get_level(lod.root()) {
    assert_eq!(*level.state(), 16);
}

pub fn get_level(&self, id: ID) -> Result<&Level<S>>

Gets reference to given space level and throws error if level does not exists.

Arguments

• id - level id.

Examples

use quantized_density_fields::LOD;

let lod = LOD::new(2, 1, 16);
if let Ok(level) = lod.get_level(lod.root()) {
    assert_eq!(*level.state(), 16);
}

pub fn level(&self, id: ID) -> &Level<S>

Gets reference to given space level and panics if level does not exists.

Arguments

• id - level id.

Examples

use quantized_density_fields::LOD;

let lod = LOD::new(2, 1, 16);
assert_eq!(*lod.level(lod.root()).state(), 16);

pub fn field_exists(&self, id: ID) -> bool

Tells if QDF with given id exists in LOD.

Arguments

• id - QDF id.

Examples

use quantized_density_fields::LOD;

let lod = LOD::new(2, 0, 16);
assert!(lod.field_exists(lod.level(lod.root()).data().as_field()));

pub fn try_get_field(&self, id: ID) -> Option<&QDF<S>>

Try to get QDF with given id.

Arguments

• id - QDF id.

Examples

use quantized_density_fields::LOD;

let lod = LOD::new(2, 0, 16);
if let Some(qdf) = lod.try_get_field(lod.level(lod.root()).data().as_field()) {
    assert_eq!(*qdf.state(), 16);
}

pub fn try_get_field_mut(&mut self, id: ID) -> Option<&mut QDF<S>>

Try to get mutable QDF with given id.

Arguments

• id - QDF id.

Examples

use quantized_density_fields::LOD;

let mut lod = LOD::new(2, 0, 16);
let id = lod.level(lod.root()).data().as_field();
if let Some(qdf) = lod.try_get_field_mut(id) {
    qdf.set_space_state(id, 4);
}

pub fn get_field(&self, id: ID) -> Result<&QDF<S>>

Gets QDF with given id and throws error if field does not exists.

Arguments

• id - QDF id.

Examples

use quantized_density_fields::LOD;

let lod = LOD::new(2, 0, 16);
if let Ok(qdf) = lod.get_field(lod.level(lod.root()).data().as_field()) {
    assert_eq!(*qdf.state(), 16);
}

pub fn get_field_mut(&mut self, id: ID) -> Result<&mut QDF<S>>

Gets mutable QDF with given id and throws error if field does not exists.

Arguments

• id - QDF id.

Examples

use quantized_density_fields::LOD;

let mut lod = LOD::new(2, 0, 16);
let id = lod.level(lod.root()).data().as_field();
if let Ok(qdf) = lod.get_field_mut(id) {
    qdf.set_space_state(id, 4);
}

pub fn field(&self, id: ID) -> &QDF<S>

Gets QDF with given id and panics if field does not exists.

Arguments

• id - QDF id.

Examples

use quantized_density_fields::LOD;

let lod = LOD::new(2, 0, 16);
assert_eq!(*lod.field(lod.level(lod.root()).data().as_field()).state(), 16);

pub fn field_mut(&mut self, id: ID) -> &mut QDF<S>

Gets mutable QDF with given id and panics if field does not exists.

Arguments

• id - QDF id.

Examples

use quantized_density_fields::LOD;

let mut lod = LOD::new(2, 0, 16);
let id = lod.level(lod.root()).data().as_field();
let mut qdf = lod.field_mut(id);
let id = qdf.root();
qdf.set_space_state(id, 4);

pub fn find_level_neighbors(&self, id: ID) -> Result<Vec<ID>>

Gets list of space level neighbors IDs or throws error if level does not exists.

Arguments

• id - Level id.

Examples

use quantized_density_fields::LOD;

let lod = LOD::new(2, 1, 16);
let subs = lod.level(lod.root()).data().as_sublevels();
assert_eq!(lod.find_level_neighbors(subs[0]).unwrap(), vec![subs[1], subs[2], subs[3]]);

pub fn find_path(&self, from: ID, to: ID) -> Result<Vec<ID>>

Gets list of space level IDs that defines shortest path between two space levels, or throws error if level does not exists. Levels must lay on the same zoom level!

Arguments

• from - source level id.
• to - target level id.

Examples

use quantized_density_fields::LOD;

let lod = LOD::new(2, 1, 16);
let subs = lod.level(lod.root()).data().as_sublevels();
assert_eq!(lod.find_path(subs[1], subs[3]).unwrap(), vec![subs[1], subs[0], subs[3]]);

pub fn recalculate_state(&mut self) -> Result<S>

Updates LOD states.

Examples

use quantized_density_fields::LOD;

let mut lod = LOD::new(2, 1, 16);
let id = {
    let level = lod.level(lod.root()).clone();
    let subs = level.data().as_sublevels();
    let level = lod.level(subs[0]).clone();
    level.data().as_field()
};
{
    let mut qdf = lod.field_mut(id);
    let id = qdf.root();
    qdf.set_space_state(id, 8);
}
lod.recalculate_state();
assert_eq!(*lod.state(), 20);

Trait Implementations

impl<S> Debug for LOD<S>where
    S: State + Debug,

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

Formats the value using the given formatter.