Struct GridIndex 

pub struct GridIndex<C>(pub i64, _);

An x or y index in chunk coordinates, not world coordinates.

Tuple Fields

0: i64

Implementations

impl<C> GridIndex<C>

pub const fn from_raw(i: i64) -> Self

Create a GridIndex for any chunk. Useful if you are doing some custom math to convert from a Chunk’s coordinates to another Chunk’s coordinates without going through world coordinates.

Trait Implementations

impl<C> Abs for GridIndex<C>

fn abs(self) -> Self

Compute the absolute value of this type. No-op if the value is alread positive.

impl<C> Add for GridIndex<C>

type Output = GridIndex<C>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<C> AddAssign for GridIndex<C>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<C> Clone for GridIndex<C>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> Copy for GridIndex<C>

impl<C> Debug for GridIndex<C>

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

Formats the value using the given formatter.

impl<C> Div for GridIndex<C>

type Output = GridIndex<C>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl<C> Div<i64> for GridIndex<C>

type Output = GridIndex<C>

The resulting type after applying the / operator.

fn div(self, rhs: i64) -> Self::Output

Performs the / operation.

impl<C> DivAssign for GridIndex<C>

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<C> DivAssign<i64> for GridIndex<C>

fn div_assign(&mut self, rhs: i64)

Performs the /= operation.

impl<C> Eq for GridIndex<C>

impl<C> Mul for GridIndex<C>

type Output = GridIndex<C>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<C> MulAssign for GridIndex<C>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<C> Neg for GridIndex<C>

type Output = GridIndex<C>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<C> Num for GridIndex<C>

const ZERO: Self

The neutral value for addition and subtraction.

const ONE: Self

The neutral value for multiplication and division.

const TWO: Self

For when you can’t use + in const contexts, but need a 2

fn iter_range(range: Range<Self>) -> impl Iterator<Item = Self>

Iterate over a range. Workaround to std::ops::Range’s Iterator impl not being implementable for custom types.

fn as_u64(self) -> u64

Convert the value to a u64. Used for seeding random number generators from coordinates.

impl<C> Ord for GridIndex<C>

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<C> PartialEq for GridIndex<C>

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

Equality operator ==.

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

Inequality operator !=.

impl<C> PartialOrd for GridIndex<C>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<C> Sub for GridIndex<C>

type Output = GridIndex<C>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<C> SubAssign for GridIndex<C>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.