Struct Vector 

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

Defines a vector.

Fields

x: f64

The X component.

y: f64

The Y component.

Implementations

impl Vector

pub const ZERO: Vector

The zero vector.

pub const ONE: Vector

The one vector.

pub const UNIT_X: Vector

The X unit vector.

pub const UNIT_Y: Vector

The Y unit vector.

pub const fn new(x: f64, y: f64) -> Self

Initializes a new instance of the Vector structure.

pub fn parse(s: &str) -> Result<Self, FormatError>

Parses a Vector string ("x, y" or "x y").

pub fn length(&self) -> f64

Length of the vector.

pub fn squared_length(&self) -> f64

Squared length of the vector.

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

Check if two vectors are equal (exact comparison of the components).

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

Check if two vectors are nearly equal (numerically).

pub const fn with_x(&self, x: f64) -> Vector

Returns a new vector with the specified X component.

pub const fn with_y(&self, y: f64) -> Vector

Returns a new vector with the specified Y component.

pub fn normalize(&self) -> Vector

Returns a normalized version of this vector. A zero-length vector yields NaN components.

pub fn negate(&self) -> Vector

Returns a negated version of this vector.

pub fn dot(a: Vector, b: Vector) -> f64

Returns the dot product of two vectors.

pub fn cross(a: Vector, b: Vector) -> f64

Returns the cross product of two vectors.

pub fn normalize_vector(vector: Vector) -> Vector

Normalizes the given vector (static form of normalize).

pub fn divide(a: Vector, b: Vector) -> Vector

Divides the first vector by the second, component-wise.

pub fn divide_scalar(vector: Vector, scalar: f64) -> Vector

Divides the vector by the given scalar.

pub fn multiply(a: Vector, b: Vector) -> Vector

Multiplies the first vector by the second, component-wise.

pub fn multiply_scalar(vector: Vector, scalar: f64) -> Vector

Multiplies the vector by the given scalar.

pub fn add(a: Vector, b: Vector) -> Vector

Adds the second to the first vector.

pub fn subtract(a: Vector, b: Vector) -> Vector

Subtracts the second from the first vector.

pub fn negate_vector(vector: Vector) -> Vector

Negates the vector (static form of negate).

pub const fn deconstruct(&self) -> (f64, f64)

Deconstructs the vector into its X and Y components.

pub fn abs(&self) -> Vector

Returns a vector whose elements are the absolute values of each of the specified vector’s elements.

pub fn clamp(value: Vector, min: Vector, max: Vector) -> Vector

Restricts a vector between a minimum and a maximum value.

pub fn max(left: Vector, right: Vector) -> Vector

Returns a vector whose elements are the maximum of each of the pairs of elements in two specified vectors.

pub fn min(left: Vector, right: Vector) -> Vector

Returns a vector whose elements are the minimum of each of the pairs of elements in two specified vectors.

pub fn distance(value1: Vector, value2: Vector) -> f64

Computes the Euclidean distance between the two given points.

pub fn distance_squared(value1: Vector, value2: Vector) -> f64

Returns the Euclidean distance squared between two specified points.

Trait Implementations

impl Add for Vector

type Output = Vector

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Vector> for Point

type Output = Point

The resulting type after applying the + operator.

fn add(self, b: Vector) -> Point

Performs the + operation.

impl AddAssign for Vector

fn add_assign(&mut self, b: Vector)

Performs the += operation.

impl AddAssign<Vector> for Point

fn add_assign(&mut self, b: Vector)

Performs the += operation.

impl BatchValue for Vector

fn write_to(&self, out: &mut Vec<u8>)

