Struct avian3d::collision::collider::ColliderBackendPlugin
source · pub struct ColliderBackendPlugin<C: ScalableCollider> { /* private fields */ }
Expand description
A plugin for handling generic collider backend logic.
- Initializes colliders, handles
ColliderConstructor
andColliderConstructorHierarchy
. - Updates
ColliderAabb
s. - Updates collider scale based on
Transform
scale. - Updates collider mass properties, also updating rigid bodies accordingly.
This plugin should typically be used together with the ColliderHierarchyPlugin
.
§Custom collision backends
By default, PhysicsPlugins
adds this plugin for the Collider
component.
You can also create custom collider backends by implementing the AnyCollider
and ScalableCollider
traits for a type.
To use a custom collider backend, simply add the ColliderBackendPlugin
with your collider type:
use avian3d::prelude::*;
use bevy::prelude::*;
fn main() {
App::new()
.add_plugins((
DefaultPlugins,
PhysicsPlugins::default(),
// MyCollider must implement AnyCollider and ScalableCollider.
ColliderBackendPlugin::<MyCollider>::default(),
// To enable collision detection for the collider,
// we also need to add the NarrowPhasePlugin for it.
NarrowPhasePlugin::<MyCollider>::default(),
))
// ...your other plugins, systems and resources
.run();
}
Assuming you have implemented the required traits correctly,
it should now work with the rest of the engine just like normal Collider
s!
Note: Spatial queries are not supported for custom colliders yet.
Implementations§
source§impl<C: ScalableCollider> ColliderBackendPlugin<C>
impl<C: ScalableCollider> ColliderBackendPlugin<C>
sourcepub fn new(schedule: impl ScheduleLabel) -> Self
pub fn new(schedule: impl ScheduleLabel) -> Self
Creates a ColliderBackendPlugin
with the schedule that is used for running the PhysicsSchedule
.
The default schedule is PostUpdate
.
Trait Implementations§
source§impl<C: ScalableCollider> Default for ColliderBackendPlugin<C>
impl<C: ScalableCollider> Default for ColliderBackendPlugin<C>
source§impl<C: ScalableCollider> Plugin for ColliderBackendPlugin<C>
impl<C: ScalableCollider> Plugin for ColliderBackendPlugin<C>
source§fn ready(&self, _app: &App) -> bool
fn ready(&self, _app: &App) -> bool
Has the plugin finished its setup? This can be useful for plugins that need something
asynchronous to happen before they can finish their setup, like the initialization of a renderer.
Once the plugin is ready,
finish
should be called.source§fn finish(&self, _app: &mut App)
fn finish(&self, _app: &mut App)
Finish adding this plugin to the
App
, once all plugins registered are ready. This can
be useful for plugins that depends on another plugin asynchronous setup, like the renderer.source§fn cleanup(&self, _app: &mut App)
fn cleanup(&self, _app: &mut App)
Runs after all plugins are built and finished, but before the app schedule is executed.
This can be useful if you have some resource that other plugins need during their build step,
but after build you want to remove it and send it to another thread.
Auto Trait Implementations§
impl<C> Freeze for ColliderBackendPlugin<C>
impl<C> !RefUnwindSafe for ColliderBackendPlugin<C>
impl<C> Send for ColliderBackendPlugin<C>
impl<C> Sync for ColliderBackendPlugin<C>
impl<C> Unpin for ColliderBackendPlugin<C>where
C: Unpin,
impl<C> !UnwindSafe for ColliderBackendPlugin<C>
Blanket Implementations§
source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
Return the
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates
Self
using data from the given World
.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moresource§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.