Struct Vector

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

2D vector in Length units.

Fields

x: Length

x displacement in length units.

y: Length

y displacement in length units.

Implementations

impl Vector

pub fn new<X: Into<Length>, Y: Into<Length>>(x: X, y: Y) -> Self

New x, y from any Length unit.

pub fn splat(xy: impl Into<Length>) -> Self

New x, y from single value of any Length unit.

pub fn zero() -> Self

x: Length::zero, y: Length::zero.

pub fn one() -> Self

(1, 1).

pub fn one_px() -> Self

(1.px(), 1.px()).

pub fn yx(self) -> Self

Swap x and y.

pub fn as_tuple(self) -> (Length, Length)

Returns (x, y).

pub fn as_array(self) -> [Length; 2]

Returns [x, y].

pub fn abs(&self) -> Vector

Returns a vector that computes the absolute layout vector of self.

pub fn is_default(&self) -> bool

Returns true if all values are Length::Default.

pub fn replace_default(&mut self, overwrite: &Vector)

Replaces Length::Default values with overwrite values.

pub fn as_point(self) -> Point

Cast to Point.

pub fn as_size(self) -> Size

Cast to Size.

pub fn into_transform(self) -> Transform

Create a translate transform from self.

Trait Implementations

impl<'a> Add<&'a Vector> for &Point

type Output = Point

The resulting type after applying the + operator.

