Skip to main content

PyColliderShape

oxiphysics_python::types

Enum PyColliderShape

pub enum PyColliderShape {
    Sphere {
        radius: f64,
    },
    Box {
        half_extents: [f64; 3],
    },
    Plane {
        normal: [f64; 3],
        distance: f64,
    },
    Capsule {
        radius: f64,
        half_height: f64,
    },
    Cylinder {
        radius: f64,
        half_height: f64,
    },
    Cone {
        radius: f64,
        half_height: f64,
    },
}

Expand description

Shape variant for a rigid body collider.

Only primitive shapes are supported; they map to underlying collision shapes.

Variants§

Sphere

A sphere with the given radius.

Fields

§radius: f64

Radius in meters.

Box

An axis-aligned box with given half-extents.

Fields

§half_extents: [f64; 3]

Half-extents [hx, hy, hz] in meters.

Plane

An infinite plane defined by a normal and distance from origin.

Fields

§normal: [f64; 3]

Outward normal (should be unit length).

§distance: f64

Signed distance from origin along the normal.

Capsule

A capsule (cylinder + two hemispheres) along the Y axis.

Fields

§radius: f64

Radius of the cylinder and end hemispheres.

§half_height: f64

Half-height of the cylindrical portion (total height = 2 * half_height + 2 * radius).

Cylinder

A cylinder aligned with the Y axis.

Fields

§radius: f64

Radius of the cylinder.

§half_height: f64

Half-height of the cylinder.

Cone

A cone aligned with the Y axis, apex pointing up.

Fields

§radius: f64

Radius of the base.

§half_height: f64

Half-height of the cone.

Implementations§

impl PyColliderShape

pub fn sphere(radius: f64) -> Self

Create a sphere shape.

pub fn box_shape(hx: f64, hy: f64, hz: f64) -> Self

Create a box shape from half-extents.

pub fn plane(normal: [f64; 3], distance: f64) -> Self

Create a plane shape.

pub fn capsule(radius: f64, half_height: f64) -> Self

Create a capsule shape.

pub fn approximate_volume(&self) -> f64

Compute an approximate volume for mass/inertia estimation.

pub fn is_infinite(&self) -> bool

Whether this shape is a plane (infinite extents).

Trait Implementations§

impl Clone for PyColliderShape

fn clone(&self) -> PyColliderShape

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 PyColliderShape

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for PyColliderShape

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 PyColliderShape

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

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 PyColliderShape

Auto Trait Implementations§

impl Freeze for PyColliderShape

impl RefUnwindSafe for PyColliderShape

impl Send for PyColliderShape

impl Sync for PyColliderShape

impl Unpin for PyColliderShape

impl UnsafeUnpin for PyColliderShape

impl UnwindSafe for PyColliderShape

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,