Skip to main content

MaterialTable

Struct MaterialTable 

Source
pub struct MaterialTable {
    pub default_friction_combine: CombineRule,
    pub default_restitution_combine: CombineRule,
    /* private fields */
}
Expand description

Material pair lookup table

Fields§

§default_friction_combine: CombineRule

Global friction combine rule (fallback)

§default_restitution_combine: CombineRule

Global restitution combine rule (fallback)

Implementations§

Source§

impl MaterialTable

Source

pub fn new() -> Self

Create a new material table with a default material

Source

pub fn register(&mut self, material: PhysicsMaterial) -> MaterialId

Register a material, returns its ID

The material’s id field is overwritten with the assigned ID.

§Panics

Panics when the table already holds u16::MAX as usize + 1 (65,536) materials, i.e. every MaterialId is in use (the default material created by MaterialTable::new occupies ID 0, so at most 65,535 materials can be added after construction). Use MaterialTable::try_register to handle that case without panicking.

Source

pub fn try_register( &mut self, material: PhysicsMaterial, ) -> Result<MaterialId, PhysicsError>

Register a material, returns its ID, or an error when every MaterialId is already in use.

IDs are assigned in registration order, so a table can hold at most u16::MAX as usize + 1 (65,536) materials, including the default material at ID 0. A successful call never reuses or overwrites an existing ID.

§Errors

Returns PhysicsError::CapacityExceeded with limit = 65_536 when the table already holds 65,536 materials. The table is left unchanged.

Source

pub fn get(&self, id: MaterialId) -> &PhysicsMaterial

Get material by ID

Source

pub fn set_pair_override( &mut self, mat_a: MaterialId, mat_b: MaterialId, friction: Fix128, restitution: Fix128, )

Set a pair-specific override

Source

pub fn combine(&self, mat_a: MaterialId, mat_b: MaterialId) -> CombinedMaterial

Combine materials for a contact pair

Source

pub fn len(&self) -> usize

Number of registered materials

Source

pub fn is_empty(&self) -> bool

Check if empty

Source

pub fn register_metal(&mut self) -> MaterialId

Register a “Metal” material

Source

pub fn register_wood(&mut self) -> MaterialId

Register a “Wood” material

Source

pub fn register_rubber(&mut self) -> MaterialId

Register a “Rubber” material

Source

pub fn register_ice(&mut self) -> MaterialId

Register an “Ice” material

Source

pub fn register_concrete(&mut self) -> MaterialId

Register a “Concrete” material

Trait Implementations§

Source§

impl Default for MaterialTable

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.