Struct ExtractComponentPlugin 

pub struct ExtractComponentPlugin<C, F = ()> {
    only_extract_visible: bool,
    marker: PhantomData<fn() -> (C, F)>,
}

This plugin extracts the components into the render world for synced entities. To do so, it sets up the ExtractSchedule step for the specified ExtractComponent.

It also registers SyncComponentPlugin to ensure the extracted components are deleted if the main world components are removed.

The marker type F is only used as a way to bypass the orphan rules. To implement the trait for a foreign type you can use a local type as the marker, e.g. the type of the plugin that calls ExtractComponentPlugin.

Fields

only_extract_visible: bool

marker: PhantomData<fn() -> (C, F)>

Implementations

impl<C, F> ExtractComponentPlugin<C, F>

pub fn extract_visible() -> ExtractComponentPlugin<C, F>

Trait Implementations

impl<C, F> Default for ExtractComponentPlugin<C, F>

fn default() -> ExtractComponentPlugin<C, F>

Returns the “default value” for a type.

impl<C, F> Plugin for ExtractComponentPlugin<C, F>

where C: ExtractComponent<F>, F: 'static + Send + Sync,

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.