Struct amethyst_tiles::iters::MortonRegion

pub struct MortonRegion { /* fields omitted */ }

Axis aligned quantized region of space represented in tile coordinates of u32. This behaves like a bounding box volume with min and max coordinates for iteration. This regions limits are inclusive, in that it considers both min and max values as being inside the region.

The values of this region are stored and computed as morton values instead of Vector3 values, allowing for fast BMI2 instrinsic use for iteration and comparison.

Implementations

impl MortonRegion

#[must_use]pub fn new(min: u32, max: u32) -> Self

Create a new MortonRegion region.

#[must_use]pub fn contains(self, morton: u32) -> bool

Check if this MortonRegion contains a given morton coordinate.

Trait Implementations

impl Clone for MortonRegion

fn clone(&self) -> MortonRegion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MortonRegion

impl Debug for MortonRegion

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

Formats the value using the given formatter.

impl Default for MortonRegion

fn default() -> MortonRegion

Returns the "default value" for a type.

impl Eq for MortonRegion

impl<'a> From<&'a Region> for MortonRegion

#[must_use]fn from(region: &'a Region) -> Self

Performs the conversion.

impl From<Region> for MortonRegion

#[must_use]fn from(region: Region) -> Self

Performs the conversion.

impl Hash for MortonRegion

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for MortonRegion

#[must_use]fn cmp(&self, other: &Self) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<MortonRegion> for MortonRegion

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<MortonRegion> for MortonRegion

#[must_use]fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for MortonRegion

impl StructuralPartialEq for MortonRegion