Struct fj_math::Segment

#[repr(C)]
pub struct Segment<const D: usize> { /* private fields */ }

A line segment, defined by its two end points

The dimensionality of the segment is defined by the const generic D parameter.

Implementations

impl<const D: usize> Segment<D>

pub fn from_points(points: [impl Into<Point<D>>; 2]) -> Self

Construct a segment from two points

Panics

Panics, if the points are coincident.

pub fn points(&self) -> [Point<D>; 2]

Access the points of the segment

pub fn center(&self) -> Point<D>

Compute the center point of the segment

pub fn reverse(self) -> Self

Create a segment with the same points in the opposite order

impl Segment<2>

pub fn to_parry(self) -> Segment

Convert the 2-dimensional segment to a Parry segment

impl Segment<3>

pub fn to_parry(self) -> Segment

Convert the 3-dimensional segment to a Parry segment

Trait Implementations

impl<const D: usize> Clone for Segment<D>

fn clone(&self) -> Segment<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const D: usize> Debug for Segment<D>

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

Formats the value using the given formatter.

impl<const D: usize> Default for Segment<D>

fn default() -> Segment<D>

Returns the “default value” for a type.

impl<P, const D: usize> From<[P; 2]> for Segment<D>where
    P: Into<Point<D>>,

fn from(points: [P; 2]) -> Self

Converts to this type from the input type.

impl<const D: usize> Hash for Segment<D>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const D: usize> Ord for Segment<D>

fn cmp(&self, other: &Segment<D>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<const D: usize> PartialEq<Segment<D>> for Segment<D>

fn eq(&self, other: &Segment<D>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<const D: usize> PartialOrd<Segment<D>> for Segment<D>

fn partial_cmp(&self, other: &Segment<D>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const D: usize> Copy for Segment<D>

impl<const D: usize> Eq for Segment<D>

impl<const D: usize> StructuralEq for Segment<D>

impl<const D: usize> StructuralPartialEq for Segment<D>