Struct ColliderConstructorHierarchy

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

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 [SceneRoot], 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((
        SceneRoot(scene.clone()),
        ColliderConstructorHierarchy::new(ColliderConstructor::TrimeshFromMesh),
    ));

    // Specify configuration for specific meshes by name
    commands.spawn((
        SceneRoot(scene.clone()),
        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((
        SceneRoot(scene.clone()),
        ColliderConstructorHierarchy::new(None)
            .with_constructor_for_name("Tree", ColliderConstructor::ConvexHullFromMesh),
    ));

    // Generate colliders for everything except specific meshes by name
    commands.spawn((
        SceneRoot(scene),
        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::default() by default, with the first layer and all filters.

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.

Implementations

impl ColliderConstructorHierarchy

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

Creates a new ColliderConstructorHierarchy with the default ColliderConstructor used for generating colliders set to the given default_constructor.

If the given constructor type is None, collider generation is skipped for all entities in the hierarchy except the ones in config.

Collider constructors can be specified for individual entities using with_constructor_for_name.

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

Specifies the default CollisionLayers used for colliders not included in ColliderConstructorHierarchy::config.

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

Specifies the default ColliderDensity used for colliders not included in ColliderConstructorHierarchy::config.

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

Specifies the ColliderConstructor used for an entity with the given name.

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

Specifies the CollisionLayers used for an entity with the given name.

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

Specifies the ColliderDensity used for an entity with the given name.

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

Sets the ColliderConstructor for the entity associated with the given name to None, skipping collider generation for it.

Trait Implementations

impl Clone for ColliderConstructorHierarchy

fn clone(&self) -> ColliderConstructorHierarchy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for ColliderConstructorHierarchy

where Self: Send + Sync + 'static,

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

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for ColliderConstructorHierarchy

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

Formats the value using the given formatter.

impl Default for ColliderConstructorHierarchy

fn default() -> ColliderConstructorHierarchy

Returns the “default value” for a type.

impl FromReflect for ColliderConstructorHierarchy

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

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for ColliderConstructorHierarchy

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 ColliderConstructorHierarchy

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

Tests for self and other values to be equal, and is used by ==.

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 PartialReflect for ColliderConstructorHierarchy

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

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> 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 try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

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

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

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

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

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for ColliderConstructorHierarchy

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, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

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

Casts this type to a mutable, fully-reflected value.

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

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

impl Struct for ColliderConstructorHierarchy

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

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

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

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

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

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

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

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

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 to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for ColliderConstructorHierarchy

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 ColliderConstructorHierarchy

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl StructuralPartialEq for ColliderConstructorHierarchy