Trait cgmath::InnerSpace

source ·
pub trait InnerSpace: VectorSpacewhere
    <Self as VectorSpace>::Scalar: BaseFloat,
    Self: MetricSpace<Metric = <Self as VectorSpace>::Scalar> + ApproxEq<Epsilon = <Self as VectorSpace>::Scalar>,{
    // Required method
    fn dot(self, other: Self) -> Self::Scalar;

    // Provided methods
    fn is_perpendicular(self, other: Self) -> bool { ... }
    fn magnitude2(self) -> Self::Scalar { ... }
    fn magnitude(self) -> Self::Scalar { ... }
    fn angle(self, other: Self) -> Rad<Self::Scalar> { ... }
    fn normalize(self) -> Self { ... }
    fn normalize_to(self, magnitude: Self::Scalar) -> Self { ... }
    fn lerp(self, other: Self, amount: Self::Scalar) -> Self { ... }
}
Expand description

Vectors that also have a dot (or inner) product.

The dot product allows for the definition of other useful operations, like finding the magnitude of a vector or normalizing it.

Examples include vectors and quaternions.

Required Methods§

source

fn dot(self, other: Self) -> Self::Scalar

Vector dot (or inner) product.

Provided Methods§

source

fn is_perpendicular(self, other: Self) -> bool

Returns true if the vector is perpendicular (at right angles) to the other vector.

source

fn magnitude2(self) -> Self::Scalar

Returns the squared magnitude.

This does not perform an expensive square root operation like in InnerSpace::magnitude method, and so can be used to compare magnitudes more efficiently.

source

fn magnitude(self) -> Self::Scalar

The distance from the tail to the tip of the vector.

source

fn angle(self, other: Self) -> Rad<Self::Scalar>

Returns the angle between two vectors in radians.

source

fn normalize(self) -> Self

Returns a vector with the same direction, but with a magnitude of 1.

source

fn normalize_to(self, magnitude: Self::Scalar) -> Self

Returns a vector with the same direction and a given magnitude.

source

fn lerp(self, other: Self, amount: Self::Scalar) -> Self

Returns the result of linearly interpolating the magnitude of the vector towards the magnitude of other by the specified amount.

Implementors§