Struct bevy_rapier2d::plugin::RapierPhysicsPlugin
source · pub struct RapierPhysicsPlugin<PhysicsHooks = ()> { /* private fields */ }
Expand description
A plugin responsible for setting up a full Rapier physics simulation pipeline and resources.
This will automatically setup all the resources needed to run a physics simulation with the Rapier physics engine.
Implementations§
source§impl<PhysicsHooks> RapierPhysicsPlugin<PhysicsHooks>where
PhysicsHooks: 'static + BevyPhysicsHooks,
for<'w, 's> SystemParamItem<'w, 's, PhysicsHooks>: BevyPhysicsHooks,
impl<PhysicsHooks> RapierPhysicsPlugin<PhysicsHooks>where
PhysicsHooks: 'static + BevyPhysicsHooks,
for<'w, 's> SystemParamItem<'w, 's, PhysicsHooks>: BevyPhysicsHooks,
sourcepub fn with_physics_scale(self, physics_scale: f32) -> Self
pub fn with_physics_scale(self, physics_scale: f32) -> Self
Specifies a scale ratio between the physics world and the bevy transforms.
This affects the size of every elements in the physics engine, by multiplying
all the length-related quantities by the physics_scale
factor. This should
likely always be 1.0 in 3D. In 2D, this is useful to specify a “pixels-per-meter”
conversion ratio.
sourcepub fn with_default_system_setup(self, default_system_setup: bool) -> Self
pub fn with_default_system_setup(self, default_system_setup: bool) -> Self
Specifies whether the plugin should setup each of its [PhysicsStages
]
(true
), or if the user will set them up later (false
).
The default value is true
.
sourcepub fn pixels_per_meter(pixels_per_meter: f32) -> Self
pub fn pixels_per_meter(pixels_per_meter: f32) -> Self
Specifies how many pixels on the 2D canvas equal one meter on the physics world.
This conversion unit assumes that the 2D camera uses an unscaled projection.
sourcepub fn in_fixed_schedule(self) -> Self
pub fn in_fixed_schedule(self) -> Self
Adds the physics systems to the FixedUpdate
schedule rather than PostUpdate
.
sourcepub fn in_schedule(self, schedule: impl ScheduleLabel) -> Self
pub fn in_schedule(self, schedule: impl ScheduleLabel) -> Self
Adds the physics systems to the provided schedule rather than PostUpdate
.
sourcepub fn get_systems(set: PhysicsSet) -> SystemConfigs
pub fn get_systems(set: PhysicsSet) -> SystemConfigs
Provided for use when staging systems outside of this plugin using
with_system_setup(false)
.
See PhysicsSet
for a description of these systems.
Trait Implementations§
source§impl<PhysicsHooksSystemParam> Default for RapierPhysicsPlugin<PhysicsHooksSystemParam>
impl<PhysicsHooksSystemParam> Default for RapierPhysicsPlugin<PhysicsHooksSystemParam>
source§impl<PhysicsHooks> Plugin for RapierPhysicsPlugin<PhysicsHooks>where
PhysicsHooks: 'static + BevyPhysicsHooks,
for<'w, 's> SystemParamItem<'w, 's, PhysicsHooks>: BevyPhysicsHooks,
impl<PhysicsHooks> Plugin for RapierPhysicsPlugin<PhysicsHooks>where
PhysicsHooks: 'static + BevyPhysicsHooks,
for<'w, 's> SystemParamItem<'w, 's, PhysicsHooks>: BevyPhysicsHooks,
§fn ready(&self, _app: &App) -> bool
fn ready(&self, _app: &App) -> bool
finish
should be called.§fn finish(&self, _app: &mut App)
fn finish(&self, _app: &mut App)
App
], once all plugins registered are ready. This can
be useful for plugins that depends on another plugin asynchronous setup, like the renderer.§fn cleanup(&self, _app: &mut App)
fn cleanup(&self, _app: &mut App)
Auto Trait Implementations§
impl<PhysicsHooks = ()> !RefUnwindSafe for RapierPhysicsPlugin<PhysicsHooks>
impl<PhysicsHooks> Send for RapierPhysicsPlugin<PhysicsHooks>where
PhysicsHooks: Send,
impl<PhysicsHooks> Sync for RapierPhysicsPlugin<PhysicsHooks>where
PhysicsHooks: Sync,
impl<PhysicsHooks> Unpin for RapierPhysicsPlugin<PhysicsHooks>where
PhysicsHooks: Unpin,
impl<PhysicsHooks = ()> !UnwindSafe for RapierPhysicsPlugin<PhysicsHooks>
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
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
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given [World
].§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pointable for T
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.