Struct Vec2

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

Fields

x: f32

y: f32

Implementations

impl Vec2

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

Create a new instance of Vec2

use ck::Vec2;

let v = Vec2::new(1.0, 2.0);
assert_eq!(v.x, 1.0);
assert_eq!(v.y, 2.0);

pub fn len(&self) -> f32

Get the length of a Vec2

use ck::Vec2;

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

pub fn len_squared(&self) -> f32

Get the squared length of a Vec2

use ck::Vec2;

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

pub fn normalize(&self) -> Vec2

Get a new normalized version of a Vec2

use ck::Vec2;

let v = Vec2::new(3.0, 4.0);
let vn = v.normalize();
assert_eq!(vn.x, 3.0/5.0);
assert_eq!(vn.y, 4.0/5.0);

pub fn raw(&self) -> [f32; 2]

Get the raw data represented by a Vec2

use ck::Vec2;

let v = Vec2::new(1.0, 2.0);
let r: [f32; 2] = v.raw();
assert_eq!(v.x, r[0]);
assert_eq!(v.y, r[1]);

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

Get the dot product of two Vec2

use ck::Vec2;

let v1 = Vec2::new(1.0, 2.0);
let v2 = Vec2::new(3.0, 4.0);
let res: f32 = v1.dot(&v2);
assert_eq!(res, 11.0);

Trait Implementations

impl Add for Vec2

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

Overload the + operator for Vec2

Examples

use ck::Vec2;

let v1 = Vec2 { x: 1.0, y: 2.0 };
let v2 = Vec2 { x: 3.0, y: 4.0 };
let v = v1 + v2;

assert_eq!(v.x, 4.0);
assert_eq!(v.y, 6.0);

type Output = Vec2

The resulting type after applying the + operator.

impl Debug for Vec2

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

Formats the value using the given formatter.

impl Index<usize> for Vec2

fn index(&self, idx: usize) -> &f32

Indexing for Vec2 instead of field access by name

Examples

use ck::Vec2;

let v = Vec2 { x: 1.0, y: 2.0 };
assert_eq!(v[0], 1.0);
assert_eq!(v[1], 2.0);

type Output = f32

The returned type after indexing.

impl IndexMut<usize> for Vec2

fn index_mut(&mut self, idx: usize) -> &mut f32

Mutable indexing for Vec2 instead of setting fields by name

Examples

use ck::Vec2;

let mut v = Vec2 { x: 0.0, y: 0.0 };
v[0] = 1.0;
v[1] = 2.0;
assert_eq!(v.x, 1.0);
assert_eq!(v.y, 2.0);

impl Sub for Vec2

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

Overload the - operator for Vec2

Examples

use ck::Vec2;

let v1 = Vec2 { x: 1.0, y: 2.0 };
let v2 = Vec2 { x: 3.0, y: 5.0 };
let v = v1 - v2;

assert_eq!(v.x, -2.0);
assert_eq!(v.y, -3.0);

type Output = Vec2

The resulting type after applying the - operator.