Struct Convex 

pub struct Convex<S>(pub S);

A newtype that checks for intersections using xenocollide.

Use Convex to check for intersections between two convex shapes (possibly with different types).

Example

Test if a circle overlaps with a rounded rectangle:

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

let circle = Convex(Circle {
    radius: 0.5.try_into()?,
});
let rectangle = Rectangle {
    edge_lengths: [3.0.try_into()?, 2.0.try_into()?],
};
let rounded_rectangle = Convex(Sphero {
    shape: rectangle,
    rounding_radius: 0.5.try_into()?,
});

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

Tuple Fields

0: S

Trait Implementations

impl<S> BoundingSphereRadius for Convex<S>

where S: BoundingSphereRadius,

fn bounding_sphere_radius(&self) -> PositiveReal

Get the bounding radius.

impl<S: Clone> Clone for Convex<S>

fn clone(&self) -> Convex<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Convex<S>

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

Formats the value using the given formatter.

impl<'de, S> Deserialize<'de> for Convex<S>

where S: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<A, B, R> IntersectsAt<Convex<A>, Cartesian<2>, R> for Convex<B>

where A: SupportMapping<Cartesian<2>> + BoundingSphereRadius, B: SupportMapping<Cartesian<2>> + BoundingSphereRadius, R: Rotate<Cartesian<2>> + Rotation, RotationMatrix<2>: From<R>,

fn intersects_at( &self, other: &Convex<A>, v_ij: &Cartesian<2>, o_ij: &R, ) -> bool

Test whether the set of points in one shape intersects with the set of another (in the local frame).

fn approximate_separation_distance( &self, other: &S, v_ij: &V, o_ij: &R, resolution: PositiveReal, ) -> f64

where V: InnerProduct,

Approximate the amount of overlap between two shapes.

impl<A, B, R> IntersectsAt<Convex<A>, Cartesian<3>, R> for Convex<B>

where A: SupportMapping<Cartesian<3>> + BoundingSphereRadius, B: SupportMapping<Cartesian<3>> + BoundingSphereRadius, R: Rotate<Cartesian<3>> + Rotation, RotationMatrix<3>: From<R>,

fn intersects_at( &self, other: &Convex<A>, v_ij: &Cartesian<3>, o_ij: &R, ) -> bool

Test whether the set of points in one shape intersects with the set of another (in the local frame).

fn approximate_separation_distance( &self, other: &S, v_ij: &V, o_ij: &R, resolution: PositiveReal, ) -> f64

where V: InnerProduct,

Approximate the amount of overlap between two shapes.

impl<A, B, R> IntersectsAtGlobal<Convex<A>, Cartesian<2>, R> for Convex<B>

where A: SupportMapping<Cartesian<2>> + BoundingSphereRadius, B: SupportMapping<Cartesian<2>> + BoundingSphereRadius, R: Rotate<Cartesian<2>> + Rotation, RotationMatrix<2>: From<R>,

fn intersects_at_global( &self, other: &Convex<A>, r_self: &Cartesian<2>, o_self: &R, r_other: &Cartesian<2>, o_other: &R, ) -> bool

Test whether the set of points in one shape intersects with the set of another (in the global frame).

impl<A, B, R> IntersectsAtGlobal<Convex<A>, Cartesian<3>, R> for Convex<B>

where A: SupportMapping<Cartesian<3>> + BoundingSphereRadius, B: SupportMapping<Cartesian<3>> + BoundingSphereRadius, R: Rotate<Cartesian<3>> + Rotation, RotationMatrix<3>: From<R>,

fn intersects_at_global( &self, other: &Convex<A>, r_self: &Cartesian<3>, o_self: &R, r_other: &Cartesian<3>, o_other: &R, ) -> bool

Test whether the set of points in one shape intersects with the set of another (in the global frame).

impl<S: PartialEq> PartialEq for Convex<S>

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

where S: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<V, S> SupportMapping<V> for Convex<S>

where S: SupportMapping<V>,

fn support_mapping(&self, n: &V) -> V

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

impl<S> StructuralPartialEq for Convex<S>