Struct bevy_picking_highlight::DefaultHighlightingPlugin

pub struct DefaultHighlightingPlugin;

Adds the StandardMaterial and ColorMaterial highlighting plugins.

To use another asset type T for highlighting, add HighlightPlugin<T>.

Settings

You can adjust the global highlight material settings with the GlobalHighlight<T> resource. For example, to update the StandardMaterial highlight color for 3D meshes, you would access ResMut<GlobalHighlight<StandardMaterial>>.

Overriding Highlighting Appearance

By default, this plugin will use the resource to define global highlighting settings for assets of type T. You can override this global default with the optional fields in the Highlight component.

Trait Implementations

impl Plugin for DefaultHighlightingPlugin

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.