[−][src]Struct kurbo::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`[src]

`pub const fn new(x: f64, y: f64) -> Vec2`[src]

Create a new vector.

`pub const fn to_point(self) -> Point`[src]

Convert this vector into a Point.

`pub const fn to_size(self) -> Size`[src]

Convert this vector into a Size.

`pub fn dot(self, other: Vec2) -> f64`[src]

Dot product of two vectors.

`pub fn cross(self, other: Vec2) -> f64`[src]

Cross product of two vectors.

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

`pub fn hypot(self) -> f64`[src]

Magnitude of vector.

`pub fn hypot2(self) -> f64`[src]

Magnitude squared of vector.

`pub fn atan2(self) -> f64`[src]

Angle of vector.

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

`pub fn from_angle(th: f64) -> Vec2`[src]

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`[src]

Linearly interpolate between two vectors.

`pub fn normalize(self) -> Vec2`[src]

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 magnitutde is 0.

`pub fn round(self) -> Vec2`[src]

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`[src]

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`[src]

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`[src]

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`[src]

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);