[−][src]Struct nannou::geom::vector::Vector2
A 2-dimensional vector.
Fields
x: S
y: S
Methods
impl<S> Vector2<S>
[src]
pub fn new(x: S, y: S) -> Vector2<S>
[src]
Construct a new vector, using the provided values.
pub fn from_value(scalar: S) -> Vector2<S> where
S: Clone,
[src]
S: Clone,
Construct a vector using the given value for each field.
pub fn len(&self) -> usize
[src]
The number of dimensions in the vector.
pub fn map<U, F>(self, f: F) -> Vector2<U> where
F: FnMut(S) -> U,
[src]
F: FnMut(S) -> U,
Perform the given operation on each field in the vector, returning a new vector constructed from the operations.
pub fn zip_map<T, U, F>(self, other: Vector2<T>, f: F) -> Vector2<U> where
F: FnMut(S, T) -> U,
[src]
F: FnMut(S, T) -> U,
Perform the given operation on each each field on both vectors, returning a new vector constructed from the operations.
pub fn is_finite(&self) -> bool where
S: BaseFloat,
[src]
S: BaseFloat,
Test whether or not the vector is infinite.
pub fn cast<T>(&self) -> Option<Vector2<T>> where
S: NumCast + Clone,
T: NumCast,
[src]
S: NumCast + Clone,
T: NumCast,
Component-wise casting to another type.
pub fn zero() -> Vector2<S> where
S: Zero,
[src]
S: Zero,
A zeroed vector.
pub fn is_zero(&self) -> bool where
S: PartialEq + Zero,
[src]
S: PartialEq + Zero,
Whether or not the vector is zeroed.
pub fn one() -> Vector2<S> where
S: One,
[src]
S: One,
A vector with 1
for each element.
pub fn is_one(&self) -> bool where
S: PartialEq + One,
[src]
S: PartialEq + One,
Whether or not each element in the vector is equal to 1
.
pub fn is_nan(&self) -> bool where
S: BaseFloat,
[src]
S: BaseFloat,
Tests whether or not any of the vector's elements is NaN
.
pub fn sum(self) -> S where
S: Add<Output = S> + Copy,
[src]
S: Add<Output = S> + Copy,
Sum the fields of the vector.
pub fn product(self) -> S where
S: Mul<Output = S> + Copy,
[src]
S: Mul<Output = S> + Copy,
The product of the fields of the vector.
pub fn limit_magnitude(self, limit: S) -> Self where
S: BaseFloat,
[src]
S: BaseFloat,
Return a vector whose magnitude is limited to the given value.
pub fn with_magnitude(self, magnitude: S) -> Self where
S: BaseFloat,
[src]
S: BaseFloat,
Return a vector with the given magnitude.
pub fn normalize(self) -> Self where
S: BaseFloat,
[src]
S: BaseFloat,
Return a normalized vector.
If self
is_zero
, this returns self
.
pub fn dot(self, other: Vector2<S>) -> S where
S: BaseFloat,
[src]
S: BaseFloat,
The dot product of self and the given vector.
impl<S> Vector2<S>
[src]
pub fn unit_x() -> Vector2<S> where
S: Zero + One,
[src]
S: Zero + One,
A unit vector in the x
direction.
pub fn unit_y() -> Vector2<S> where
S: Zero + One,
[src]
S: Zero + One,
A unit vector in the y
direction.
pub fn perp_dot(self, other: Vector2<S>) -> S where
S: Sub<Output = S> + Mul<Output = S>,
[src]
S: Sub<Output = S> + Mul<Output = S>,
The perpendicular dot product of the vector and other
.
pub fn extend(self, z: S) -> Vector3<S>
[src]
Create a Vector3
, using the x
and y
values from this vector, and the
provided z
.
pub fn angle(self) -> S where
S: BaseFloat,
[src]
S: BaseFloat,
Returns the angle of the vector in radians.
Examples
let vector = Vector2::new(-0.5, 0.5); let theta = vector.angle() * -1.0; draw.quad() .rotate(theta); assert_eq!(theta, -2.356194490192345);
Trait Implementations
impl<S: Clone> Clone for Vector2<S>
[src]
fn clone(&self) -> Vector2<S>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<S> AsMut<[S; 2]> for Vector2<S>
[src]
impl<S: Default> Default for Vector2<S>
[src]
impl<S> AsRef<[S; 2]> for Vector2<S>
[src]
impl<S: PartialEq> PartialEq<Vector2<S>> for Vector2<S>
[src]
impl<S> Into<Vector2<S>> for Vector2<S>
[src]
impl<S> Into<Point2<S>> for Vector2<S>
[src]
impl<S> Into<[S; 2]> for Vector2<S>
[src]
impl<S> Into<(S, S)> for Vector2<S>
[src]
impl<S: Eq> Eq for Vector2<S>
[src]
impl<S> From<Vector2<S>> for Vector2<S>
[src]
impl<S> From<Point2<S>> for Vector2<S>
[src]
impl<S> From<[S; 2]> for Vector2<S> where
S: Copy,
[src]
S: Copy,
impl<S> From<(S, S)> for Vector2<S>
[src]
impl<S> From<Vector2<S>> for Vector3<S> where
S: Zero,
[src]
S: Zero,
impl<S> From<Vector2<S>> for Vector4<S> where
S: Zero,
[src]
S: Zero,
impl<S: Copy> Copy for Vector2<S>
[src]
impl<S: Debug> Debug for Vector2<S>
[src]
impl<S> Add<Vector2<S>> for Vector2<S> where
S: Add<Output = S>,
[src]
S: Add<Output = S>,
type Output = Vector2<S>
The resulting type after applying the +
operator.
fn add(self, other: Self) -> Self
[src]
impl<S> Sub<Vector2<S>> for Vector2<S> where
S: Sub<Output = S>,
[src]
S: Sub<Output = S>,
type Output = Vector2<S>
The resulting type after applying the -
operator.
fn sub(self, other: Self) -> Self
[src]
impl<S> Mul<Vector2<S>> for Vector2<S> where
S: Mul<Output = S>,
[src]
S: Mul<Output = S>,
type Output = Vector2<S>
The resulting type after applying the *
operator.
fn mul(self, other: Self) -> Self
[src]
impl<S> Mul<S> for Vector2<S> where
S: Copy + Mul<Output = S>,
[src]
S: Copy + Mul<Output = S>,
type Output = Vector2<S>
The resulting type after applying the *
operator.
fn mul(self, scalar: S) -> Self
[src]
impl<S> Div<Vector2<S>> for Vector2<S> where
S: Div<Output = S>,
[src]
S: Div<Output = S>,
type Output = Vector2<S>
The resulting type after applying the /
operator.
fn div(self, other: Self) -> Self
[src]
impl<S> Div<S> for Vector2<S> where
S: Copy + Div<Output = S>,
[src]
S: Copy + Div<Output = S>,
type Output = Vector2<S>
The resulting type after applying the /
operator.
fn div(self, scalar: S) -> Self
[src]
impl<S> Rem<Vector2<S>> for Vector2<S> where
S: Rem<Output = S>,
[src]
S: Rem<Output = S>,
type Output = Vector2<S>
The resulting type after applying the %
operator.
fn rem(self, other: Self) -> Self
[src]
impl<S> Rem<S> for Vector2<S> where
S: Copy + Rem<Output = S>,
[src]
S: Copy + Rem<Output = S>,
type Output = Vector2<S>
The resulting type after applying the %
operator.
fn rem(self, scalar: S) -> Self
[src]
impl<S> Neg for Vector2<S> where
S: Neg<Output = S>,
[src]
S: Neg<Output = S>,
type Output = Vector2<S>
The resulting type after applying the -
operator.
fn neg(self) -> Vector2<S>
[src]
impl<S> AddAssign<Vector2<S>> for Vector2<S> where
S: AddAssign,
[src]
S: AddAssign,
fn add_assign(&mut self, other: Self)
[src]
impl<S> SubAssign<Vector2<S>> for Vector2<S> where
S: SubAssign,
[src]
S: SubAssign,
fn sub_assign(&mut self, other: Self)
[src]
impl<S> MulAssign<Vector2<S>> for Vector2<S> where
S: Copy + MulAssign,
[src]
S: Copy + MulAssign,
fn mul_assign(&mut self, other: Self)
[src]
impl<S> MulAssign<S> for Vector2<S> where
S: Copy + MulAssign,
[src]
S: Copy + MulAssign,
fn mul_assign(&mut self, scalar: S)
[src]
impl<S> DivAssign<Vector2<S>> for Vector2<S> where
S: Copy + DivAssign,
[src]
S: Copy + DivAssign,
fn div_assign(&mut self, other: Self)
[src]
impl<S> DivAssign<S> for Vector2<S> where
S: Copy + DivAssign,
[src]
S: Copy + DivAssign,
fn div_assign(&mut self, scalar: S)
[src]
impl<S> RemAssign<Vector2<S>> for Vector2<S> where
S: Copy + RemAssign,
[src]
S: Copy + RemAssign,
fn rem_assign(&mut self, other: Self)
[src]
impl<S> RemAssign<S> for Vector2<S> where
S: Copy + RemAssign,
[src]
S: Copy + RemAssign,
fn rem_assign(&mut self, scalar: S)
[src]
impl<S> Deref for Vector2<S>
[src]
impl<S> DerefMut for Vector2<S>
[src]
impl<S> Index<usize> for Vector2<S>
[src]
impl<S> Index<Range<usize>> for Vector2<S>
[src]
type Output = [S]
The returned type after indexing.
fn index<'a>(&'a self, i: Range<usize>) -> &'a [S]
[src]
impl<S> Index<RangeTo<usize>> for Vector2<S>
[src]
type Output = [S]
The returned type after indexing.
fn index<'a>(&'a self, i: RangeTo<usize>) -> &'a [S]
[src]
impl<S> Index<RangeFrom<usize>> for Vector2<S>
[src]
type Output = [S]
The returned type after indexing.
fn index<'a>(&'a self, i: RangeFrom<usize>) -> &'a [S]
[src]
impl<S> Index<RangeFull> for Vector2<S>
[src]
type Output = [S]
The returned type after indexing.
fn index<'a>(&'a self, i: RangeFull) -> &'a [S]
[src]
impl<S> IndexMut<usize> for Vector2<S>
[src]
impl<S> IndexMut<Range<usize>> for Vector2<S>
[src]
impl<S> IndexMut<RangeTo<usize>> for Vector2<S>
[src]
impl<S> IndexMut<RangeFrom<usize>> for Vector2<S>
[src]
fn index_mut<'a>(&'a mut self, i: RangeFrom<usize>) -> &'a mut [S]
[src]
impl<S> IndexMut<RangeFull> for Vector2<S>
[src]
impl<S: Hash> Hash for Vector2<S>
[src]
fn hash<__HS: Hasher>(&self, state: &mut __HS)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl<S> Sum<Vector2<S>> for Vector2<S> where
S: Zero + Add<Output = S>,
[src]
S: Zero + Add<Output = S>,
impl<'a, S: 'a> Sum<&'a Vector2<S>> for Vector2<S> where
S: 'a + Clone + Zero + Add<Output = S>,
[src]
S: 'a + Clone + Zero + Add<Output = S>,
impl<S> Zero for Vector2<S> where
S: PartialEq + Zero,
[src]
S: PartialEq + Zero,
fn zero() -> Vector2<S>
[src]
fn is_zero(&self) -> bool
[src]
fn set_zero(&mut self)
[src]
Sets self
to the additive identity element of Self
, 0
.
impl<S> Bounded for Vector2<S> where
S: Bounded,
[src]
S: Bounded,
impl<S> Serialize for Vector2<S> where
S: Serialize,
[src]
S: Serialize,
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl<'de, S> Deserialize<'de> for Vector2<S> where
S: Deserialize<'de>,
[src]
S: Deserialize<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl<S> ApproxEq for Vector2<S> where
S: ApproxEq,
S::Epsilon: Copy,
[src]
S: ApproxEq,
S::Epsilon: Copy,
type Epsilon = S::Epsilon
Used for specifying relative comparisons.
fn default_epsilon() -> S::Epsilon
[src]
fn default_max_relative() -> S::Epsilon
[src]
fn default_max_ulps() -> u32
[src]
fn relative_eq(
&self,
other: &Self,
epsilon: Self::Epsilon,
max_relative: Self::Epsilon
) -> bool
[src]
&self,
other: &Self,
epsilon: Self::Epsilon,
max_relative: Self::Epsilon
) -> bool
fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool
[src]
fn relative_ne(
&self,
other: &Self,
epsilon: Self::Epsilon,
max_relative: Self::Epsilon
) -> bool
[src]
&self,
other: &Self,
epsilon: Self::Epsilon,
max_relative: Self::Epsilon
) -> bool
The inverse of ApproxEq::relative_eq
.
fn ulps_ne(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool
[src]
The inverse of ApproxEq::ulps_eq
.
impl<S> ElementWise<S> for Vector2<S> where
S: BaseNum,
[src]
S: BaseNum,
fn add_element_wise(self, rhs: S) -> Vector2<S>
[src]
fn sub_element_wise(self, rhs: S) -> Vector2<S>
[src]
fn mul_element_wise(self, rhs: S) -> Vector2<S>
[src]
fn div_element_wise(self, rhs: S) -> Vector2<S>
[src]
fn rem_element_wise(self, rhs: S) -> Vector2<S>
[src]
fn add_assign_element_wise(&mut self, rhs: S)
[src]
fn sub_assign_element_wise(&mut self, rhs: S)
[src]
fn mul_assign_element_wise(&mut self, rhs: S)
[src]
fn div_assign_element_wise(&mut self, rhs: S)
[src]
fn rem_assign_element_wise(&mut self, rhs: S)
[src]
impl<S> ElementWise<Vector2<S>> for Vector2<S> where
S: BaseFloat,
[src]
S: BaseFloat,
fn add_element_wise(self, rhs: Vector2<S>) -> Vector2<S>
[src]
fn sub_element_wise(self, rhs: Vector2<S>) -> Vector2<S>
[src]
fn mul_element_wise(self, rhs: Vector2<S>) -> Vector2<S>
[src]
fn div_element_wise(self, rhs: Vector2<S>) -> Vector2<S>
[src]
fn rem_element_wise(self, rhs: Vector2<S>) -> Vector2<S>
[src]
fn add_assign_element_wise(&mut self, rhs: Vector2<S>)
[src]
fn sub_assign_element_wise(&mut self, rhs: Vector2<S>)
[src]
fn mul_assign_element_wise(&mut self, rhs: Vector2<S>)
[src]
fn div_assign_element_wise(&mut self, rhs: Vector2<S>)
[src]
fn rem_assign_element_wise(&mut self, rhs: Vector2<S>)
[src]
impl<S> InnerSpace for Vector2<S> where
S: BaseFloat,
[src]
S: BaseFloat,
fn dot(self, other: Vector2<S>) -> S
[src]
fn angle(self, other: Vector2<S>) -> Rad<S>
[src]
fn is_perpendicular(self, other: Self) -> bool
[src]
Returns true
if the vector is perpendicular (at right angles) to the other vector. Read more
fn magnitude2(self) -> Self::Scalar
[src]
Returns the squared magnitude. Read more
fn magnitude(self) -> Self::Scalar
[src]
The distance from the tail to the tip of the vector.
fn normalize(self) -> Self
[src]
Returns a vector with the same direction, but with a magnitude of 1
.
fn normalize_to(self, magnitude: Self::Scalar) -> Self
[src]
Returns a vector with the same direction and a given magnitude.
fn lerp(self, other: Self, amount: Self::Scalar) -> Self
[src]
Returns the result of linearly interpolating the magnitude of the vector towards the magnitude of other
by the specified amount. Read more
fn project_on(self, other: Self) -> Self
[src]
Returns the vector projection of the current inner space projected onto the supplied argument. Read more
impl<S> Array for Vector2<S> where
S: Copy,
[src]
S: Copy,
type Element = S
fn len() -> usize
[src]
fn from_value(scalar: S) -> Vector2<S>
[src]
fn sum(self) -> S where
S: Add<Output = S>,
[src]
S: Add<Output = S>,
fn product(self) -> S where
S: Mul<Output = S>,
[src]
S: Mul<Output = S>,
fn as_ptr(&self) -> *const Self::Element
[src]
Get the pointer to the first element of the array.
fn as_mut_ptr(&mut self) -> *mut Self::Element
[src]
Get a mutable pointer to the first element of the array.
fn swap_elements(&mut self, i: usize, j: usize)
[src]
Swap the elements at indices i
and j
in-place.
impl<S> VectorSpace for Vector2<S> where
S: BaseNum,
[src]
S: BaseNum,
type Scalar = S
The associated scalar.
impl<S> EuclideanSpace for Vector2<S> where
S: BaseNum,
[src]
S: BaseNum,
type Scalar = S
The associated scalar over which the space is defined. Read more
type Diff = Vector2<S>
The associated space of displacement vectors.
fn origin() -> Self
[src]
fn from_vec(v: Vector2<S>) -> Self
[src]
fn to_vec(self) -> Vector2<S>
[src]
fn dot(self, other: Vector2<S>) -> S
[src]
fn midpoint(self, other: Self) -> Self
[src]
Returns the middle point between two other points. Read more
fn centroid(points: &[Self]) -> Self
[src]
Returns the average position of all points in the slice. Read more
impl<S> MetricSpace for Vector2<S> where
S: BaseFloat,
[src]
S: BaseFloat,
type Metric = S
The metric to be returned by the distance
function.
fn distance2(self, other: Self) -> S
[src]
fn distance(self, other: Self) -> Self::Metric
[src]
The distance between two values.
impl<S> Distribution<Vector2<S>> for Standard where
Standard: Distribution<S>,
[src]
Standard: Distribution<S>,
fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Vector2<S>
[src]
ⓘImportant traits for DistIter<'a, D, R, T>fn sample_iter<R>(&'a self, rng: &'a mut R) -> DistIter<'a, Self, R, T> where
R: Rng,
[src]
R: Rng,
Create an iterator that generates random values of T
, using rng
as the source of randomness. Read more
Auto Trait Implementations
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> NodeId for T where
T: 'static + Copy + Clone + PartialEq<T> + Eq + Hash + Send,
[src]
T: 'static + Copy + Clone + PartialEq<T> + Eq + Hash + Send,
impl<T, Rhs> NumAssignOps<Rhs> for T where
T: AddAssign<Rhs> + SubAssign<Rhs> + MulAssign<Rhs> + DivAssign<Rhs> + RemAssign<Rhs>,
[src]
T: AddAssign<Rhs> + SubAssign<Rhs> + MulAssign<Rhs> + DivAssign<Rhs> + RemAssign<Rhs>,
impl<T, Rhs, Output> NumOps<Rhs, Output> for T where
T: Sub<Rhs, Output = Output> + Mul<Rhs, Output = Output> + Div<Rhs, Output = Output> + Add<Rhs, Output = Output> + Rem<Rhs, Output = Output>,
[src]
T: Sub<Rhs, Output = Output> + Mul<Rhs, Output = Output> + Div<Rhs, Output = Output> + Add<Rhs, Output = Output> + Rem<Rhs, Output = Output>,
impl<T> Style for T where
T: Any + Debug + PartialEq<T>,
[src]
T: Any + Debug + PartialEq<T>,
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T> Content for T
[src]
fn ref_from_ptr(ptr: *mut c_void, size: usize) -> Option<*mut T>
[src]
fn is_size_suitable(size: usize) -> bool
[src]
fn indiv_size() -> usize
[src]
impl<T> SafeBorrow<T> for T
[src]
impl<S> FromSample<S> for S
[src]
fn from_sample_(s: S) -> S
[src]
impl<T, U> ToSample<U> for T where
U: FromSample<T>,
[src]
U: FromSample<T>,
fn to_sample_(self) -> U
[src]
impl<S, T> Duplex<S> for T where
T: FromSample<S> + ToSample<S>,
[src]
T: FromSample<S> + ToSample<S>,
impl<T> SetParameter for T
fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,
T: Parameter<Self>,
Sets value
as a parameter of self
.
impl<T> SetParameter for T
fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,
T: Parameter<Self>,
Sets value
as a parameter of self
.