Struct ConvexPolytope 

pub struct ConvexPolytope<const N: usize, const MAX_VERTICES: usize = 64> { /* private fields */ }

A faceted solid defined by the convex hull of a set of points.

ConvexPolytope stores the given point set without any modification. Therefore, it can be constructed quickly. The implicit convex hull is formed by SupportMapping during intersection tests of Convex(ConvexPolytope) with other Convex(_) types.

Every vertex in the convex hull is an elements of vertices. vertices may also include duplicate, collinear, coplanar, and/or interior points. They are exactly the points given at construction.

Examples

Construction and basic methods:

use approxim::assert_relative_eq;
use hoomd_geometry::{BoundingSphereRadius, shape::ConvexPolyhedron};

let tetrahedron = ConvexPolyhedron::with_vertices([
    [1.0, 1.0, 1.0].into(),
    [1.0, -1.0, -1.0].into(),
    [-1.0, 1.0, -1.0].into(),
    [-1.0, -1.0, 1.0].into(),
])?;

let bounding_radius = tetrahedron.bounding_sphere_radius();

assert_relative_eq!(bounding_radius.get(), 3.0_f64.sqrt());

Intersection tests:

use hoomd_geometry::{Convex, IntersectsAt, shape::ConvexPolygon};
use hoomd_vector::{Angle, Cartesian};
use std::f64::consts::PI;

let rectangle = ConvexPolygon::with_vertices([
    [-2.0, -1.0].into(),
    [2.0, -1.0].into(),
    [2.0, 1.0].into(),
    [-2.0, 1.0].into(),
])?;
let rectangle = Convex(rectangle);

assert!(!rectangle.intersects_at(
    &rectangle,
    &[0.0, 2.1].into(),
    &Angle::default()
));
assert!(rectangle.intersects_at(
    &rectangle,
    &[0.0, 2.1].into(),
    &Angle::from(PI / 2.0)
));

Implementations

impl<const MAX_VERTICES: usize> ConvexPolytope<2, MAX_VERTICES>

pub fn regular(n: usize) -> ConvexPolytope<2, MAX_VERTICES>

Create a regular n-gon with n vertices and circumradius 0.5.

Example

use hoomd_geometry::shape::ConvexPolygon;

let equilateral_triangle = ConvexPolygon::regular(3);

impl<const N: usize, const MAX_VERTICES: usize> ConvexPolytope<N, MAX_VERTICES>

pub fn with_vertices<I>( vertices: I, ) -> Result<ConvexPolytope<N, MAX_VERTICES>, Error>

where I: IntoIterator<Item = Cartesian<N>>,

Create an N-polytope with the given vertices.

Example

use hoomd_geometry::shape::ConvexPolytope;

let equilateral_triangle = ConvexPolytope::<2>::with_vertices([
    [1.0, 0.0].into(),
    [0.5, f64::sqrt(3.0) / 2.0].into(),
    [-0.5, f64::sqrt(3.0) / 2.0].into(),
])?;

Errors

Error::DegeneratePolytope when no vertices are provided.

pub fn vertices(&self) -> &[Cartesian<N>]

The vertices of the shape.

Trait Implementations

impl<const N: usize, const MAX_VERTICES: usize> BoundingSphereRadius for ConvexPolytope<N, MAX_VERTICES>

fn bounding_sphere_radius(&self) -> PositiveReal

Get the bounding radius.

impl<const N: usize, const MAX_VERTICES: usize> Clone for ConvexPolytope<N, MAX_VERTICES>

fn clone(&self) -> ConvexPolytope<N, MAX_VERTICES>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize, const MAX_VERTICES: usize> Debug for ConvexPolytope<N, MAX_VERTICES>

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

Formats the value using the given formatter.

impl<'de, const N: usize, const MAX_VERTICES: usize> Deserialize<'de> for ConvexPolytope<N, MAX_VERTICES>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize, const MAX_VERTICES: usize> PartialEq for ConvexPolytope<N, MAX_VERTICES>

fn eq(&self, other: &ConvexPolytope<N, MAX_VERTICES>) -> 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<const N: usize, const MAX_VERTICES: usize> Serialize for ConvexPolytope<N, MAX_VERTICES>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const N: usize, const MAX_VERTICES: usize> SupportMapping<Cartesian<N>> for ConvexPolytope<N, MAX_VERTICES>

fn support_mapping(&self, n: &Cartesian<N>) -> Cartesian<N>

Return the furthest extent of a shape in the direction of n.

impl<const MAX_VERTICES: usize> TryFrom<ConvexPolytope<2, MAX_VERTICES>> for ConvexSurfaceMesh2d

fn try_from( v: ConvexPolytope<2, MAX_VERTICES>, ) -> Result<ConvexSurfaceMesh2d, Error>

Construct the convex hull of a ConvexPolytope<2>.

Errors

• Error::DegeneratePolytope when there are fewer than 3 non-collinear points.

Example

Invalid conversion

use hoomd_geometry::shape::{ConvexPolygon, ConvexSurfaceMesh2d};

let equilateral_triangle = ConvexPolygon::regular(3);
let mesh = ConvexSurfaceMesh2d::try_from(equilateral_triangle)?;

type Error = Error

The type returned in the event of a conversion error.

impl<const N: usize, const MAX_VERTICES: usize> StructuralPartialEq for ConvexPolytope<N, MAX_VERTICES>