Struct avian3d::collision::collider::ColliderConstructorHierarchy

source ·

pub struct ColliderConstructorHierarchy {
    pub default_constructor: Option<ColliderConstructor>,
    pub default_layers: CollisionLayers,
    pub default_density: ColliderDensity,
    pub config: HashMap<String, Option<ColliderConstructorHierarchyConfig>>,
}

Expand description

A component that will automatically generate Colliders on its descendants at runtime. The type of the generated collider can be specified using ColliderConstructor. This supports computing the shape dynamically from the mesh, in which case only the descendants with a Mesh will have colliders generated.

In contrast to ColliderConstructor, this component will not generate a collider on its own entity.

If this component is used on a scene, such as one spawned by a [SceneBundle], it will wait until the scene is loaded before generating colliders.

The exact configuration for each descendant can be specified using the helper methods such as with_constructor_for_name.

This component will only override a pre-existing Collider component on a descendant entity when it has been explicitly mentioned in the config.

§See also

For inserting colliders on the same entity, use ColliderConstructor.

§Caveats

When a component has multiple ancestors with ColliderConstructorHierarchy, the insertion order is undefined.

§Example

use avian3d::prelude::*;
use bevy::prelude::*;

fn setup(mut commands: Commands, mut assets: ResMut<AssetServer>) {
    let scene = assets.load("my_model.gltf#Scene0");

    // Spawn the scene and automatically generate triangle mesh colliders
    commands.spawn((
        SceneBundle { scene: scene.clone(), ..default() },
        ColliderConstructorHierarchy::new(ColliderConstructor::TrimeshFromMesh),
    ));

    // Specify configuration for specific meshes by name
    commands.spawn((
        SceneBundle { scene: scene.clone(), ..default() },
        ColliderConstructorHierarchy::new(ColliderConstructor::TrimeshFromMesh)
            .with_constructor_for_name("Tree", ColliderConstructor::ConvexHullFromMesh)
            .with_layers_for_name("Tree", CollisionLayers::from_bits(0b0010, 0b1111))
            .with_density_for_name("Tree", 2.5),
    ));

    // Only generate colliders for specific meshes by name
    commands.spawn((
        SceneBundle { scene: scene.clone(), ..default() },
        ColliderConstructorHierarchy::new(None)
            .with_constructor_for_name("Tree", ColliderConstructor::ConvexHullFromMesh),
    ));

    // Generate colliders for everything except specific meshes by name
    commands.spawn((
        SceneBundle { scene, ..default() },
        ColliderConstructorHierarchy::new(ColliderConstructor::TrimeshFromMeshWithConfig(
             TrimeshFlags::MERGE_DUPLICATE_VERTICES
        ))
        .without_constructor_for_name("Tree"),
    ));
}

Fields§

§default_constructor: Option<ColliderConstructor>

The default collider type used for each entity that isn’t included in config. If None, all entities except the ones in config will be skipped.

§default_layers: CollisionLayers

The default CollisionLayers used for colliders in the hierarchy.

CollisionLayers::ALL by default.

§default_density: ColliderDensity

The default ColliderDensity used for colliders in the hierarchy.

1.0 by default.

§config: HashMap<String, Option<ColliderConstructorHierarchyConfig>>

Specifies data like the ColliderConstructor and CollisionLayers for entities in the hierarchy by Name. Entries with a None value will be skipped.

For the entities not found in this HashMap, default_constructor, default_layers, and default_density will be used instead.

Struct avian3d::collision::collider::ColliderConstructorHierarchyCopy item path

§See also

§Caveats

§Example

Fields§

Implementations§

impl ColliderConstructorHierarchy

pub fn new(default_constructor: impl Into<Option<ColliderConstructor>>) -> Self

pub fn with_default_layers(self, layers: CollisionLayers) -> Self

pub fn with_default_density(self, density: impl Into<ColliderDensity>) -> Self

pub fn with_constructor_for_name( self, name: &str, constructor: ColliderConstructor ) -> Self

pub fn with_layers_for_name(self, name: &str, layers: CollisionLayers) -> Self

pub fn with_density_for_name( self, name: &str, density: impl Into<ColliderDensity> ) -> Self

pub fn without_constructor_for_name(self, name: &str) -> Self

Trait Implementations§

impl Clone for ColliderConstructorHierarchy

fn clone(&self) -> ColliderConstructorHierarchy

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

impl Component for ColliderConstructorHierarchywhere Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

fn register_component_hooks(_hooks: &mut ComponentHooks)

impl Debug for ColliderConstructorHierarchy

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

impl Default for ColliderConstructorHierarchy

fn default() -> ColliderConstructorHierarchy

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

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

fn get_type_registration() -> TypeRegistration

fn register_type_dependencies(registry: &mut TypeRegistry)

impl PartialEq for ColliderConstructorHierarchy

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

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

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

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

fn as_any(&self) -> &dyn Any

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

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

fn as_reflect(&self) -> &dyn Reflect

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

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

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

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

fn reflect_kind(&self) -> ReflectKind

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

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

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

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

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

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

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

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

fn is_dynamic(&self) -> bool

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

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

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

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

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

fn field_len(&self) -> usize

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

fn clone_dynamic(&self) -> DynamicStruct

impl TypePath for ColliderConstructorHierarchywhere Self: Any + Send + Sync,

fn type_path() -> &'static str

fn short_type_path() -> &'static str

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

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

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

fn type_info() -> &'static TypeInfo

impl StructuralPartialEq for ColliderConstructorHierarchy

Auto Trait Implementations§

impl Freeze for ColliderConstructorHierarchy

impl RefUnwindSafe for ColliderConstructorHierarchy

impl Send for ColliderConstructorHierarchy

impl Sync for ColliderConstructorHierarchy

impl Unpin for ColliderConstructorHierarchy

impl UnwindSafe for ColliderConstructorHierarchy

Blanket Implementations§

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

fn type_id(&self) -> TypeId

impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Struct avian3d::collision::collider::ColliderConstructorHierarchy

impl Component for ColliderConstructorHierarchy
where Self: Send + Sync + 'static,

impl TypePath for ColliderConstructorHierarchy
where Self: Any + Send + Sync,

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

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

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

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

impl<C> Bundle for C
where C: Component,

unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
where F: for<'a> FnMut(&'a mut T) -> OwningPtr<'a>,

impl<T> Downcast for T
where T: Any,

impl<T> DowncastSync for T
where T: Any + Send + Sync,

impl<C> DynamicBundle for C
where C: Component,

impl<T> DynamicTypePath for T
where T: TypePath,

impl<T> FromWorld for T
where T: Default,

impl<S> GetField for S
where S: Struct,

fn get_field<T>(&self, name: &str) -> Option<&T>
where T: Reflect,

fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T>
where T: Reflect,

impl<T> GetPath for T
where T: Reflect + ?Sized,

fn path<'p, T>( &self, path: impl ReflectPath<'p> ) -> Result<&T, ReflectPathError<'p>>
where T: Reflect,

fn path_mut<'p, T>( &mut self, path: impl ReflectPath<'p> ) -> Result<&mut T, ReflectPathError<'p>>
where T: Reflect,

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

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

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