Struct quicksilver::geom::Vector

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

A 2D vector with an arbitrary numeric type

Fields

x: f32

The x coordinate of the vector

y: f32

The y coordinate of the vector

Methods

impl Vector

pub const ZERO: Vector

A vector with x = 0, y = 0

pub const X: Vector

A vector with x = 1, y = 0

pub const Y: Vector

A vector with x = 0, y = 1

pub const ONE: Vector

A vector with x = 1, y = 1

impl Vector

pub fn new(x: impl Scalar, y: impl Scalar) -> Vector

Create a new vector

pub fn into_vector(self) -> Vector2<f32>

Convert this vector into an nalgebra Vector2

pub fn into_point(self) -> Point2<f32>

Convert this vector into an nalgebra Point2

pub fn from_angle<T: Scalar>(angle: T) -> Vector

Create a unit vector at a given angle

pub fn len2(self) -> f32

Get the squared length of the vector (faster than getting the length)

pub fn len(self) -> f32

Get the length of the vector

#[must_use]

pub fn clamp(
    self,
    min_bound: impl Into<Vector>,
    max_bound: impl Into<Vector>
) -> Vector

Clamp a vector somewhere between a minimum and a maximum

pub fn cross(self, other: impl Into<Vector>) -> f32

Get the cross product of a vector

pub fn dot(self, other: impl Into<Vector>) -> f32

Get the dot product of a vector

#[must_use]

pub fn normalize(self) -> Vector

Normalize the vector's length from [0, 1]

#[must_use]

pub fn x_comp(self) -> Vector

Get only the X component of the Vector, represented as a vector

#[must_use]

pub fn y_comp(self) -> Vector

Get only the Y component of the Vector, represented as a vector

#[must_use]

pub fn recip(self) -> Vector

Get the vector equal to Vector(1 / x, 1 / y)

#[must_use]

pub fn times(self, other: impl Into<Vector>) -> Vector

Multiply the components in the matching places

pub fn angle(self) -> f32

Get the angle a vector forms with the positive x-axis, counter clockwise

#[must_use]

pub fn with_len(self, length: f32) -> Vector

Create a vector with the same angle and the given length

pub fn distance(self, other: impl Into<Vector>) -> f32

Get the Euclidean distance to another vector

pub fn min(self, other: impl Into<Vector>) -> Vector

Get a vector with the minimum of each component of this and another vector

pub fn max(self, other: impl Into<Vector>) -> Vector

Get a vector with the maximum of each component of this and another vector

Trait Implementations

impl Shape for Vector

fn contains(&self, v: impl Into<Vector>) -> bool

If the point lies on the shape's boundary or within it

fn overlaps(&self, shape: &impl Shape) -> bool

If any area is bounded by both either shape

fn center(&self) -> Vector

The point all other points are equidistant to in the shape

fn bounding_box(&self) -> Rectangle

A Rectangle that contains the entire shape

fn translate(&self, v: impl Into<Vector>) -> Vector

Create a copy of the shape with an offset center

#[must_use]

fn intersects(&self, line: &Line) -> bool

If any area bounded by the shape falls on the line

#[must_use]

fn overlaps_circle(&self, circle: &Circle) -> bool

If any area is bounded by both the shape and the circle

#[must_use]

fn overlaps_rectangle(&self, rectangle: &Rectangle) -> bool

If any area is bounded by both the shape and the rectangle

#[must_use]

fn constrain(&self, outer: &Rectangle) -> Self where
    Self: Sized, 

Create a copy of the shape that is contained within the bound

#[must_use]

fn with_center(&self, center: impl Into<Vector>) -> Self where
    Self: Sized, 

Create a copy of the shape with an offset center

impl Drawable for Vector

fn draw<'a>(
    &self,
    mesh: &mut Mesh,
    bkg: Background<'a>,
    trans: Transform,
    z: impl Scalar
)

Draw the object to the Mesh

impl Copy for Vector

impl PartialEq<Vector> for Vector

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl Default for Vector

fn default() -> Vector

Returns the "default value" for a type.

impl From<Matrix<f32, U2, U1, <DefaultAllocator as Allocator<f32, U2, U1>>::Buffer>> for Vector

fn from(other: Vector2<f32>) -> Vector

Performs the conversion.

impl From<Point<f32, U2>> for Vector

fn from(other: Point2<f32>) -> Vector

Performs the conversion.

impl From<Vector> for LogicalPosition

fn from(other: Vector) -> LogicalPosition

Performs the conversion.

impl From<Vector> for PhysicalPosition

fn from(other: Vector) -> PhysicalPosition

Performs the conversion.

impl From<LogicalPosition> for Vector

fn from(other: LogicalPosition) -> Vector

Performs the conversion.

impl From<PhysicalPosition> for Vector

fn from(other: PhysicalPosition) -> Vector

Performs the conversion.

impl From<Vector> for LogicalSize

fn from(other: Vector) -> LogicalSize

Performs the conversion.

impl From<Vector> for PhysicalSize

fn from(other: Vector) -> PhysicalSize

Performs the conversion.

impl From<LogicalSize> for Vector

fn from(other: LogicalSize) -> Vector

Performs the conversion.

impl From<PhysicalSize> for Vector

fn from(other: PhysicalSize) -> Vector

Performs the conversion.

impl<T: Scalar, U: Scalar> From<(T, U)> for Vector

fn from(other: (T, U)) -> Vector

Performs the conversion.

impl Clone for Vector

fn clone(&self) -> Vector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Vector

impl Display for Vector

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

Formats the value using the given formatter.

impl Debug for Vector

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

Formats the value using the given formatter.

impl Add<Vector> for Vector

type Output = Vector

The resulting type after applying the + operator.

fn add(self, rhs: Vector) -> Vector

Performs the + operation.

impl Sub<Vector> for Vector

type Output = Vector

The resulting type after applying the - operator.

fn sub(self, rhs: Vector) -> Vector

Performs the - operation.

impl<T: Scalar> Mul<T> for Vector

type Output = Vector

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Vector

Performs the * operation.

impl Mul<Vector> for Transform

Transform a vector

type Output = Vector

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Scalar> Div<T> for Vector

type Output = Vector

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Vector

Performs the / operation.

impl Neg for Vector

type Output = Vector

The resulting type after applying the - operator.

fn neg(self) -> Vector

Performs the unary - operation.

impl AddAssign<Vector> for Vector

fn add_assign(&mut self, rhs: Vector)

Performs the += operation.

impl SubAssign<Vector> for Vector

fn sub_assign(&mut self, rhs: Vector)

Performs the -= operation.

impl<T: Scalar> MulAssign<T> for Vector

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T: Scalar> DivAssign<T> for Vector

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl Distribution<Vector> for Standard

fn sample<R: Rng + ?Sized>(&self, rand: &mut R) -> Vector

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(&'a self, rng: &'a mut R) -> DistIter<'a, Self, R, T> where
    R: Rng, 

Create an iterator that generates random values of T, using rng as the source of randomness.

impl Serialize for Vector

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Vector

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.