Struct AutomaticUpdate 

pub struct AutomaticUpdate<Comp, Set = SpatialSet, Schedule = Update>
where
    Set: SystemSet,
    Schedule: ScheduleLabel + Clone,
{ /* private fields */ }

Plugin struct for setting up a spatial datastructure with automatic updating.

#[derive(Component, Default)]
struct EntityMarker;

App::new()
   .add_plugins(DefaultPlugins)
   .add_plugin(AutomaticUpdate::<EntityMarker>::new()
            .with_frequency(Duration::from_secs_f32(0.3))
            .with_spatial_ds(SpatialStructure::KDTree2)
            .with_transform(TransformMode::GlobalTransform)
    )

Implementations

impl<Comp, Set: SystemSet, Schedule: ScheduleLabel + Clone> AutomaticUpdate<Comp, Set, Schedule>

pub fn new() -> AutomaticUpdate<Comp>

Create a new AutomaticUpdate with defaults. Will add to the default ScheduleLabel: Update.

pub fn with_schedule<NewSchedule: ScheduleLabel + Clone>( self, schedule: NewSchedule, ) -> AutomaticUpdate<Comp, Set, NewSchedule>

Change the Bevy ScheduleLabel in which this plugin will put its systems.

pub fn with_set<NewSet: SystemSet + Copy>( self, set: NewSet, ) -> AutomaticUpdate<Comp, NewSet, Schedule>

Change the Bevy SystemSet in which this plugin will put its systems.

pub fn with_spatial_ds(self, spatial_ds: SpatialStructure) -> Self

Change which spatial datastructure is used.

expects one of:

• SpatialStructure::KDTree2
• SpatialStructure::KDTree3 (default)
• SpatialStructure::KDTree3A

pub fn with_frequency(self, frequency: Duration) -> Self

Change the update rate.

Expects a Duration which is the delay between updates.

pub fn with_transform(self, transform: TransformMode) -> Self

Change which Transform is used to extrat coordinates from.

• TransformMode::Transform (default)
• TransformMode::GlobalTransform

Note: using TransformMode::GlobalTransform might cause double frame-delays as Transform->GlobalTransform propagation happens in the TransformPropagate SystemSet in PostUpdate. You can order this plugins systems by modifying the default SpatialSet or using your own SystemSet by calling AutomaticUpdate::with_set

Trait Implementations

impl<Comp: TComp, Set: SystemSet + Copy, Schedule: ScheduleLabel + Clone> Plugin for AutomaticUpdate<Comp, Set, Schedule>

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.