fn add(self, rhs: &'a Vector) -> Self::Output

Performs the + operation.

impl<'a> Add<&'a Vector> for &Vector

type Output = Vector

The resulting type after applying the + operator.

fn add(self, rhs: &'a Vector) -> Self::Output

Performs the + operation.

impl Add for Vector

type Output = Vector

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a> AddAssign<&'a Vector> for Point

fn add_assign(&mut self, rhs: &'a Vector)

Performs the += operation.

impl AddAssign for Vector

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

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 Debug for Vector

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

Formats the value using the given formatter.

impl Default for Vector

fn default() -> Vector

Returns the “default value” for a type.

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.

impl Display for Vector

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

Formats the value using the given formatter.

impl<S: Into<Factor2d>> Div<S> for &Vector

type Output = Vector

The resulting type after applying the / operator.

fn div(self, rhs: S) -> Self::Output

Performs the / operation.

impl<S: Into<Factor2d>> Div<S> for Vector

type Output = Vector

The resulting type after applying the / operator.

fn div(self, rhs: S) -> Self

Performs the / operation.

impl<S: Into<Factor2d>> DivAssign<S> for Vector

fn div_assign(&mut self, rhs: S)

Performs the /= operation.

impl<X, Y> From<(X, Y)> for Vector

where X: Into<Length>, Y: Into<Length>,

fn from((x, y): (X, Y)) -> Self

Converts to this type from the input type.

impl From<Dip> for Vector

fn from(l: Dip) -> Self

Conversion to Length::Dip then to vector.

impl From<Factor> for Vector

fn from(norm: Factor) -> Self

Conversion to Length::Factor then to vector.

impl From<FactorPercent> for Vector

fn from(percent: FactorPercent) -> Self

Conversion to Length::Factor then to vector.

impl From<Length> for Vector

fn from(length: Length) -> Self

Use the length for x and y.

impl From<Point> for Vector

fn from(p: Point) -> Self

Converts to this type from the input type.

impl From<Px> for Vector

fn from(l: Px) -> Self

Conversion to Length::Px then to vector.

impl From<Size> for Vector

fn from(s: Size) -> Self

Converts to this type from the input type.

impl From<Vector> for Point

fn from(v: Vector) -> Self

Converts to this type from the input type.

impl From<Vector> for Size

fn from(v: Vector) -> Self

Converts to this type from the input type.

impl From<Vector2D<Dip, Dip>> for Vector

fn from(p: DipVector) -> Self

Converts to this type from the input type.

impl From<Vector2D<Px, Px>> for Vector

fn from(p: PxVector) -> Self

Converts to this type from the input type.

impl From<f32> for Vector

fn from(f: f32) -> Self

Conversion to Length::Dip then to vector.

impl From<i32> for Vector

fn from(i: i32) -> Self

Conversion to Length::Dip then to vector.

impl IntoVar<Point> for Vector

type Var = LocalVar<Point>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Size> for Vector

type Var = LocalVar<Size>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<X, Y> IntoVar<Vector> for (X, Y)

where X: Into<Length> + Clone, Y: Into<Length> + Clone,

type Var = LocalVar<Vector>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Vector> for Dip

fn into_var(self) -> Self::Var

Conversion to Length::Dip then to vector.

type Var = LocalVar<Vector>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Vector> for Factor

fn into_var(self) -> Self::Var

Conversion to Length::Factor then to vector.

type Var = LocalVar<Vector>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Vector> for FactorPercent

fn into_var(self) -> Self::Var

Conversion to Length::Factor then to vector.

type Var = LocalVar<Vector>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Vector> for Length

fn into_var(self) -> Self::Var

Use the length for x and y.

type Var = LocalVar<Vector>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Vector> for Point

type Var = LocalVar<Vector>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Vector> for Px

fn into_var(self) -> Self::Var

Conversion to Length::Px then to vector.

type Var = LocalVar<Vector>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Vector> for Size

type Var = LocalVar<Vector>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Vector> for DipVector

type Var = LocalVar<Vector>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Vector> for PxVector

type Var = LocalVar<Vector>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Vector> for f32

fn into_var(self) -> Self::Var

Conversion to Length::Dip then to vector.

type Var = LocalVar<Vector>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Vector> for i32

fn into_var(self) -> Self::Var

Conversion to Length::Dip then to vector.

type Var = LocalVar<Vector>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl Layout2d for Vector

type Px = Vector2D<Px, Px>

Pixel type.

fn layout_dft(&self, default: Self::Px) -> Self::Px

Compute the pixel value in the current LAYOUT context with default.

fn affect_mask(&self) -> LayoutMask

Compute a LayoutMask that flags all contextual values that affect the result of layout.

fn layout(&self) -> Self::Px

Compute the pixel value in the current LAYOUT context.

impl<S: Into<Factor2d>> Mul<S> for &Vector

type Output = Vector

The resulting type after applying the * operator.

fn mul(self, rhs: S) -> Self::Output

Performs the * operation.

impl<S: Into<Factor2d>> Mul<S> for Vector

type Output = Vector

The resulting type after applying the * operator.

fn mul(self, rhs: S) -> Self

Performs the * operation.

impl<S: Into<Factor2d>> MulAssign<S> for Vector

fn mul_assign(&mut self, rhs: S)

Performs the *= operation.

impl Neg for &Vector

type Output = Vector

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for Vector

type Output = Vector

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Vector

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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<'a> Sub<&'a Vector> for &Point

type Output = Point

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Vector) -> Self::Output

Performs the - operation.

impl<'a> Sub<&'a Vector> for &Vector

type Output = Vector

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Vector) -> Self::Output

Performs the - operation.

impl Sub for Vector

type Output = Vector

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> SubAssign<&'a Vector> for Point

fn sub_assign(&mut self, rhs: &'a Vector)

Performs the -= operation.

impl SubAssign for Vector

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Transitionable for Vector

fn lerp(self, to: &Self, step: EasingStep) -> Self

Sample the linear interpolation from self -> to by step.

impl IntoValue<Point> for Vector

impl IntoValue<Size> for Vector

impl IntoValue<Vector> for Dip

impl IntoValue<Vector> for Factor

impl IntoValue<Vector> for FactorPercent

impl IntoValue<Vector> for Length

impl IntoValue<Vector> for Point

impl IntoValue<Vector> for Px

impl IntoValue<Vector> for Size

impl IntoValue<Vector> for DipVector

impl IntoValue<Vector> for PxVector

impl IntoValue<Vector> for f32

impl IntoValue<Vector> for i32

impl StructuralPartialEq for Vector