Struct Segment 

pub struct Segment<S> { /* private fields */ }

Available on crate feature math-utils only.

A 1-simplex or line segment in 3D space.

Creation methods should fail with a debug assertion if the points are identical.

Implementations

impl<S> Segment<S>

where S: OrderedRing,

pub fn new(a: Point3<S>, b: Point3<S>) -> Option<Segment<S>>

Returns None if the points are identical:

assert!(Segment::new ([0.0, 0.0, 1.0].into(), [0.0, 0.0, 1.0].into()).is_none());

pub fn noisy(a: Point3<S>, b: Point3<S>) -> Segment<S>

Panics if the points are identical:

let s = Segment::noisy ([0.0, 0.0, 1.0].into(), [0.0, 0.0, 1.0].into());

pub fn unchecked(a: Point3<S>, b: Point3<S>) -> Segment<S>

Debug panic if the points are identical:

let s = Segment::unchecked ([0.0, 0.0, 1.0].into(), [0.0, 0.0, 1.0].into());

pub fn from_array(_: [Point3<S>; 2]) -> Option<Segment<S>>

pub fn numcast<T>(self) -> Option<Segment<T>>

where S: NumCast, T: NumCast,

pub const fn point_a(self) -> Point3<S>

pub const fn point_b(self) -> Point3<S>

pub const fn points(self) -> [Point3<S>; 2]

pub fn point(self, param: Normalized<S>) -> Point3<S>

Return a parameterized point along the segment

pub fn length(self) -> NonNegative<S>

where S: Field + Sqrt,

pub fn length_squared(self) -> NonNegative<S>

pub fn vector(self) -> NonZero3<S>

Returns point_b() - point_a()

pub fn perpendicular(self) -> NonZero3<S>

where S: Field + AbsDiffEq<Epsilon = S>,

Equivalent to self.vector().orthogonal()

pub fn translate(&mut self, displacement: Vec3<S>)

pub fn midpoint(self) -> Point3<S>

where S: Field,

pub fn aabb3(self) -> Aabb3<S>

pub fn line(self) -> Line3<S>

where S: Field + Sqrt,

pub fn affine_line(self) -> Line3<S>

pub fn nearest_point(self, point: Point3<S>) -> (Normalized<S>, Point3<S>)

where S: Field,

pub fn intersect_aabb( self, aabb: Aabb3<S>, ) -> Option<((Normalized<S>, Point3<S>), (Normalized<S>, Point3<S>))>

where S: Real + Float + RelativeEq<Epsilon = S>,

pub fn intersect_triangle( self, triangle: Triangle<S>, ) -> Option<(Normalized<S>, Point3<S>)>

where S: Real + Real + AbsDiffEq<Epsilon = S>,

pub fn intersect_sphere( self, sphere: Sphere3<S>, ) -> Option<((Normalized<S>, Point3<S>), (Normalized<S>, Point3<S>))>

where S: Field + Sqrt,

pub fn intersect_cylinder( self, sphere: Cylinder3<S>, ) -> Option<((Normalized<S>, Point3<S>), (Normalized<S>, Point3<S>))>

where S: Real,

pub fn intersect_capsule( self, capsule: Capsule3<S>, ) -> Option<((Normalized<S>, Point3<S>), (Normalized<S>, Point3<S>))>

where S: Real,

pub fn intersect_hull( self, hull: &Hull3<S>, ) -> Option<((Normalized<S>, Point3<S>), (Normalized<S>, Point3<S>))>

Trait Implementations

impl<S> Clone for Segment<S>

where S: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Segment<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<S> Default for Segment<S>

where S: Ring,

fn default() -> Segment<S>

A default simplex is arbitrarily chosen to be the simplex from -1.0 to 1.0 lying on the X axis:

assert_eq!(
  Segment::default(),
  Segment::noisy ([-1.0, 0.0, 0.0].into(), [1.0, 0.0, 0.0].into())
);

impl<S> From<Segment<S>> for Hull3<S>

where S: Real + RelativeEq<Epsilon = S>,

fn from(segment: Segment<S>) -> Hull3<S>

Converts to this type from the input type.

impl<S> Index<usize> for Segment<S>

where S: Copy,

type Output = Point3<S>

The returned type after indexing.

fn index(&self, index: usize) -> &Point3<S>

Performs the indexing (container[index]) operation.

impl<S> PartialEq for Segment<S>

where S: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<S> TryFrom<[Point3<S>; 2]> for Segment<S>

where S: OrderedRing,

type Error = [Point3<S>; 2]

The type returned in the event of a conversion error.

fn try_from( _: [Point3<S>; 2], ) -> Result<Segment<S>, <Segment<S> as TryFrom<[Point3<S>; 2]>>::Error>

Performs the conversion.

impl<S> Copy for Segment<S>

where S: Copy,

impl<S> Eq for Segment<S>

where S: Eq,

impl<S> StructuralPartialEq for Segment<S>