ChunkPos

all_is_cubes::chunking

Struct ChunkPos 

Source 
pub struct ChunkPos<const CHUNK_SIZE: GridCoordinate>(pub Cube);
Expand description

Type to distinguish chunk coordinates from cube coordinates.

Chunk math is generally just like cube math (hence the type of the field), but we don’t want to confuse the two and forget to multiply or divide. A ChunkPos([x, y, z]) identifies the chunk which contains the cubes with x coordinates in the half-open range x * CHUNK_SIZE..(x + 1) * CHUNK_SIZE, and similarly for the y and z axes.

The consequences are unspecified if CHUNK_SIZE is not positive.

Tuple Fields§

§0: Cube

Implementations§

Source§

impl<const CHUNK_SIZE: GridCoordinate> ChunkPos<CHUNK_SIZE>

Source

pub const fn new( x: GridCoordinate, y: GridCoordinate, z: GridCoordinate, ) -> Self

Construct a ChunkPos from chunk coordinates (i.e. successive numbers indicate adjacent chunks).

Source

pub fn bounds(self) -> GridAab

Returns the bounds of this chunk as a GridAab.

TODO: specify what happens if the result would overflow.

Source

pub fn distance(self, other: Self) -> Distance

Returns the distance between the two given chunks. See the Distance for an explanation of what that means.

Source

pub fn min_distance_squared_from(self, origin_chunk: Self) -> GridCoordinate

Returns the squared distance along the shortest line from origin_chunk’s bounds to this chunk’s bounds.

This is the same criterion that ChunkChart uses for deciding whether a chunk is included in the chart or not.

Trait Implementations§

Source§

impl<const CHUNK_SIZE: GridCoordinate> Clone for ChunkPos<CHUNK_SIZE>

Source§

fn clone(&self) -> ChunkPos<CHUNK_SIZE>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<const CHUNK_SIZE: GridCoordinate> Debug for ChunkPos<CHUNK_SIZE>

Source§

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

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

impl<const CHUNK_SIZE: GridCoordinate> Hash for ChunkPos<CHUNK_SIZE>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<const CHUNK_SIZE: GridCoordinate> PartialEq for ChunkPos<CHUNK_SIZE>

Source§

fn eq(&self, other: &ChunkPos<CHUNK_SIZE>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<const CHUNK_SIZE: GridCoordinate> Copy for ChunkPos<CHUNK_SIZE>

Source§

impl<const CHUNK_SIZE: GridCoordinate> Eq for ChunkPos<CHUNK_SIZE>

Source§

impl<const CHUNK_SIZE: GridCoordinate> StructuralPartialEq for ChunkPos<CHUNK_SIZE>

Auto Trait Implementations§

§

impl<const CHUNK_SIZE: i32> Freeze for ChunkPos<CHUNK_SIZE>

§

impl<const CHUNK_SIZE: i32> RefUnwindSafe for ChunkPos<CHUNK_SIZE>

§

impl<const CHUNK_SIZE: i32> Send for ChunkPos<CHUNK_SIZE>

§

impl<const CHUNK_SIZE: i32> Sync for ChunkPos<CHUNK_SIZE>

§

impl<const CHUNK_SIZE: i32> Unpin for ChunkPos<CHUNK_SIZE>

§

impl<const CHUNK_SIZE: i32> UnwindSafe for ChunkPos<CHUNK_SIZE>

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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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> DynEq for T
where T: Any + Eq,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Casts the type to dyn Any.
Source§

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

This method tests for self and other values to be equal. Read more
Source§

impl<T> DynHash for T
where T: DynEq + Hash,

Source§

fn as_dyn_eq(&self) -> &(dyn DynEq + 'static)

Casts the type to dyn Any.
Source§

fn dyn_hash(&self, state: &mut dyn Hasher)

Feeds this value into the given Hasher.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
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.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> ConditionalSend for T
where T: Send,