Struct fj_math::Triangle

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

A triangle

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

Implementations

impl<const D: usize> Triangle<D>

pub fn from_points(
    points: [impl Into<Point<D>>; 3]
) -> Result<Self, NotATriangle<D>>

Construct a triangle from three points

Returns an error, if the points don’t form a triangle.

Examples found in repository

src/triangle.rs (line 117)

    fn from(points: [P; 3]) -> Self {
        Self::from_points(points).expect("invalid triangle")
    }

src/line.rs (line 102)

    pub fn is_coincident_with(&self, other: &Self) -> bool {
        let other_origin_is_not_on_self = {
            let a = other.origin;
            let b = self.origin;
            let c = self.origin + self.direction;

            // The triangle is valid only, if the three points are not on the
            // same line.
            Triangle::from_points([a, b, c]).is_ok()
        };

        if other_origin_is_not_on_self {
            return false;
        }

        let d1 = self.direction.normalize();
        let d2 = other.direction.normalize();

        d1 == d2 || d1 == -d2
    }

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

Access the triangle’s points

Examples found in repository

src/triangle.rs (line 81)

    pub fn to_parry(self) -> parry3d_f64::shape::Triangle {
        self.points().map(|vertex| vertex.to_na()).into()
    }

src/transform.rs (line 74)

    pub fn transform_triangle(&self, triangle: &Triangle<3>) -> Triangle<3> {
        let [a, b, c] = &triangle.points();
        Triangle::from([
            self.transform_point(a),
            self.transform_point(b),
            self.transform_point(c),
        ])
    }

pub fn normalize(self) -> Self

Normalize the triangle

Returns a new Triangle instance with the same points, but the points ordered such that they are ordered according to their Ord/PartialOrd implementation.

This is useful for comparing triangles, where the order of points is not important.

impl Triangle<2>

pub fn winding(&self) -> Winding

Returns the direction of the line through the points of the triangle.

impl Triangle<3>

pub fn to_parry(self) -> Triangle

Convert the triangle to a Parry triangle

Examples found in repository

src/triangle.rs (line 97)

    pub fn cast_local_ray(
        &self,
        origin: Point<3>,
        dir: Vector<3>,
        max_toi: f64,
        solid: bool,
    ) -> Option<Scalar> {
        let ray = Ray {
            origin: origin.to_na(),
            dir: dir.to_na(),
        };

        self.to_parry()
            .cast_local_ray(&ray, max_toi, solid)
            .map(Into::into)
    }

    /// Compute the triangle's normal
    pub fn normal(&self) -> Vector<3> {
        self.to_parry()
            .normal()
            .expect("triangle is valid (validated on construction)")
            .into_inner()
            .into()
    }

pub fn cast_local_ray(
    &self,
    origin: Point<3>,
    dir: Vector<3>,
    max_toi: f64,
    solid: bool
) -> Option<Scalar>

Cast a ray against the Triangle

pub fn normal(&self) -> Vector<3>

Compute the triangle’s normal

Trait Implementations

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

fn clone(&self) -> Triangle<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 Triangle<D>

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

Formats the value using the given formatter.

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

fn default() -> Triangle<D>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl<const D: usize> Hash for Triangle<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 Triangle<D>

fn cmp(&self, other: &Triangle<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<Triangle<D>> for Triangle<D>

fn eq(&self, other: &Triangle<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<Triangle<D>> for Triangle<D>

fn partial_cmp(&self, other: &Triangle<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 Triangle<D>

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

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

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