Polygon

Struct Polygon 

Source
pub struct Polygon { /* private fields */ }
Expand description

A convex polygon in 3D space, defined by an ordered list of vertices.

Vertices should be coplanar and in counter-clockwise winding order when viewed from the front (the direction the normal points).

Implementations§

Source§

impl Polygon

Source

pub fn new(vertices: Vec<Point3<f32>>) -> Self

Creates a new polygon from a list of vertices.

§Panics (debug builds only)
  • Panics if fewer than 3 vertices are provided.
  • Panics if vertices are not coplanar.
Source

pub fn vertices(&self) -> &[Point3<f32>]

Returns the vertices of the polygon.

Source

pub fn len(&self) -> usize

Returns the number of vertices.

Source

pub fn is_empty(&self) -> bool

Returns true if the polygon has no vertices (always false for valid polygons).

Source

pub fn normal(&self) -> Vector3<f32>

Computes the (unnormalized) normal vector of the polygon.

Uses the first three vertices to compute the normal via cross product. The direction follows the right-hand rule based on vertex winding.

Source

pub fn unit_normal(&self) -> Option<Vector3<f32>>

Computes the unit normal vector of the polygon.

Returns None if the first three vertices are collinear.

Source

pub fn plane(&self) -> Plane3D

Returns the plane that this polygon lies on.

§Panics

Panics if the first three vertices are collinear.

Source

pub fn centroid(&self) -> Point3<f32>

Computes the centroid (center of mass) of the polygon.

Source

pub fn classify(&self, plane: &Plane3D) -> Classification

Classifies this polygon relative to a plane.

Returns:

  • Front if all vertices are in front of the plane
  • Back if all vertices are behind the plane
  • Coplanar if all vertices lie on the plane
  • Spanning if vertices are on both sides

Trait Implementations§

Source§

impl Clone for Polygon

Source§

fn clone(&self) -> Polygon

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Cuttable for Polygon

Source§

fn cut(&self, plane: &Plane3D) -> (Option<Polygon>, Option<Polygon>)

Cuts the geometry by a plane. Read more
Source§

impl Debug for Polygon

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&Polygon> for Plane3D

Source§

fn from(polygon: &Polygon) -> Self

Converts to this type from the input type.
Source§

impl From<&Rectangle> for Polygon

Source§

fn from(rectangle: &Rectangle) -> Self

Converts to this type from the input type.
Source§

impl From<&Triangle> for Polygon

Source§

fn from(triangle: &Triangle) -> Self

Converts to this type from the input type.
Source§

impl From<Polygon> for Plane3D

Source§

fn from(polygon: Polygon) -> Self

Converts to this type from the input type.
Source§

impl From<Rectangle> for Polygon

Source§

fn from(rectangle: Rectangle) -> Self

Converts to this type from the input type.
Source§

impl From<Triangle> for Polygon

Source§

fn from(triangle: Triangle) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Polygon

Source§

fn eq(&self, other: &Polygon) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for Polygon

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,