fn read_from(input: &mut BatchValueReader<'_>) -> Self

impl Clone for Vector

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Vector

impl Debug for Vector

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

Formats the value using the given formatter.

impl Default for Vector

fn default() -> Self

Returns the “default value” for a type.

impl Display for Vector

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

Formats the value using the given formatter.

impl Div<Vector> for Rect

Divides a rectangle by a vector.

type Output = Rect

The resulting type after applying the / operator.

fn div(self, scale: Vector) -> Rect

Performs the / operation.

impl Div<Vector> for Size

Scales a size.

type Output = Size

The resulting type after applying the / operator.

fn div(self, scale: Vector) -> Size

Performs the / operation.

impl Div<f64> for Vector

type Output = Vector

The resulting type after applying the / operator.

fn div(self, scale: f64) -> Vector

Performs the / operation.

impl DivAssign<Vector> for Rect

fn div_assign(&mut self, scale: Vector)

Performs the /= operation.

impl DivAssign<Vector> for Size

fn div_assign(&mut self, scale: Vector)

Performs the /= operation.

impl DivAssign<f64> for Vector

fn div_assign(&mut self, scale: f64)

Performs the /= operation.

impl ExpressionVariantValue for Vector

const FFI_VARIANT_TYPE: Option<VariantType>

The variant type a foreign function parameter of this type is matched against, or None when the type cannot be a foreign function parameter.

fn try_from_variant(v: &ExpressionVariant) -> Option<Self>

See ExpressionVariant::try_cast.

fn into_variant(self) -> ExpressionVariant

See ExpressionVariant::create.

impl From<Point> for Vector

Converts the Point to a Vector.

fn from(p: Point) -> Vector

Converts to this type from the input type.

impl From<Vector2> for Vector

The widening conversion to the double-precision vector.

fn from(value: Vector2) -> Vector

Converts to this type from the input type.

impl From<Vector> for Vector2

The narrowing conversion of the double-precision vector.

fn from(value: Vector) -> Vector2

Converts to this type from the input type.

impl From<Vector> for ExpressionVariant

fn from(value: Vector) -> ExpressionVariant

Converts to this type from the input type.

impl From<Vector> for Point

Converts the Vector to a Point (an explicit conversion in the reference API).

fn from(a: Vector) -> Point

Converts to this type from the input type.

impl From<Vector> for (f64, f64)

fn from(v: Vector) -> Self

Converts to this type from the input type.

impl FromStr for Vector

type Err = FormatError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, FormatError>

Parses a string s to return a value of this type.

impl IInterpolator<Vector> for VectorInterpolator

fn interpolate(&self, from: Vector, to: Vector, progress: f32) -> Vector

impl MarkupTyped for Vector

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl Mul for Vector

Calculates the dot product of two vectors.

type Output = f64

The resulting type after applying the * operator.

fn mul(self, b: Vector) -> f64

Performs the * operation.

impl Mul<Vector> for Rect

Multiplies a rectangle by a scaling vector.

type Output = Rect

The resulting type after applying the * operator.

fn mul(self, scale: Vector) -> Rect

Performs the * operation.

impl Mul<Vector> for Size

Scales a size.

type Output = Size

The resulting type after applying the * operator.

fn mul(self, scale: Vector) -> Size

Performs the * operation.

impl Mul<Vector> for f64

type Output = Vector

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for Vector

type Output = Vector

The resulting type after applying the * operator.

fn mul(self, scale: f64) -> Vector

Performs the * operation.

impl MulAssign<Vector> for Rect

fn mul_assign(&mut self, scale: Vector)

Performs the *= operation.

impl MulAssign<Vector> for Size

fn mul_assign(&mut self, scale: Vector)

Performs the *= operation.

impl MulAssign<f64> for Vector

fn mul_assign(&mut self, scale: f64)

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

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

Equality operator ==.

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

Inequality operator !=.

impl ServerPropertyValue for Vector

fn differs(&self, other: &Self) -> bool

fn default_equals(&self, other: &Self) -> bool

impl StructuralPartialEq for Vector

impl Sub for Vector

type Output = Vector

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Vector> for Point

type Output = Point

The resulting type after applying the - operator.

fn sub(self, b: Vector) -> Point

Performs the - operation.

impl SubAssign for Vector

fn sub_assign(&mut self, b: Vector)

Performs the -= operation.

impl SubAssign<Vector> for Point

fn sub_assign(&mut self, b: Vector)

Performs the -= operation.

impl Transition<Vector> for VectorTransition

fn do_transition( this: &Self, progress: Rc<dyn IObservable<f64>>, old_value: Vector, new_value: Vector, ) -> Rc<dyn IObservable<Vector>>

Creates the observable of the values of the transition from old_value to new_value, driven by progress (from 0 to 1).