Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #283

Merged
merged 2 commits into from
Aug 4, 2022
Merged

Documentation #283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a23b49
Added usage documentation for vector2.rs
dogunbound Aug 4, 2022
6b7af6f
Bug fixes and documentation for vector3.rs
dogunbound Aug 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
219 changes: 219 additions & 0 deletions src/system/vector2.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,27 @@ pub type Vector2f = Vector2<f32>;

impl<T> Vector2<T> {
/// Creates a new vector from its coordinates.
///
/// # Usage example
///
/// ```
/// # use sfml::system::Vector2;
/// let v: Vector2<isize> = Vector2::new(6969, 6969);
/// ```
pub const fn new(x: T, y: T) -> Self {
Self { x, y }
}
/// Lossless conversion into `Vector2<U>`.
///
/// # Usage example
///
/// ```
/// # use sfml::system::Vector2;
/// let vu: Vector2<u16> = Vector2::new(6969, 6969);
/// let vi: Vector2<i32> = vu.into_other();
/// assert_eq!(vu.x, vi.x.try_into().unwrap());
/// assert_eq!(vu.y, vu.y.try_into().unwrap());
/// ```
pub fn into_other<U>(self) -> Vector2<U>
where
T: Into<U>,
Expand All @@ -75,6 +92,22 @@ impl<T> Vector2<T> {
}
}
/// Fallible conversion into `Vector2<U>`
///
/// # Usage example
///
/// ```
/// # use sfml::system::Vector2;
/// // Passing case
/// let vi: Vector2<i32> = Vector2::new(21, 21);
/// let vu: Vector2<u32> = vi.try_into_other().unwrap(); // or any other Result resolution
/// assert_eq!(u32::try_from(vi.x).unwrap(), vu.x);
/// assert_eq!(u32::try_from(vi.y).unwrap(), vu.y);
///
/// // Failing case
/// let vi: Vector2<i32> = Vector2::new(-21, -21);
/// let vu = vi.try_into_other::<u32>();
/// assert!(vu.is_err());
/// ```
pub fn try_into_other<U>(self) -> Result<Vector2<U>, T::Error>
where
T: TryInto<U>,
Expand All @@ -85,6 +118,16 @@ impl<T> Vector2<T> {
})
}
/// Lossy conversion into `Vector2<U>`
///
/// # Usage example
///
/// ```
/// # use sfml::system::Vector2;
/// let vf: Vector2<f32> = Vector2::new(696969.6969, 6969.6969);
/// let vi: Vector2<i32> = vf.as_other();
/// assert_eq!(vf.x as i32, vi.x);
/// assert_eq!(vf.y as i32, vi.y);
/// ```
pub fn as_other<U: 'static + Copy>(self) -> Vector2<U>
where
T: AsPrimitive<U>,
Expand All @@ -98,24 +141,59 @@ impl<T> Vector2<T> {

impl<T: Mul<Output = T> + Add<Output = T> + Copy> Vector2<T> {
/// Dot product of two 2D vectors.
///
/// # Usage example
///
/// ```
/// # use sfml::system::Vector2i;
/// let a = Vector2i::new(16, 64);
/// let b = Vector2i::new(2, 4);
/// assert_eq!(a.dot(b), 288);
/// ```
pub fn dot(self, rhs: Self) -> T {
self.x * rhs.x + self.y * rhs.y
}
/// Square of vector's length.
///
/// # Usage example
///
/// ```
/// # use sfml::system::Vector2i;
/// let a = Vector2i::new(10, 9);
/// assert_eq!(a.length_sq(), 181);
/// ```
pub fn length_sq(self) -> T {
self.dot(self)
}
}

impl<T: Mul<Output = T> + Sub<Output = T> + Copy> Vector2<T> {
/// Z component of the cross product of two 2D vectors.
///
/// # Usage example
///
/// ```
/// # use sfml::system::Vector2i;
/// let a = Vector2i::new(69, 420);
/// let b = Vector2i::new(21, 101);
/// assert_eq!(a.cross(b), -1851);
/// ```
pub fn cross(self, rhs: Self) -> T {
self.x * rhs.y - self.y * rhs.x
}
}

impl<T: Mul<Output = T>> Vector2<T> {
/// Component-wise multiplication of self and rhs.
///
/// # Usage example
///
/// ```
/// # use sfml::system::Vector2i;
/// let a = Vector2i::new(1, 1);
/// let b = Vector2i::new(2, 2);
/// assert_eq!(a.cwise_mul(b), Vector2i::new(2, 2));
/// ```
pub fn cwise_mul(self, rhs: Self) -> Vector2<T> {
Self {
x: self.x * rhs.x,
Expand All @@ -126,6 +204,15 @@ impl<T: Mul<Output = T>> Vector2<T> {

impl<T: Div<Output = T>> Vector2<T> {
/// Component-wise division of self and rhs. Panics on divide by zero
///
/// # Usage example
///
/// ```
/// # use sfml::system::Vector2i;
/// let a = Vector2i::new(69, 69);
/// let b = Vector2i::new(3, 3);
/// assert_eq!(a.cwise_div(b), Vector2i::new(23, 23));
/// ```
pub fn cwise_div(self, rhs: Self) -> Vector2<T> {
Vector2 {
x: self.x / rhs.x,
Expand All @@ -136,6 +223,20 @@ impl<T: Div<Output = T>> Vector2<T> {

impl<T: Div<Output = T> + CheckedDiv> Vector2<T> {
/// Component-wise checked division of self and rhs. Returns None on divide by zero
///
/// # Usage example
///
/// ```
/// # use sfml::system::Vector2i;
/// // Passing case
/// let a = Vector2i::new(69, 69);
/// let b = Vector2i::new(3, 3);
/// assert_eq!(a.cwise_checked_div(b), Some(Vector2i::new(23, 23)));
///
/// // Failing case
/// let b = Vector2i::new(0, 3);
/// assert_eq!(a.cwise_checked_div(b), None);
/// ```
pub fn cwise_checked_div(self, rhs: Self) -> Option<Vector2<T>> {
let x = self.x.checked_div(&rhs.x)?;
let y = self.y.checked_div(&rhs.y)?;
Expand All @@ -145,13 +246,30 @@ impl<T: Div<Output = T> + CheckedDiv> Vector2<T> {

impl<T: Neg<Output = T>> Vector2<T> {
/// Returns a perpendicular vector rotated +90 degrees
///
/// # Usage example
///
/// ```
/// # use sfml::system::Vector2i;
/// let a = Vector2i::new(21, -21);
/// assert_eq!(a.perpendicular(), Vector2i::new(21, 21));
/// ```
pub fn perpendicular(self) -> Vector2<T> {
Vector2::new(-self.y, self.x)
}
}

impl<T> From<(T, T)> for Vector2<T> {
/// Constructs a `Vector2` from `(x, y)`.
///
/// # Usage example
///
/// ```
/// # use sfml::system::Vector2;
/// let a: Vector2<u16> = Vector2::from((69u16, 420u16));
/// assert_eq!(a.x, 69u16);
/// assert_eq!(a.y, 420u16);
/// ```
fn from(src: (T, T)) -> Self {
Self { x: src.0, y: src.1 }
}
Expand All @@ -160,6 +278,16 @@ impl<T> From<(T, T)> for Vector2<T> {
impl<T: Add> Add<Vector2<T>> for Vector2<T> {
type Output = Vector2<T::Output>;

/// Performs component wise addition
///
/// # Usage Example
///
/// ```
/// # use sfml::system::Vector2i;
/// let a = Vector2i::new(9, 10);
/// let b = Vector2i::new(10, 9);
/// assert_ne!(a + b, Vector2i::new(21, 21));
/// ```
fn add(self, rhs: Vector2<T>) -> Vector2<T::Output> {
Vector2 {
x: self.x + rhs.x,
Expand All @@ -169,6 +297,17 @@ impl<T: Add> Add<Vector2<T>> for Vector2<T> {
}

impl<T: AddAssign> AddAssign for Vector2<T> {
/// Performs component wise addition assignment
///
/// # Usage Example
///
/// ```
/// # use sfml::system::Vector2i;
/// let mut a = Vector2i::new(9, 10);
/// let b = Vector2i::new(10, 9);
/// a += b;
/// assert_eq!(a, Vector2i::new(19, 19));
/// ```
fn add_assign(&mut self, rhs: Self) {
self.x += rhs.x;
self.y += rhs.y;
Expand All @@ -178,6 +317,16 @@ impl<T: AddAssign> AddAssign for Vector2<T> {
impl<T: Sub> Sub<Vector2<T>> for Vector2<T> {
type Output = Vector2<T::Output>;

/// Performs component wise subtraction
///
/// # Usage Example
///
/// ```
/// # use sfml::system::Vector2i;
/// let a = Vector2i::new(9, 10);
/// let b = Vector2i::new(10, 9);
/// assert_eq!(a - b, Vector2i::new(-1, 1));
/// ```
fn sub(self, rhs: Vector2<T>) -> Vector2<T::Output> {
Vector2 {
x: self.x - rhs.x,
Expand All @@ -187,6 +336,17 @@ impl<T: Sub> Sub<Vector2<T>> for Vector2<T> {
}

impl<T: SubAssign> SubAssign for Vector2<T> {
/// Performs component wise subtraction assignment
///
/// # Usage Example
///
/// ```
/// # use sfml::system::Vector2i;
/// let mut a = Vector2i::new(9, 10);
/// let b = Vector2i::new(10, 9);
/// a -= b;
/// assert_eq!(a, Vector2i::new(-1, 1));
/// ```
fn sub_assign(&mut self, rhs: Self) {
self.x -= rhs.x;
self.y -= rhs.y;
Expand All @@ -196,6 +356,15 @@ impl<T: SubAssign> SubAssign for Vector2<T> {
impl<T: Mul + Copy> Mul<T> for Vector2<T> {
type Output = Vector2<T::Output>;

/// Performs scalar multiplication
///
/// # Usage Example
///
/// ```
/// # use sfml::system::Vector2i;
/// let a = Vector2i::new(9, 10);
/// assert_eq!(a * 420, Vector2i::new(3780, 4200));
/// ```
fn mul(self, rhs: T) -> Vector2<T::Output> {
Vector2 {
x: self.x * rhs,
Expand All @@ -205,6 +374,16 @@ impl<T: Mul + Copy> Mul<T> for Vector2<T> {
}

impl<T: MulAssign + Copy> MulAssign<T> for Vector2<T> {
/// Performs scalar multiplication assignment
///
/// # Usage Example
///
/// ```
/// # use sfml::system::Vector2i;
/// let mut a = Vector2i::new(9, 10);
/// a *= 420;
/// assert_eq!(a, Vector2i::new(3780, 4200));
/// ```
fn mul_assign(&mut self, rhs: T) {
self.x *= rhs;
self.y *= rhs;
Expand All @@ -214,6 +393,15 @@ impl<T: MulAssign + Copy> MulAssign<T> for Vector2<T> {
impl<T: Div + Copy> Div<T> for Vector2<T> {
type Output = Vector2<T::Output>;

/// Performs scalar division
///
/// # Usage Example
///
/// ```
/// # use sfml::system::Vector2i;
/// let a = Vector2i::new(9, 10);
/// assert_eq!(a / 3, Vector2i::new(3, 3));
/// ```
fn div(self, rhs: T) -> Vector2<T::Output> {
Vector2 {
x: self.x / rhs,
Expand All @@ -223,6 +411,16 @@ impl<T: Div + Copy> Div<T> for Vector2<T> {
}

impl<T: DivAssign + Copy> DivAssign<T> for Vector2<T> {
/// Performs scalar division assignment
///
/// # Usage Example
///
/// ```
/// # use sfml::system::Vector2i;
/// let mut a = Vector2i::new(9, 10);
/// a /= 3;
/// assert_eq!(a, Vector2i::new(3, 3));
/// ```
fn div_assign(&mut self, rhs: T) {
self.x /= rhs;
self.y /= rhs;
Expand All @@ -231,6 +429,18 @@ impl<T: DivAssign + Copy> DivAssign<T> for Vector2<T> {

impl<T: CheckedDiv> Vector2<T> {
/// `checked_div` for scalar division
///
/// # Usage Example
///
/// ```
/// # use sfml::system::Vector2i;
/// // Passing case
/// let a = Vector2i::new(420, 69);
/// assert_eq!(a.checked_div(1000), Some(Vector2i::new(0, 0)));
///
/// // Failing case
/// assert_eq!(a.checked_div(0), None);
/// ```
pub fn checked_div(self, rhs: T) -> Option<Vector2<T>> {
let x = self.x.checked_div(&rhs)?;
let y = self.y.checked_div(&rhs)?;
Expand All @@ -240,6 +450,15 @@ impl<T: CheckedDiv> Vector2<T> {

impl<T: Neg<Output = T>> Neg for Vector2<T> {
type Output = Self;
/// Negates the vector
///
/// # Usage Example
///
/// ```
/// # use sfml::system::Vector2i;
/// use std::ops::Neg;
/// let a = Vector2i::new(21, 21);
/// assert_eq!(a.neg(), Vector2i::new(-21, -21));
fn neg(self) -> Self {
Vector2 {
x: -self.x,
Expand Down
Loading