Struct Vector2 

pub struct Vector2<W = Generic> {
    pub x: f64,
    pub y: f64,
    /* private fields */
}

A representation of a vector in 2D space.

Fields

x: f64

Horizontal component.

y: f64

Vertical component.

Implementations

impl<W: Space> Vector2<W>

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

Constructs a vector from x and y components.

pub fn x() -> Self

Unit vector along the x axis.

pub fn y() -> Self

Unit vector along the y axis.

pub fn normal(&self) -> Self

Returns the left-handed normal.

pub fn normalize(self) -> Self

Returns this vector scaled to unit length.

pub fn length_squared(&self) -> f64

Returns squared vector length.

pub fn length(&self) -> f64

Returns vector length.

pub fn coord_abs(&self) -> Self

Returns a vector with absolute component values.

pub fn project_onto(self, axis: Self) -> Self

Projects this vector onto axis.

pub fn project_axis_aligned(self, other: Self) -> Self

pub fn angle_to(self, other: Self) -> Rotation

Returns the counter-clockwise angle from this vector to other.

pub fn cross(self, other: Self) -> f64

Returns the z component of the 3D cross product, assuming both vectors have z value 0.0.

pub fn to_signums_of(&self, other: Self) -> Self

Copies this vector’s magnitudes onto the component signs of other.

pub fn to_point(&self) -> Point2<W>

Reinterprets this vector as a point.

pub fn cast_space<WNew: Space>(&self) -> Vector2<WNew>

Casts this vector into another phantom coordinate space.

pub fn rotate(&self, angle: Rotation) -> Self

Rotates this vector by angle.

pub fn rotate90(self) -> Self

Rotates this vector 90 degrees clockwise.

pub fn mult(&self, other: Self) -> Vector2<W>

Multiplies component-wise by other.

Trait Implementations

impl<W: Space> Add for Vector2<W>

type Output = Vector2<W>

The resulting type after applying the + operator.

fn add(self, rhs: Vector2<W>) -> Self::Output

Performs the + operation.

impl<W: Space> Add<Point2<W>> for Vector2<W>

type Output = Point2<W>

The resulting type after applying the + operator.

fn add(self, rhs: Point2<W>) -> Self::Output

Performs the + operation.

impl<W: Space> Add<Vector2<W>> for Point2<W>

type Output = Point2<W>

The resulting type after applying the + operator.

fn add(self, rhs: Vector2<W>) -> Self::Output

Performs the + operation.

impl<W: Space> Add<f64> for Vector2<W>

type Output = Vector2<W>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<W: Space> Clone for Vector2<W>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CoercionRules for Vector2

fn try_coerce(value: PaxValue) -> Result<Self, String>

Attempts to coerce value into Self.

fn allows_singleton_stack() -> bool

Opts appearance layers into scalar-to-singleton stack conversion. Ordinary vector values remain list-only.

fn is_identity_roundtrip() -> bool

Whether cloning Self preserves the semantics of converting that clone through ToPaxValue and back with try_coerce.

impl<W: Space> Copy for Vector2<W>

impl<W: Space> Debug for Vector2<W>

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

Formats the value using the given formatter.

impl<W: Space> Default for Vector2<W>

fn default() -> Self

Returns the “default value” for a type.

impl<W: Space> Div for Vector2<W>

type Output = Vector2<W>

The resulting type after applying the / operator.

fn div(self, rhs: Vector2<W>) -> Self::Output

Performs the / operation.

impl<W: Space> Div<f64> for Vector2<W>

type Output = Vector2<W>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<W: Space> Interpolatable for Vector2<W>

fn interpolate(&self, _other: &Self, _t: f64) -> Self

Interpolates this value toward other at time t on the unit interval.

impl<W: Space> Mul for Vector2<W>

type Output = f64

The resulting type after applying the * operator.

fn mul(self, rhs: Vector2<W>) -> Self::Output

Performs the * operation.

impl<F: Space, T: Space> Mul<Vector2<F>> for Transform2<F, T>

type Output = Vector2<T>

The resulting type after applying the * operator.

fn mul(self, other: Vector2<F>) -> Self::Output

Performs the * operation.

impl<W: Space> Mul<Vector2<W>> for f64

type Output = Vector2<W>

The resulting type after applying the * operator.

fn mul(self, rhs: Vector2<W>) -> Self::Output

Performs the * operation.

impl<W: Space> Mul<f64> for Vector2<W>

type Output = Vector2<W>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<W: Space> Neg for Vector2<W>

type Output = Vector2<W>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<W: Space> PartialEq for Vector2<W>

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

Equality operator ==.

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

Inequality operator !=.

impl<W: Space> Sub for Vector2<W>

type Output = Vector2<W>

The resulting type after applying the - operator.

fn sub(self, rhs: Vector2<W>) -> Self::Output

Performs the - operation.

impl<W: Space> Sub<Vector2<W>> for Point2<W>

type Output = Point2<W>

The resulting type after applying the - operator.

fn sub(self, rhs: Vector2<W>) -> Self::Output

Performs the - operation.

impl<W: Space> Sub<f64> for Vector2<W>

type Output = Vector2<W>

The resulting type after applying the - operator.

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

Performs the - operation.

impl ToPaxValue for Vector2

fn to_pax_value(self) -> PaxValue

Converts this value into a PaxValue.

fn nested_properties(&self) -> Vec<UntypedProperty>

Live properties read when snapshotting a compound value for PAXEL. Adapters observe these as well as the containing property.

fn to_pax_value_in_graph(self) -> PaxValue

where Self: Sized,

Converts against owner-thread graph views, including nested generated property fields. Requires an entered property graph for shared fields. Ordinary Self::to_pax_value reads published value snapshots.