Skip to main content

Sphero

Struct Sphero 

Source
pub struct Sphero<S> {
    pub shape: S,
    pub rounding_radius: PositiveReal,
}
Expand description

Round a shape with a given radius.

Sphero modifies a given shape by sweeping it with a hypersphere of the given radius. The resulting Sphero<S> type is a shape itself. If S implements crate::SupportMapping, then Sphero<S> can be used in IntersectsAt tests with other convex shapes. See the full list of implementations below to see what other traits Sphero<S> implements for a given S.

§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)
));

Fields§

§shape: S

The shape to round.

§rounding_radius: PositiveReal

The radius of the rounding hypersphere.

Trait Implementations§

Source§

impl<S> BoundingSphereRadius for Sphero<S>

Source§

fn bounding_sphere_radius(&self) -> PositiveReal

Get the bounding radius.
Source§

impl<S: Clone> Clone for Sphero<S>

Source§

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

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<S: Debug> Debug for Sphero<S>

Source§

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

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

impl<'de, S> Deserialize<'de> for Sphero<S>
where S: Deserialize<'de>,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<S: PartialEq> PartialEq for Sphero<S>

Source§

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

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<S, V> SupportMapping<V> for Sphero<S>
where S: SupportMapping<V>, V: InnerProduct,

Source§

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

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

impl<S> StructuralPartialEq for Sphero<S>

Auto Trait Implementations§

§

impl<S> Freeze for Sphero<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for Sphero<S>
where S: RefUnwindSafe,

§

impl<S> Send for Sphero<S>
where S: Send,

§

impl<S> Sync for Sphero<S>
where S: Sync,

§

impl<S> Unpin for Sphero<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for Sphero<S>
where S: UnsafeUnpin,

§

impl<S> UnwindSafe for Sphero<S>
where S: UnwindSafe,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,