Trait cgmath::Point

pub trait Point: Copy + Clonewhere
    Self: Array<Element = Self::Scalar>,{
    type Scalar: BaseNum;
    type Vector: Vector<Scalar = Self::Scalar>;

    // Required methods
    fn origin() -> Self;
    fn from_vec(v: Self::Vector) -> Self;
    fn to_vec(self) -> Self::Vector;
    fn mul_s(self, scalar: Self::Scalar) -> Self;
    fn div_s(self, scalar: Self::Scalar) -> Self;
    fn rem_s(self, scalar: Self::Scalar) -> Self;
    fn add_v(self, v: Self::Vector) -> Self;
    fn sub_p(self, p: Self) -> Self::Vector;
    fn mul_self_s(&mut self, scalar: Self::Scalar);
    fn div_self_s(&mut self, scalar: Self::Scalar);
    fn rem_self_s(&mut self, scalar: Self::Scalar);
    fn add_self_v(&mut self, v: Self::Vector);
    fn dot(self, v: Self::Vector) -> Self::Scalar;
    fn min(self, p: Self) -> Self;
    fn max(self, p: Self) -> Self;
}

Specifies the numeric operations for point types.

Required Associated Types

type Scalar: BaseNum

The associated scalar.

Due to the equality constraints demanded by Self::Vector, this is effectively just an alias to Self::Vector::Scalar.

type Vector: Vector<Scalar = Self::Scalar>

The associated displacement vector.

Required Methods

fn origin() -> Self

Create a point at the origin.

fn from_vec(v: Self::Vector) -> Self

Create a point from a vector.

fn to_vec(self) -> Self::Vector

Convert a point to a vector.

fn mul_s(self, scalar: Self::Scalar) -> Self

Multiply each component by a scalar, returning the new point.

fn div_s(self, scalar: Self::Scalar) -> Self

Divide each component by a scalar, returning the new point.

fn rem_s(self, scalar: Self::Scalar) -> Self

Subtract a scalar from each component, returning the new point.

fn add_v(self, v: Self::Vector) -> Self

Add a vector to this point, returning the new point.

fn sub_p(self, p: Self) -> Self::Vector

Subtract another point from this one, returning a new vector.

fn mul_self_s(&mut self, scalar: Self::Scalar)

Multiply each component by a scalar, in-place.

fn div_self_s(&mut self, scalar: Self::Scalar)

Divide each component by a scalar, in-place.

fn rem_self_s(&mut self, scalar: Self::Scalar)

Take the remainder of each component by a scalar, in-place.

fn add_self_v(&mut self, v: Self::Vector)

Add a vector to this point, in-place.

fn dot(self, v: Self::Vector) -> Self::Scalar

This is a weird one, but its useful for plane calculations.

fn min(self, p: Self) -> Self

fn max(self, p: Self) -> Self

Implementors

impl<S: BaseNum> Point for Point2<S>

type Scalar = S

type Vector = Vector2<S>

impl<S: BaseNum> Point for Point3<S>

type Scalar = S

type Vector = Vector3<S>