1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
//! Math utilities on `Position` which don't exist in the Screeps API
//! proper.
use std::ops::{Add, Sub};
use super::Position;
use crate::{constants::Direction, local::position::WorldPositionOutOfBoundsError};
impl Position {
/// Returns a new position offset from this position by the specified x
/// coords and y coords.
///
/// This function operates on world coordinates, and will wrap between rooms
/// if necessary.
///
/// To return a new position rather than modifying in place, use `pos + (x,
/// y)`. See the implementation of `Add<(i32, i32)>` for
/// [`Position`] further down on this page.
///
/// # Panics
///
/// Will panic if the new position overflows the world. See
/// [`Position::from_world_coords`].
///
/// # Example
///
/// ```
/// # use std::convert::TryFrom;
/// # use screeps::{Position, RoomCoordinate};
/// let e21s21 = "E21S21".parse().unwrap();
/// let e21s22 = "E21S22".parse().unwrap();
///
/// let mut pos = Position::new(
/// RoomCoordinate::try_from(21).unwrap(),
/// RoomCoordinate::try_from(21).unwrap(),
/// e21s21,
/// );
/// pos.offset(5, 5);
/// assert_eq!(
/// pos,
/// Position::new(
/// RoomCoordinate::try_from(26).unwrap(),
/// RoomCoordinate::try_from(26).unwrap(),
/// e21s21
/// )
/// );
///
/// pos.offset(0, 49);
/// assert_eq!(
/// pos,
/// Position::new(
/// RoomCoordinate::try_from(26).unwrap(),
/// RoomCoordinate::try_from(25).unwrap(),
/// e21s22
/// )
/// );
/// ```
#[inline]
#[track_caller]
pub fn offset(&mut self, x: i32, y: i32) {
*self = *self + (x, y);
}
/// Adds an `(x, y)` pair to this room position's world coordinates and
/// returns the result.
///
/// Will change rooms if necessary.
///
/// # Errors
/// Returns `Err` if the new position's room is outside bounds.
///
/// For a panicking variant of this function, see [`Position::add`].
///
/// See [`Position::from_world_coords`].
#[inline]
pub fn checked_add(self, rhs: (i32, i32)) -> Result<Position, WorldPositionOutOfBoundsError> {
let (x1, y1) = self.world_coords();
let (x2, y2) = rhs;
Position::checked_from_world_coords(x1 + x2, y1 + y2)
}
/// Adds a [`Direction`] to this room position's world coordinates and
/// returns the result.
///
/// Will change rooms if necessary.
///
/// # Errors
/// Returns `Err` if the new position's room is outside bounds.
///
/// See [`Position::from_world_coords`].
#[inline]
pub fn checked_add_direction(
self,
direction: Direction,
) -> Result<Position, WorldPositionOutOfBoundsError> {
let (x1, y1) = self.world_coords();
let (x2, y2) = direction.into();
Position::checked_from_world_coords(x1 + x2, y1 + y2)
}
}
impl Add<(i32, i32)> for Position {
type Output = Position;
/// Adds an `(x, y)` pair to this room position's world coordinates.
///
/// Will change rooms if necessary.
///
/// # Panics
///
/// Will panic if the new position's room is outside bounds. See
/// [`Position::from_world_coords`].
///
/// # Example
///
/// ```
/// # use std::convert::TryFrom;
/// # use screeps::{Position, RoomCoordinate};
/// let w5s6 = "W5S6".parse().unwrap();
/// let w5s5 = "W5S5".parse().unwrap();
///
/// let pos1 = Position::new(
/// RoomCoordinate::try_from(42).unwrap(),
/// RoomCoordinate::try_from(42).unwrap(),
/// w5s6,
/// );
/// let pos2 = pos1 + (7, 7);
/// assert_eq!(
/// pos2,
/// Position::new(
/// RoomCoordinate::try_from(49).unwrap(),
/// RoomCoordinate::try_from(49).unwrap(),
/// w5s6
/// )
/// );
///
/// let pos3 = pos2 + (0, -59);
/// assert_eq!(
/// pos3,
/// Position::new(
/// RoomCoordinate::try_from(49).unwrap(),
/// RoomCoordinate::try_from(40).unwrap(),
/// w5s5
/// )
/// );
///
/// let pos4 = pos3 - (49, 0);
/// assert_eq!(
/// pos4,
/// Position::new(
/// RoomCoordinate::try_from(0).unwrap(),
/// RoomCoordinate::try_from(40).unwrap(),
/// w5s5
/// )
/// );
/// ```
#[inline]
#[track_caller]
fn add(self, (x, y): (i32, i32)) -> Self {
self.checked_add((x, y)).unwrap()
}
}
impl Add<Direction> for Position {
type Output = Position;
#[inline]
#[track_caller]
fn add(self, direction: Direction) -> Self {
self.checked_add_direction(direction).unwrap()
}
}
impl Sub<(i32, i32)> for Position {
type Output = Position;
/// See the implementation of `Add<(i32, i32)>` for [`Position`].
#[inline]
#[track_caller]
fn sub(self, (x, y): (i32, i32)) -> Self {
self.checked_add((-x, -y)).unwrap()
}
}
impl Sub<Direction> for Position {
type Output = Position;
#[inline]
fn sub(self, direction: Direction) -> Self {
self.checked_add_direction(-direction).unwrap()
}
}
impl Sub<Position> for Position {
type Output = (i32, i32);
/// Subtracts the other room position from this one, extracting the
/// difference as the output.
///
/// # Example
///
/// ```
/// # use std::convert::TryFrom;
/// # use screeps::{Position, RoomCoordinate};
/// let e5n5 = "E5N5".parse().unwrap();
/// let e5n6 = "E5N6".parse().unwrap();
///
/// let pos1 = Position::new(
/// RoomCoordinate::try_from(40).unwrap(),
/// RoomCoordinate::try_from(40).unwrap(),
/// e5n5,
/// );
/// let pos2 = Position::new(
/// RoomCoordinate::try_from(0).unwrap(),
/// RoomCoordinate::try_from(20).unwrap(),
/// e5n6,
/// );
/// assert_eq!(pos1 - pos2, (40, 70));
/// ```
#[inline]
fn sub(self, other: Position) -> (i32, i32) {
let (mx, my) = self.world_coords();
let (ox, oy) = other.world_coords();
(mx - ox, my - oy)
}
}