Struct GridPosition 

pub struct GridPosition<T: GridCoordinates>(pub T);

Component representing a position in the spatial grid.

Any entities with this component will be automatically added to the corresponding SpatialGrid, assuming one has been added to the simulation through crate::SimulationBuilder::add_spatial_grid.

Note that GridPosition2D and GridPosition3D may be used as shorthand types.

Tuple Fields

0: T

Implementations

impl GridPosition<IVec2>

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

Create a new 2D grid position from x, y coordinates.

pub fn neighbors(&self) -> impl Iterator<Item = Self>

pub fn neighbors_orthogonal(&self) -> impl Iterator<Item = Self>

pub const fn x(&self) -> i32

pub const fn y(&self) -> i32

impl GridPosition<IVec3>

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

Create a new 3D grid position from x, y, z coordinates.

pub fn neighbors(&self) -> impl Iterator<Item = Self>

pub fn neighbors_orthogonal(&self) -> impl Iterator<Item = Self>

pub const fn x(&self) -> i32

pub const fn y(&self) -> i32

pub const fn z(&self) -> i32

Trait Implementations

impl<T: Clone + GridCoordinates> Clone for GridPosition<T>

fn clone(&self) -> GridPosition<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: GridCoordinates> Component for GridPosition<T>

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its ComponentHooks.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl<T: Debug + GridCoordinates> Debug for GridPosition<T>

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

Formats the value using the given formatter.

impl<T: Hash + GridCoordinates> Hash for GridPosition<T>

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<T: PartialEq + GridCoordinates> PartialEq for GridPosition<T>

fn eq(&self, other: &GridPosition<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Copy + GridCoordinates> Copy for GridPosition<T>

impl<T: Eq + GridCoordinates> Eq for GridPosition<T>

impl<T: GridCoordinates> StructuralPartialEq for GridPosition<T>