Skip to main content

PyShape

oxiphysics_python::geometry_api

Enum PyShape

pub enum PyShape {
    Sphere(f64),
    Box([f64; 3]),
    Capsule {
        radius: f64,
        half_height: f64,
    },
    Cylinder {
        radius: f64,
        half_height: f64,
    },
    Cone {
        radius: f64,
        half_height: f64,
    },
    Torus {
        major_r: f64,
        minor_r: f64,
    },
}

Expand description

Primitive geometry shape used for collision detection and rendering.

Variants§

Sphere(f64)

A sphere defined by its radius.

Box([f64; 3])

An axis-aligned box defined by half-extents.

Capsule

A capsule defined by radius and half-height of the cylindrical part.

Fields

§radius: f64

§half_height: f64

Cylinder

A cylinder defined by radius and half-height.

Fields

§radius: f64

§half_height: f64

Cone

A cone defined by base radius and half-height.

Fields

§radius: f64

§half_height: f64

Torus

A torus defined by major and minor radii.

Fields

§major_r: f64

§minor_r: f64

Implementations§

impl PyShape

pub fn volume(&self) -> f64

Approximate volume of the shape.

pub fn surface_area(&self) -> f64

Approximate surface area of the shape.

pub fn aabb(&self) -> ([f64; 3], [f64; 3])

Compute an axis-aligned bounding box for this shape at the origin.

Trait Implementations§

impl Clone for PyShape

fn clone(&self) -> PyShape

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

impl Debug for PyShape

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for PyShape

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

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for PyShape

fn eq(&self, other: &PyShape) -> 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.

impl Serialize for PyShape

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

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for PyShape

Auto Trait Implementations§

impl Freeze for PyShape

impl RefUnwindSafe for PyShape

impl Send for PyShape

impl Sync for PyShape

impl Unpin for PyShape

impl UnsafeUnpin for PyShape

impl UnwindSafe for PyShape

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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