Struct Vec2

pub struct Vec2 {
    pub x: f64,
    pub y: f64,
}

A 2D vector.

This is intended primarily for a vector in the mathematical sense, but it can be interpreted as a translation, and converted to and from a Point (vector relative to the origin) and Size.

Fields

x: f64

The x-coordinate.

y: f64

The y-coordinate.

Implementations

impl Vec2

pub const ZERO: Vec2 = _

The vector (0, 0).

pub const fn new(x: f64, y: f64) -> Vec2

Create a new vector.

pub const fn to_point(self) -> Point

Convert this vector into a Point.

pub const fn to_size(self) -> Size

Convert this vector into a Size.

pub fn dot(self, other: Vec2) -> f64

Dot product of two vectors.

pub fn cross(self, other: Vec2) -> f64

Cross product of two vectors.

This is signed so that (0, 1) × (1, 0) = 1.

pub fn hypot(self) -> f64

Magnitude of vector.

This is similar to self.hypot2().sqrt() but defers to the platform f64::hypot method, which in general will handle the case where self.hypot2() > f64::MAX.

See Point::distance for the same operation on Point.

Examples

use kurbo::Vec2;
let v = Vec2::new(3.0, 4.0);
assert_eq!(v.hypot(), 5.0);

pub fn length(self) -> f64

Magnitude of vector.

This is an alias for Vec2::hypot.

pub fn hypot2(self) -> f64

Magnitude squared of vector.

See Point::distance_squared for the same operation on Point.

Examples

use kurbo::Vec2;
let v = Vec2::new(3.0, 4.0);
assert_eq!(v.hypot2(), 25.0);

pub fn length_squared(self) -> f64

Magnitude squared of vector.

This is an alias for Vec2::hypot2.

pub fn atan2(self) -> f64

Find the angle in radians between this vector and the vector Vec2 { x: 1.0, y: 0.0 } in the positive y direction.

If the vector is interpreted as a complex number, this is the argument. The angle is expressed in radians.

pub fn angle(self) -> f64

Find the angle in radians between this vector and the vector Vec2 { x: 1.0, y: 0.0 } in the positive y direction.

This is an alias for Vec2::atan2.

pub fn from_angle(th: f64) -> Vec2

A unit vector of the given angle.

With th at zero, the result is the positive X unit vector, and at π/2, it is the positive Y unit vector. The angle is expressed in radians.

Thus, in a Y-down coordinate system (as is common for graphics), it is a clockwise rotation, and in Y-up (traditional for math), it is anti-clockwise. This convention is consistent with Affine::rotate.

pub fn lerp(self, other: Vec2, t: f64) -> Vec2

Linearly interpolate between two vectors.

pub fn normalize(self) -> Vec2

Returns a vector of magnitude 1.0 with the same angle as self; i.e. a unit/direction vector.

This produces NaN values when the magnitude is 0.

pub fn round(self) -> Vec2

Returns a new Vec2, with x and y rounded to the nearest integer.

Examples

use kurbo::Vec2;
let a = Vec2::new(3.3, 3.6).round();
let b = Vec2::new(3.0, -3.1).round();
assert_eq!(a.x, 3.0);
assert_eq!(a.y, 4.0);
assert_eq!(b.x, 3.0);
assert_eq!(b.y, -3.0);

pub fn ceil(self) -> Vec2

Returns a new Vec2, with x and y rounded up to the nearest integer, unless they are already an integer.

Examples

use kurbo::Vec2;
let a = Vec2::new(3.3, 3.6).ceil();
let b = Vec2::new(3.0, -3.1).ceil();
assert_eq!(a.x, 4.0);
assert_eq!(a.y, 4.0);
assert_eq!(b.x, 3.0);
assert_eq!(b.y, -3.0);

pub fn floor(self) -> Vec2

Returns a new Vec2, with x and y rounded down to the nearest integer, unless they are already an integer.

Examples

use kurbo::Vec2;
let a = Vec2::new(3.3, 3.6).floor();
let b = Vec2::new(3.0, -3.1).floor();
assert_eq!(a.x, 3.0);
assert_eq!(a.y, 3.0);
assert_eq!(b.x, 3.0);
assert_eq!(b.y, -4.0);

pub fn expand(self) -> Vec2

Returns a new Vec2, with x and y rounded away from zero to the nearest integer, unless they are already an integer.

Examples

use kurbo::Vec2;
let a = Vec2::new(3.3, 3.6).expand();
let b = Vec2::new(3.0, -3.1).expand();
assert_eq!(a.x, 4.0);
assert_eq!(a.y, 4.0);
assert_eq!(b.x, 3.0);
assert_eq!(b.y, -4.0);

pub fn trunc(self) -> Vec2

Returns a new Vec2, with x and y rounded towards zero to the nearest integer, unless they are already an integer.

Examples

use kurbo::Vec2;
let a = Vec2::new(3.3, 3.6).trunc();
let b = Vec2::new(3.0, -3.1).trunc();
assert_eq!(a.x, 3.0);
assert_eq!(a.y, 3.0);
assert_eq!(b.x, 3.0);
assert_eq!(b.y, -3.0);

pub fn is_finite(self) -> bool

Is this Vec2 finite?

pub fn is_nan(self) -> bool

Is this Vec2 NaN?

Trait Implementations

impl Add<TranslateScale> for Vec2

