Struct Wrapped2D

pub struct Wrapped2D<T, const X: u32, const Y: u32>(Vec2D<T>);

A 2D vector wrapper with fixed-size wrapping capabilities.

This struct is generic over a numeric type T and two constants X and Y, which represent the fixed size of the 2D wrapping area.

Type Parameters

• T - Any numeric type that implements the Fixed trait.
• X - The maximum bound for the x-axis.
• Y - The maximum bound for the y-axis.

Tuple Fields

0: Vec2D<T>

Implementations

impl<T, const X: u32, const Y: u32> Wrapped2D<T, X, Y>

where T: Fixed,

pub fn wrap_around_map(&self) -> Self

Wraps the coordinates of the vector around the bounds defined by X and Y.

Returns

A new Wrapped2D instance with its coordinates wrapped within the bounds.

pub fn wrap_coordinate(value: T, max_value: T) -> T

Wraps a single coordinate value around a maximum value.

Arguments

• value - The coordinate value to be wrapped.
• max_value - The maximum bound for the coordinate.

Returns

The wrapped coordinate value.

Methods from Deref<Target = Vec2D<T>>

pub fn abs(&self) -> T

Computes the magnitude (absolute value) of the vector.

Returns

The magnitude of the vector as a scalar of type T.

pub fn abs_sq(&self) -> T

pub fn round(&self) -> Self

pub fn round_to_2(&self) -> Self

pub fn floor(&self) -> Self

pub fn to(&self, other: &Self) -> Self

Creates a vector pointing from the current vector (self) to another vector (other).

Arguments

• other - The target vector.

Returns

A new vector representing the direction from self to other.

pub fn project_overboundary_fw(&self, dir: &Self) -> Self

pub fn project_overboundary_bw(&self, dir: &Self) -> Self

pub fn unwrapped_to(&self, other: &Self) -> Self

Computes an “unwrapped” vector pointing from the current vector (self) to another vector (other).

This method considers potential wrapping around a 2D map (based on the map size) and calculates the smallest vector that connects self to other. The wrapping allows for efficient navigation across boundaries.

Arguments

• other - The target vector to which the direction is computed.

Returns

A Vec2D representing the shortest unwrapped direction from self to other.

pub fn unwrap_all(&self) -> [Self; 9]

pub fn unwrapped_to_top_right(&self, other: &Self) -> Self

pub fn unwrapped_to_bottom_right(&self, other: &Self) -> Self

fn get_projected_in_range( &self, to: &Self, range: (&[i8], &[i8]), ) -> Vec<(Self, I64F64)>

pub fn perp_unit_to(&self, other: &Self) -> Self

Computes a perpendicular unit vector pointing to another vector (other).

The direction of the perpendicular vector depends on whether self is clockwise or counterclockwise to other.

Arguments

• other - The target vector to compare directions with.

Returns

A unit Vec2D perpendicular to self pointing towards other. Returns a zero vector if self and other are collinear.

pub fn perp_unit(&self, clockwise: bool) -> Self

Computes a perpendicular unit vector to the current vector.

The direction of the perpendicular vector depends on the clockwise parameter.

Arguments

• clockwise - A boolean indicating the direction. true for clockwise, false for counterclockwise.

Returns

A normalized perpendicular Vec2D.

pub fn flip_unit(&self) -> Self

Computes a flipped collinear unit vector to the current vector.

This is equivalent to rotating the vector 180 degrees.

Returns

A normalized flipped collinear Vec2D.

pub fn is_clockwise_to(&self, other: &Self) -> Option<bool>

Determines whether the current vector is clockwise relative to another vector (other).

This is determined using the cross product:

• Some(true) if self is clockwise to other.
• Some(false) if self is counterclockwise to other.
• None if self and other are collinear.

Arguments

• other - The vector to compare relative direction with.

Returns

An Option<bool> indicating the relative direction.

pub fn angle_to(&self, other: &Self) -> T

Computes the angle (in degrees) between the current vector and another vector (other).

The method calculates the cosine of the angle using the dot product, clamps it to the valid range of [-1, 1], and then computes the angle in degrees.

Arguments

• other - The target vector to compute the angle to.

Returns

The angle in degrees as a scalar of type T.

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

pub fn euclid_distance(&self, other: &Self) -> T

Computes the Euclidean distance between the current vector and another vector.

Arguments

• other - The other vector to compute the distance to.

Returns

The Euclidean distance as a scalar of type T.

pub fn euclid_distance_sq(&self, other: &Self) -> T

Computes the Euclidean distance squared.

Arguments

• other - The other vector to compute the distance to.

Returns

The Euclidean distance squared as a scalar of type T.

pub fn x(&self) -> T

Returns the x-component of the vector.

Returns

The x value of type T.

pub fn y(&self) -> T

Returns the y-component of the vector.

Returns

The y value of type T.

pub fn get(&self, axis: VecAxis) -> T

pub fn is_zero(&self) -> bool

pub fn wrap_around_map(&self) -> Self

Wraps the vector around a predefined 2D map.

This method ensures the vector’s coordinates do not exceed the boundaries of the map defined by map_size(). If coordinates go beyond these boundaries, they are wrapped to remain within valid values.

pub fn wraps(&self) -> WrapDirection

pub fn wrap_by(&self, dir: &WrapDirection) -> Self

Trait Implementations

impl<T, const X: u32, const Y: u32> Deref for Wrapped2D<T, X, Y>

fn deref(&self) -> &Self::Target

Dereferences the Wrapped2D wrapper to access its inner Vec2D value.

Returns

A reference to the inner Vec2D.

type Target = Vec2D<T>

The resulting type after dereferencing.