Struct ConvexPolytope 

pub struct ConvexPolytope<const N: usize> { /* private fields */ }

A faceted solid defined by the convex hull of its vertices.

Examples

Construction and basic methods:

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

let tetrahedron = ConvexPolyhedron::with_vertices(vec![
    [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 ConvexPolytope<2>

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

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

Example

use hoomd_geometry::shape::ConvexPolytope;

let equilateral_triangle = ConvexPolytope::regular(3);

impl<const N: usize> ConvexPolytope<N>

pub fn with_vertices<I>(vertices: I) -> Result<ConvexPolytope<N>, 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::with_vertices(vec![
    [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> BoundingSphereRadius for ConvexPolytope<N>

fn bounding_sphere_radius(&self) -> PositiveReal

Get the bounding radius.

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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> PartialEq for ConvexPolytope<N>

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

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> SupportMapping<Cartesian<N>> for ConvexPolytope<N>

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

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

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