Struct avian3d::sync::ancestor_marker::AncestorMarkerPlugin

pub struct AncestorMarkerPlugin<C: Component> { /* private fields */ }

A plugin that marks the ancestors of entities that have the given component C with the AncestorMarker component.

One use case is speeding up transform propagation: we only need to propagate down trees that have a certain type of entity, like a collider or a rigid body.

Implementations

impl<C: Component> AncestorMarkerPlugin<C>

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

Creates a new AncestorMarkerPlugin with the schedule that the system adding markers should run in.

pub fn add_markers_in_set(self, set: impl SystemSet) -> Self

Configures which system set the system adding the AncestorMarkers should run in.

Note: Unlike the normal in_set for system configurations, this overwrites the set, so the system can only be added to a single system set at a time.

Trait Implementations

impl<C: Component> Plugin for AncestorMarkerPlugin<C>

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.