Struct avian3d::sync::SyncPlugin

pub struct SyncPlugin { /* private fields */ }

Responsible for synchronizing physics components with other data, like keeping Position and Rotation in sync with Transform.

Syncing between Position/Rotation and Transform

By default, each body’s Transform will be updated when Position or Rotation change, and vice versa. This means that you can use any of these components to move or position bodies, and the changes be reflected in the other components.

You can configure what data is synchronized and how it is synchronized using the SyncConfig resource.

Transform hierarchies

When synchronizing changes in Position or Rotation to Transform, the engine treats nested rigid bodies as a flat structure. This means that the bodies move independently of the parents, and moving the parent will not affect the child.

If you would like a child entity to be rigidly attached to its parent, you could use a FixedJoint or write your own system to handle hierarchies differently.

Implementations

impl SyncPlugin

pub fn new(schedule: impl ScheduleLabel) -> Self

Creates a SyncPlugin with the schedule that is used for running the PhysicsSchedule.

The default schedule is PostUpdate.

Trait Implementations

impl Default for SyncPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for SyncPlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

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.

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.

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.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.