Struct beehive::Point

#[repr(C)]pub struct Point<T> { /* fields omitted */ }

Cube hex coordinates representing points. Only valid points on the plane can be normally created.

T should generally be a signed integer type. Floating point numbers have precision problems that may lead to invalid coordinates after operations.

Methods

impl<T> Point<T>

pub fn x(&self) -> &T

pub fn y(&self) -> &T

pub fn z(&self) -> &T

pub fn w(&self) -> &T

pub fn into_axial(self) -> PointAxial<T>

impl<T: Copy + Add + Zero> Point<T>

pub fn try_from_coords(x: T, y: T, z: T, w: T) -> Option<Self>

Create from coordinates. Returns None if invalid.

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

Create from coordinates. Will panic if invalid.

Panics

The function panics when called with coordinates that don't satisfy the hex plane invariant.

impl<T: Zero> Point<T>

pub fn zero() -> Self

Return a vector where all components are zero.

impl<T: Real> Point<T>

pub fn round(self) -> Self

Round in hex space, upholding plane invariant.

pub fn cast_round<N>(self) -> Point<N> where
    N: 'static + Copy,
    T: AsPrimitive<N>, 

Round in hex space and cast to a primitive type.

N must be a primitive numeric type.

impl<T> Point<T>

pub fn cast_fix<N>(self) -> Point<N> where
    N: 'static + Copy + Add + Zero + Sub<Output = N>,
    T: AsPrimitive<N>, 

Cast to a primitive type and fix the coordinate if necessary, by discarding the Z-axis. This is preferable for integral Ts.

N must be a primitive numeric type.

impl<T> Point<T>

pub fn into_vector(self) -> Vector<T>

Convert this point to a vector with the same component values.

impl<T> Point<T> where
    T: 'static + Copy + AsPrimitive<f32>,
    f32: AsPrimitive<T>, 

pub fn line_to(self, other: Point<T>) -> Line<T>

Creates a line iterator to other, including both endpoints.

pub fn line_from(self, other: Point<T>) -> Line<T>

Creates a line iterator from other, including both endpoints.

pub fn line_to_excluding(
    self,
    other: Point<T>,
    exclude_start: bool,
    exclude_end: bool
) -> Line<T>

Creates a line iterator to other, excluding some endpoints.

pub fn line_from_excluding(
    self,
    other: Point<T>,
    exclude_start: bool,
    exclude_end: bool
) -> Line<T>

Creates a line iterator from other, excluding some endpoints.

impl<T: Copy + Signed + One + Add + Sub<Output = T> + Div> Point<T>

pub fn distance(&self, other: Point<T>) -> T

Returns the manhattan distance to another point in hex space.

Trait Implementations

impl<T> Add<Direction> for Point<T> where
    T: Zero + One + Add + Neg<Output = T>, 

type Output = Point<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T, O> Add<Vector<T>> for Point<T> where
    T: Add<Output = O>, 

type Output = Point<O>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign<Direction> for Point<T> where
    T: Zero + One + AddAssign<T> + Neg<Output = T>, 

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl<T> AddAssign<Vector<T>> for Point<T> where
    T: AddAssign, 

fn add_assign(&mut self, rhs: Vector<T>)

Performs the += operation.

impl<T: Clone> Clone for Point<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Point<T>

impl<T: Debug> Debug for Point<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Point<T>

fn default() -> Point<T>

Returns the "default value" for a type.

impl<T: Display> Display for Point<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Point<T>

impl<T> Extend<Point<T>> for QuadPrism<T> where
    T: PartialOrd + One + Add<Output = T>, 

fn extend<I: IntoIterator<Item = Point<T>>>(&mut self, it: I)

Extends a collection with the contents of an iterator.

impl<T> From<Point<T>> for PointAxial<T>

fn from(c: Point<T>) -> Self

Performs the conversion.

impl<V> From<Point<V>> for Geom<V>

fn from(p: Point<V>) -> Self

Performs the conversion.

impl<T: Copy + Zero + Sub<Output = T>> From<PointAxial<T>> for Point<T>

fn from(c: PointAxial<T>) -> Point<T>

Performs the conversion.

impl<T> FromIterator<Point<T>> for QuadPrism<T> where
    T: Copy + Default + PartialOrd + One + Add<Output = T>, 

fn from_iter<I: IntoIterator<Item = Point<T>>>(it: I) -> Self

Creates a value from an iterator.

impl<T: Hash> Hash for Point<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, 

Feeds a slice of this type into the given [Hasher].

impl<T, I: Subscript> Index<Point<I>> for HexMap<T, I>

type Output = T

The returned type after indexing.

fn index(&self, point: Point<I>) -> &T

Performs the indexing (container[index]) operation.

impl<T, I: Subscript> IndexMut<Point<I>> for HexMap<T, I>

fn index_mut(&mut self, point: Point<I>) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T: PartialEq> PartialEq<Point<T>> for Point<T>

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

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

fn ne(&self, other: &Point<T>) -> bool

This method tests for !=.

impl<T> StructuralEq for Point<T>

impl<T> StructuralPartialEq for Point<T>

impl<T> Sub<Direction> for Point<T> where
    T: Zero + One + Sub<Output = T> + Neg<Output = T>, 

type Output = Point<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, O> Sub<Point<T>> for Point<T> where
    T: Sub<Output = O>, 

type Output = Vector<O>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, O> Sub<Vector<T>> for Point<T> where
    T: Sub<Output = O>, 

type Output = Point<O>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign<Direction> for Point<T> where
    T: Zero + One + SubAssign<T> + Neg<Output = T>, 

fn sub_assign(&mut self, rhs: Direction)

Performs the -= operation.

impl<T> SubAssign<Vector<T>> for Point<T> where
    T: SubAssign, 

fn sub_assign(&mut self, rhs: Vector<T>)

Performs the -= operation.