Struct gamemath::Vec2 [−][src]
pub struct Vec2<T> { pub x: T, pub y: T, }
A two-component Euclidean vector usefull for linear algebra computation in game development and 3D rendering.
Fields
x: T
The X/first component of the vector.
y: T
The Y/second component of the vector.
Methods
impl<T> Vec2<T> where
T: Copy + Debug + PartialEq + Default + Mul<Output = T> + Add<Output = T>,
[src]
impl<T> Vec2<T> where
T: Copy + Debug + PartialEq + Default + Mul<Output = T> + Add<Output = T>,
pub fn new(x: T, y: T) -> Vec2<T>
[src]
pub fn new(x: T, y: T) -> Vec2<T>
Constructs a new Vec2<T>
from two initial values.
Examples
use gamemath::Vec2; let v = Vec2::new(1.0, 5.0); assert_eq!(v.x, 1.0); assert_eq!(v.y, 5.0);
pub fn dot(&self, right: Vec2<T>) -> T
[src]
pub fn dot(&self, right: Vec2<T>) -> T
Calculates the dot/scalar product of two Vec2<T>
s.
The calling object is considered the left value and the argument object is considered the
right value.
Examples
use gamemath::Vec2; let v1 = Vec2::new(1.0, 2.0); let v2 = Vec2::new(3.0, 4.0); assert_eq!(v1.dot(v2), 11.0); assert_eq!(v2.dot(v1), 11.0);
pub fn fill(&mut self, value: T)
[src]
pub fn fill(&mut self, value: T)
Fills all components of the calling Vec2<T>
with the provided value.
Examples
use gamemath::Vec2; let mut v = Vec2::new(0.0, 0.0); v.fill(6.0); assert_eq!(v, Vec2::new(6.0, 6.0));
pub fn length_squared(&self) -> T
[src]
pub fn length_squared(&self) -> T
Calculates the squared length/magnitude/norm of a Vec2<T>
.
This saves an expensive square root calculation compared to calculating the actual length,
and comparing two squared lengths can therefore often be cheaper than, and yield the same
result as, computing two real lengths.
Also usefull for data types that does not implement a square root function, i.e. non-floating-point data types.
Examples
use gamemath::Vec2; let v = Vec2::new(1.0, 2.0); assert_eq!(v.length_squared(), 5.0);
impl Vec2<f32>
[src]
impl Vec2<f32>
pub fn length(&self) -> f32
[src]
pub fn length(&self) -> f32
Calculates the real length/magnitude/norm of a Vec2<f32>
.
This results in an expensive square root calculation, and you might want to consider using
a squared length instead when possible.
Examples
use gamemath::Vec2; let v = Vec2::new(3.0_f32, 4.0_f32); assert_eq!(v.length(), 5.0_f32);
pub fn normalized(&self) -> Vec2<f32>
[src]
pub fn normalized(&self) -> Vec2<f32>
Calculates and returns the unit vector representation of a Vec2<f32>
.
This results in an an expensive square root calculation.
Examples
use gamemath::Vec2; let v = Vec2::new(3.0_f32, 4.0_f32); assert_eq!(v.normalized(), Vec2::new(0.6_f32, 0.8_f32));
pub fn normalize(&mut self)
[src]
pub fn normalize(&mut self)
Normalizes a Vec2<f32>
into its unit vector representation.
This results in an an expensive square root calculation.
Examples
use gamemath::Vec2; let mut v = Vec2::new(3.0_f32, 4.0_f32); v.normalize(); assert_eq!(v, Vec2::new(0.6_f32, 0.8_f32));
impl Vec2<f64>
[src]
impl Vec2<f64>
pub fn length(&self) -> f64
[src]
pub fn length(&self) -> f64
Calculates the real length/magnitude/norm of a Vec2<f64>
.
This results in an expensive square root calculation, and you might want to consider using
a squared length instead when possible.
Examples
use gamemath::Vec2; let v = Vec2::new(3.0_f64, 4.0_f64); assert_eq!(v.length(), 5.0_f64);
pub fn normalized(&self) -> Vec2<f64>
[src]
pub fn normalized(&self) -> Vec2<f64>
Calculates and returns the unit vector representation of a Vec2<f64>
.
This results in an an expensive square root calculation.
Examples
use gamemath::Vec2; let v = Vec2::new(3.0_f64, 4.0_f64); assert_eq!(v.normalized(), Vec2::new(0.6_f64, 0.8_f64));
pub fn normalize(&mut self)
[src]
pub fn normalize(&mut self)
Normalizes a Vec2<f32>
into its unit vector representation.
This results in an an expensive square root calculation.
Examples
use gamemath::Vec2; let mut v = Vec2::new(3.0_f64, 4.0_f64); v.normalize(); assert_eq!(v, Vec2::new(0.6_f64, 0.8_f64));
Trait Implementations
impl<T: Clone> Clone for Vec2<T>
[src]
impl<T: Clone> Clone for Vec2<T>
fn clone(&self) -> Vec2<T>
[src]
fn clone(&self) -> Vec2<T>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl<T: Copy> Copy for Vec2<T>
[src]
impl<T: Copy> Copy for Vec2<T>
impl<T: Debug> Debug for Vec2<T>
[src]
impl<T: Debug> Debug for Vec2<T>
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl<T: PartialEq> PartialEq for Vec2<T>
[src]
impl<T: PartialEq> PartialEq for Vec2<T>
fn eq(&self, other: &Vec2<T>) -> bool
[src]
fn eq(&self, other: &Vec2<T>) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Vec2<T>) -> bool
[src]
fn ne(&self, other: &Vec2<T>) -> bool
This method tests for !=
.
impl<T> Default for Vec2<T> where
T: Default,
[src]
impl<T> Default for Vec2<T> where
T: Default,
impl<T> From<(T, T)> for Vec2<T>
[src]
impl<T> From<(T, T)> for Vec2<T>
impl<T: Copy> From<[T; 2]> for Vec2<T>
[src]
impl<T: Copy> From<[T; 2]> for Vec2<T>
impl<T> From<Vec3<T>> for Vec2<T>
[src]
impl<T> From<Vec3<T>> for Vec2<T>
impl<T> From<Vec4<T>> for Vec2<T>
[src]
impl<T> From<Vec4<T>> for Vec2<T>
impl<T: Copy> From<T> for Vec2<T>
[src]
impl<T: Copy> From<T> for Vec2<T>
impl<T> Index<usize> for Vec2<T>
[src]
impl<T> Index<usize> for Vec2<T>
type Output = T
The returned type after indexing.
fn index(&self, index: usize) -> &T
[src]
fn index(&self, index: usize) -> &T
Performs the indexing (container[index]
) operation.
impl<T> IndexMut<usize> for Vec2<T>
[src]
impl<T> IndexMut<usize> for Vec2<T>
fn index_mut(&mut self, index: usize) -> &mut T
[src]
fn index_mut(&mut self, index: usize) -> &mut T
Performs the mutable indexing (container[index]
) operation.
impl<T: Add<Output = T>> Add for Vec2<T>
[src]
impl<T: Add<Output = T>> Add for Vec2<T>
type Output = Vec2<T>
The resulting type after applying the +
operator.
fn add(self, right: Vec2<T>) -> Vec2<T>
[src]
fn add(self, right: Vec2<T>) -> Vec2<T>
Performs the +
operation.
impl<T: AddAssign> AddAssign for Vec2<T>
[src]
impl<T: AddAssign> AddAssign for Vec2<T>
fn add_assign(&mut self, right: Vec2<T>)
[src]
fn add_assign(&mut self, right: Vec2<T>)
Performs the +=
operation.
impl<T: Sub<Output = T>> Sub for Vec2<T>
[src]
impl<T: Sub<Output = T>> Sub for Vec2<T>
type Output = Vec2<T>
The resulting type after applying the -
operator.
fn sub(self, right: Vec2<T>) -> Vec2<T>
[src]
fn sub(self, right: Vec2<T>) -> Vec2<T>
Performs the -
operation.
impl<T: SubAssign> SubAssign for Vec2<T>
[src]
impl<T: SubAssign> SubAssign for Vec2<T>
fn sub_assign(&mut self, right: Vec2<T>)
[src]
fn sub_assign(&mut self, right: Vec2<T>)
Performs the -=
operation.
impl<T: Mul<Output = T> + Copy> Mul<T> for Vec2<T>
[src]
impl<T: Mul<Output = T> + Copy> Mul<T> for Vec2<T>
type Output = Vec2<T>
The resulting type after applying the *
operator.
fn mul(self, right: T) -> Vec2<T>
[src]
fn mul(self, right: T) -> Vec2<T>
Performs the *
operation.
impl<T: MulAssign + Copy> MulAssign<T> for Vec2<T>
[src]
impl<T: MulAssign + Copy> MulAssign<T> for Vec2<T>
fn mul_assign(&mut self, right: T)
[src]
fn mul_assign(&mut self, right: T)
Performs the *=
operation.
impl<T: Neg<Output = T>> Neg for Vec2<T>
[src]
impl<T: Neg<Output = T>> Neg for Vec2<T>
type Output = Vec2<T>
The resulting type after applying the -
operator.
fn neg(self) -> Vec2<T>
[src]
fn neg(self) -> Vec2<T>
Performs the unary -
operation.
impl<T: Default> From<Vec2<T>> for Vec3<T>
[src]
impl<T: Default> From<Vec2<T>> for Vec3<T>
impl<T: Default> From<Vec2<T>> for Vec4<T>
[src]
impl<T: Default> From<Vec2<T>> for Vec4<T>