Struct avian3d::collision::narrow_phase::NarrowPhaseConfig

pub struct NarrowPhaseConfig {
    pub default_speculative_margin: Scalar,
    pub contact_tolerance: Scalar,
    pub match_contacts: bool,
}

A resource for configuring the narrow phase.

Fields

default_speculative_margin: Scalar

The default maximum speculative margin used for speculative collisions. This can be overridden for individual entities with the SpeculativeMargin component.

By default, the maximum speculative margin is unbounded, so contacts can be predicted from any distance, provided that the bodies are moving fast enough. As the prediction distance grows, the contact data becomes more and more approximate, and in rare cases, it can even cause issues such as ghost collisions.

By limiting the maximum speculative margin, these issues can be mitigated, at the cost of an increased risk of tunneling. Setting it to 0.0 disables speculative collision altogether for entities without SpeculativeMargin.

This is implicitly scaled by the PhysicsLengthUnit.

Default: MAX (unbounded)

contact_tolerance: Scalar

A contact tolerance that acts as a minimum bound for the speculative margin.

A small, positive contact tolerance helps ensure that contacts are not missed due to numerical issues or solver jitter for objects that are in continuous contact, such as pushing against each other.

Making the contact tolerance too large will have a negative impact on performance, as contacts will be computed even for objects that are not in close proximity.

This is implicitly scaled by the PhysicsLengthUnit.

Default: 0.005

match_contacts: bool

If true, the current contacts will be matched with the previous contacts based on feature IDs or contact positions, and the contact impulses from the previous frame will be copied over for the new contacts.

Using these impulses as the initial guess is referred to as warm starting, and it can help the contact solver resolve overlap and stabilize much faster.

Default: true

Trait Implementations

impl Clone for NarrowPhaseConfig

fn clone(&self) -> NarrowPhaseConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NarrowPhaseConfig

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

Formats the value using the given formatter.

impl Default for NarrowPhaseConfig

fn default() -> Self

Returns the “default value” for a type.

impl FromReflect for NarrowPhaseConfig

where Self: Any + Send + Sync, Scalar: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for NarrowPhaseConfig

where Self: Any + Send + Sync, Scalar: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialEq for NarrowPhaseConfig

fn eq(&self, other: &NarrowPhaseConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for NarrowPhaseConfig

where Self: Any + Send + Sync, Scalar: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for NarrowPhaseConfig

where Self: Any + Send + Sync, Scalar: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for NarrowPhaseConfig

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for NarrowPhaseConfig

where Self: Any + Send + Sync, Scalar: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Resource for NarrowPhaseConfig

where Self: Send + Sync + 'static,

impl StructuralPartialEq for NarrowPhaseConfig