Skip to main content

Vector2

Struct Vector2 

Source
pub struct Vector2 { /* private fields */ }
Expand description

A 2D displacement with finite f64 components.

Vector2 can only be constructed via Vector2::new (or by subtracting two Point2s), which reject NaN and infinite components. Arithmetic between already-finite Vector2/Point2 values (+, -, scaling) does not re-validate its result — the same convention every numeric type in Rust follows (e.g. f64 addition doesn’t return Result) — so it is possible, in principle, for two astronomically large finite inputs to add to an infinite result. This is not treated as a boundary: Point2::new/Vector2::new are the finiteness boundary (ADR-003), not every subsequent arithmetic op.

Implementations§

Source§

impl Vector2

Source

pub fn new(x: f64, y: f64) -> Result<Self, KikaError>

Creates a new vector, rejecting NaN and infinite components.

use kika::Vector2;
assert!(Vector2::new(1.0, 2.0).is_ok());
assert!(Vector2::new(f64::NAN, 0.0).is_err());
Source

pub fn x(&self) -> f64

The x component.

Source

pub fn y(&self) -> f64

The y component.

Trait Implementations§

Source§

impl Add for Vector2

Source§

type Output = Vector2

The resulting type after applying the + operator.
Source§

fn add(self, rhs: Vector2) -> Vector2

Performs the + operation. Read more
Source§

impl Add<Vector2> for Point2

Source§

type Output = Point2

The resulting type after applying the + operator.
Source§

fn add(self, rhs: Vector2) -> Point2

Performs the + operation. Read more
Source§

impl Clone for Vector2

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Vector2

Source§

impl Debug for Vector2

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Mul<f64> for Vector2

Source§

type Output = Vector2

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: f64) -> Vector2

Performs the * operation. Read more
Source§

impl Neg for Vector2

Source§

type Output = Vector2

The resulting type after applying the - operator.
Source§

fn neg(self) -> Vector2

Performs the unary - operation. Read more
Source§

impl PartialEq for Vector2

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Vector2

Source§

impl Sub for Vector2

Source§

type Output = Vector2

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: Vector2) -> Vector2

Performs the - operation. Read more
Source§

impl Sub<Vector2> for Point2

Source§

type Output = Point2

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: Vector2) -> Point2

Performs the - operation. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.