Enum SegmentPointLocation

pub enum SegmentPointLocation {
    OnVertex(u32),
    OnEdge([f32; 2]),
}

Describes where a point is located on a segment.

This enum is used by point projection queries to indicate whether the projected point is at one of the endpoints or somewhere along the segment.

Variants

• OnVertex(id): Point projects to an endpoint (0 = a, 1 = b)
• OnEdge(bary): Point projects to the interior with barycentric coordinates

Example

use parry3d::shape::SegmentPointLocation;

// Point at first vertex
let loc = SegmentPointLocation::OnVertex(0);
assert_eq!(loc.barycentric_coordinates(), [1.0, 0.0]);

// Point at second vertex
let loc = SegmentPointLocation::OnVertex(1);
assert_eq!(loc.barycentric_coordinates(), [0.0, 1.0]);

// Point halfway along the segment
let loc = SegmentPointLocation::OnEdge([0.5, 0.5]);
assert_eq!(loc.barycentric_coordinates(), [0.5, 0.5]);

Variants

OnVertex(u32)

The point lies on a vertex (endpoint).

• 0 = Point is at segment.a
• 1 = Point is at segment.b

OnEdge([f32; 2])

The point lies on the segment interior.

Contains barycentric coordinates [u, v] where:

• u + v = 1.0
• Point = a * u + b * v
• 0.0 < u, v < 1.0 (strictly between endpoints)

Implementations

impl SegmentPointLocation

pub fn barycentric_coordinates(&self) -> [f32; 2]

Returns the barycentric coordinates corresponding to this location.

Barycentric coordinates [u, v] satisfy:

• u + v = 1.0
• Point = a * u + b * v

Example

use parry3d::shape::{Segment, SegmentPointLocation};
use nalgebra::Point3;

let segment = Segment::new(
    Point3::origin(),
    Point3::new(10.0, 0.0, 0.0)
);

// Point at endpoint a
let loc_a = SegmentPointLocation::OnVertex(0);
assert_eq!(loc_a.barycentric_coordinates(), [1.0, 0.0]);

// Point at endpoint b
let loc_b = SegmentPointLocation::OnVertex(1);
assert_eq!(loc_b.barycentric_coordinates(), [0.0, 1.0]);

// Point at 30% from a to b
let loc_mid = SegmentPointLocation::OnEdge([0.7, 0.3]);
let coords = loc_mid.barycentric_coordinates();
assert_eq!(coords[0], 0.7);
assert_eq!(coords[1], 0.3);

Trait Implementations

impl Clone for SegmentPointLocation

fn clone(&self) -> SegmentPointLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SegmentPointLocation

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

Formats the value using the given formatter.

impl PartialEq for SegmentPointLocation

fn eq(&self, other: &SegmentPointLocation) -> 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 Copy for SegmentPointLocation

impl StructuralPartialEq for SegmentPointLocation