type Output = TranslateScale

The resulting type after applying the + operator.

fn add(self, other: TranslateScale) -> TranslateScale

Performs the + operation.

impl Add<Vec2> for Circle

type Output = Circle

The resulting type after applying the + operator.

fn add(self, v: Vec2) -> Circle

Performs the + operation.

impl Add<Vec2> for CircleSegment

type Output = CircleSegment

The resulting type after applying the + operator.

fn add(self, v: Vec2) -> Self

Performs the + operation.

impl Add<Vec2> for Ellipse

fn add(self, v: Vec2) -> Ellipse

In this context adding a Vec2 applies the corresponding translation to the ellipse.

type Output = Ellipse

The resulting type after applying the + operator.

impl Add<Vec2> for Line

type Output = Line

The resulting type after applying the + operator.

fn add(self, v: Vec2) -> Line

Performs the + operation.

impl Add<Vec2> for Point

type Output = Point

The resulting type after applying the + operator.

fn add(self, other: Vec2) -> Self

Performs the + operation.

impl Add<Vec2> for Rect

type Output = Rect

The resulting type after applying the + operator.

fn add(self, v: Vec2) -> Rect

Performs the + operation.

impl Add<Vec2> for RoundedRect

type Output = RoundedRect

The resulting type after applying the + operator.

fn add(self, v: Vec2) -> RoundedRect

Performs the + operation.

impl Add<Vec2> for TranslateScale

type Output = TranslateScale

The resulting type after applying the + operator.

fn add(self, other: Vec2) -> TranslateScale

Performs the + operation.

impl Add for Vec2

type Output = Vec2

The resulting type after applying the + operator.

fn add(self, other: Vec2) -> Vec2

Performs the + operation.

impl AddAssign<Vec2> for Point

fn add_assign(&mut self, other: Vec2)

Performs the += operation.

impl AddAssign<Vec2> for TranslateScale

fn add_assign(&mut self, other: Vec2)

Performs the += operation.

impl AddAssign for Vec2

fn add_assign(&mut self, other: Vec2)

Performs the += operation.

impl Clone for Vec2

fn clone(&self) -> Vec2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vec2

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

Formats the value using the given formatter.

impl Default for Vec2

fn default() -> Vec2

Returns the “default value” for a type.

impl Display for Vec2

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

Formats the value using the given formatter.

impl Div<f64> for Vec2

fn div(self, other: f64) -> Vec2

Note: division by a scalar is implemented by multiplying by the reciprocal.

This is more efficient but has different roundoff behavior than division.

type Output = Vec2

The resulting type after applying the / operator.

impl DivAssign<f64> for Vec2

fn div_assign(&mut self, other: f64)

Performs the /= operation.

impl From<(f64, f64)> for Vec2

fn from(v: (f64, f64)) -> Vec2

Converts to this type from the input type.

impl From<Vec2> for (f64, f64)

fn from(v: Vec2) -> (f64, f64)

Converts to this type from the input type.

impl Mul<Vec2> for f64

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, other: Vec2) -> Vec2

Performs the * operation.

impl Mul<f64> for Vec2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, other: f64) -> Vec2

Performs the * operation.

impl MulAssign<f64> for Vec2

fn mul_assign(&mut self, other: f64)

Performs the *= operation.

impl Neg for Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn neg(self) -> Vec2

Performs the unary - operation.

impl PartialEq for Vec2

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub<Vec2> for Circle

type Output = Circle

The resulting type after applying the - operator.

fn sub(self, v: Vec2) -> Circle

Performs the - operation.

impl Sub<Vec2> for CircleSegment

type Output = CircleSegment

The resulting type after applying the - operator.

fn sub(self, v: Vec2) -> Self

Performs the - operation.

impl Sub<Vec2> for Ellipse

fn sub(self, v: Vec2) -> Ellipse

In this context subtracting a Vec2 applies the corresponding translation to the ellipse.

type Output = Ellipse

The resulting type after applying the - operator.

impl Sub<Vec2> for Line

type Output = Line

The resulting type after applying the - operator.

fn sub(self, v: Vec2) -> Line

Performs the - operation.

impl Sub<Vec2> for Point

type Output = Point

The resulting type after applying the - operator.

fn sub(self, other: Vec2) -> Self

Performs the - operation.

impl Sub<Vec2> for Rect

type Output = Rect

The resulting type after applying the - operator.

fn sub(self, v: Vec2) -> Rect

Performs the - operation.

impl Sub<Vec2> for RoundedRect

type Output = RoundedRect

The resulting type after applying the - operator.

fn sub(self, v: Vec2) -> RoundedRect

Performs the - operation.

impl Sub<Vec2> for TranslateScale

type Output = TranslateScale

The resulting type after applying the - operator.

fn sub(self, other: Vec2) -> TranslateScale

Performs the - operation.

impl Sub for Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn sub(self, other: Vec2) -> Vec2

Performs the - operation.

impl SubAssign<Vec2> for Point

fn sub_assign(&mut self, other: Vec2)

Performs the -= operation.

impl SubAssign<Vec2> for TranslateScale

fn sub_assign(&mut self, other: Vec2)

Performs the -= operation.

impl SubAssign for Vec2

fn sub_assign(&mut self, other: Vec2)

Performs the -= operation.

impl Copy for Vec2

impl StructuralPartialEq for Vec2