Skip to main content

ChunkCoord

Struct ChunkCoord 

Source
pub struct ChunkCoord {
    pub x: i32,
    pub z: i32,
}
Expand description

Integer index of a chunk column in the infinite X/Z grid.

x and z are chunk indices, not world units; the chunk’s world-space (0,0,0) corner is (x as f32 * chunk_w, 0, z as f32 * chunk_d).

Fields§

§x: i32

Chunk index along X.

§z: i32

Chunk index along Z.

Implementations§

Source§

impl ChunkCoord

Source

pub const fn new(x: i32, z: i32) -> ChunkCoord

A chunk coordinate from raw indices.

Source

pub fn from_world(wx: f32, wz: f32, chunk_w: f32, chunk_d: f32) -> ChunkCoord

The chunk column a world-space (wx, wz) position falls in.

chunk_w / chunk_d are the chunk’s world-space size on X / Z. Floors rather than truncates, so a negative coordinate maps to the chunk below it rather than toward zero.

Source

pub fn origin_world(self, chunk_w: f32, chunk_d: f32) -> (f32, f32)

World-space (x, z) of this chunk’s (0,0,0) corner.

Source

pub fn offset(self, dx: i32, dz: i32) -> ChunkCoord

This coordinate shifted by (dx, dz) chunks.

Source

pub fn chebyshev_distance(self, other: ChunkCoord) -> i32

Chebyshev (square-ring) distance to other, in chunks.

This is the metric the streaming window uses for radius membership: a chunk is “in view” when its Chebyshev distance to the camera chunk is <= view_radius, which selects a square block of chunks.

Source

pub fn sq_distance(self, other: ChunkCoord) -> i64

Squared Euclidean distance to other, in chunk units.

Used to prioritise loads (nearest chunk first). Squared keeps the math sqrt-free; i64 so a far-apart pair cannot overflow.

Trait Implementations§

Source§

impl Clone for ChunkCoord

Source§

fn clone(&self) -> ChunkCoord

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 Copy for ChunkCoord

Source§

impl Debug for ChunkCoord

Source§

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

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

impl Eq for ChunkCoord

Source§

impl Hash for ChunkCoord

Source§

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

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 Ord for ChunkCoord

Source§

fn cmp(&self, other: &ChunkCoord) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for ChunkCoord

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl PartialOrd for ChunkCoord

Source§

fn partial_cmp(&self, other: &ChunkCoord) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for ChunkCoord

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<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
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<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 = !

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.