Struct big_space::GridCell

pub struct GridCell<P: GridPrecision> {
    pub x: P,
    pub y: P,
    pub z: P,
}

Defines the grid cell this entity’s Transform is relative to.

This component is generic over a few integer types to allow you to select the grid size you need. These correspond to a total usable volume of a cube with the following edge lengths:

Assuming you are using a grid cell edge length of 10,000 meters, and 1.0 == 1 meter

• i8: 2,560 km = 74% of the diameter of the Moon
• i16: 655,350 km = 85% of the diameter of the Moon’s orbit around Earth
• i32: 0.0045 light years = ~4 times the width of the solar system
• i64: 19.5 million light years = ~100 times the width of the milky way galaxy
• i128: 3.6e+26 light years = ~3.9e+15 times the width of the observable universe

where

usable_edge_length = 2^(integer_bits) * grid_cell_edge_length

Note

Be sure you are using the same grid index precision everywhere. It might be a good idea to define a type alias!

type GalacticGrid = GridCell<i64>;

Fields

x: P

The x-index of the cell.

y: P

The y-index of the cell.

z: P

The z-index of the cell.

Implementations

impl<P: GridPrecision> GridCell<P>

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

Construct a new GridCell.

pub const ZERO: Self = _

The origin GridCell.

pub const ONE: Self = _

A unit value GridCell. Useful for offsets.

Trait Implementations

impl<P: GridPrecision> Add<&GridCell<P>> for &GridCell<P>

type Output = GridCell<P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<P: GridPrecision> Add<GridCell<P>> for GridCell<P>

type Output = GridCell<P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<P: Clone + GridPrecision> Clone for GridCell<P>

fn clone(&self) -> GridCell<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: GridPrecision> Component for GridCell<P>where
    Self: Send + Sync + 'static,

type Storage = TableStorage

impl<P: Debug + GridPrecision> Debug for GridCell<P>

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

Formats the value using the given formatter.

impl<P: Default + GridPrecision> Default for GridCell<P>

fn default() -> GridCell<P>

Returns the “default value” for a type.

impl<P: GridPrecision> GetTypeRegistration for GridCell<P>

fn get_type_registration() -> TypeRegistration

impl<P: Hash + GridPrecision> Hash for GridCell<P>

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<P: Ord + GridPrecision> Ord for GridCell<P>

fn cmp(&self, other: &GridCell<P>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<P: PartialEq + GridPrecision> PartialEq<GridCell<P>> for GridCell<P>

fn eq(&self, other: &GridCell<P>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<P: PartialOrd + GridPrecision> PartialOrd<GridCell<P>> for GridCell<P>

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

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

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

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

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

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

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

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

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<P: GridPrecision> Reflect for GridCell<P>

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the [TypeInfo] of the underlying type.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &dyn Reflect)

Applies a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

impl<P: GridPrecision> Struct for GridCell<P>

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a [DynamicStruct].

impl<P: GridPrecision> Sub<&GridCell<P>> for &GridCell<P>

type Output = GridCell<P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<P: GridPrecision> Sub<GridCell<P>> for GridCell<P>

type Output = GridCell<P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<P: GridPrecision> Typed for GridCell<P>

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl<P: Copy + GridPrecision> Copy for GridCell<P>

impl<P: Eq + GridPrecision> Eq for GridCell<P>

impl<P: GridPrecision> StructuralEq for GridCell<P>

impl<P: GridPrecision> StructuralPartialEq for GridCell<P>