pub struct MultiGeneratorPlugin<V: VoxelType> { /* private fields */ }Expand description
Bevy Plugin that installs a MultiGenerator<V> as the active
GeneratorResource<V> for voxel type V.
Mirrors the behaviour of GeneratorPlugin but
inserts the resource itself, so no separate
app.insert_resource(GeneratorResource { ... }) step is needed. Add this
plugin alongside GeneratorPlugin — the latter
still owns the async job-queue systems; this plugin only provides the
generator backing them.
§Builder workflow
use bevy::prelude::*;
use bevy::math::IVec3;
use voxel_framework::chunk::Chunk;
use voxel_framework::generator::{
ChunkGenerator, GeneratorPlugin, MultiGenerator, MultiGeneratorPlugin,
RegionGenerator,
};
use voxel_framework::voxel::DefaultVoxel;
struct VoidGen;
impl ChunkGenerator<DefaultVoxel> for VoidGen {
fn generate(&self, _c: IVec3, _chunk: &mut Chunk<DefaultVoxel>) {}
}
struct MoonGen;
impl RegionGenerator<DefaultVoxel> for MoonGen {
fn applies_to(&self, c: IVec3) -> bool { c.length_squared() < 4 }
fn generate(&self, _c: IVec3, chunk: &mut Chunk<DefaultVoxel>) {
chunk.set(0, 0, 0, DefaultVoxel::Rock);
}
}
let plugin = MultiGeneratorPlugin::<DefaultVoxel>::new(Box::new(VoidGen))
.add_region(Box::new(MoonGen));
App::new()
.add_plugins(plugin)
.add_plugins(GeneratorPlugin::<DefaultVoxel>::new());Implementations§
Source§impl<V: VoxelType> MultiGeneratorPlugin<V>
impl<V: VoxelType> MultiGeneratorPlugin<V>
Sourcepub fn new(fallback: Box<dyn ChunkGenerator<V>>) -> Self
pub fn new(fallback: Box<dyn ChunkGenerator<V>>) -> Self
Creates a plugin builder seeded with a fallback generator and no regions.
Sourcepub fn from_generator(multi: MultiGenerator<V>) -> Self
pub fn from_generator(multi: MultiGenerator<V>) -> Self
Wraps an existing MultiGenerator in a plugin without further
builder calls.
Sourcepub fn add_region(self, region: Box<dyn RegionGenerator<V>>) -> Self
pub fn add_region(self, region: Box<dyn RegionGenerator<V>>) -> Self
Appends a region generator (builder style).
Sourcepub fn with_fallback(self, fallback: Box<dyn ChunkGenerator<V>>) -> Self
pub fn with_fallback(self, fallback: Box<dyn ChunkGenerator<V>>) -> Self
Replaces the fallback generator (builder style).
Trait Implementations§
Source§impl<V: VoxelType> Plugin for MultiGeneratorPlugin<V>
impl<V: VoxelType> Plugin for MultiGeneratorPlugin<V>
Source§fn ready(&self, _app: &App) -> bool
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.Source§fn finish(&self, _app: &mut App)
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.Source§fn cleanup(&self, _app: &mut App)
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.
impl<V: VoxelType> VoxelFrameworkPlugin for MultiGeneratorPlugin<V>
impl<V: VoxelType> WorldDataPlugin for MultiGeneratorPlugin<V>
Auto Trait Implementations§
impl<V> !Freeze for MultiGeneratorPlugin<V>
impl<V> Forget for MultiGeneratorPlugin<V>
impl<V> RefUnwindSafe for MultiGeneratorPlugin<V>
impl<V> Send for MultiGeneratorPlugin<V>
impl<V> Sync for MultiGeneratorPlugin<V>
impl<V> Unpin for MultiGeneratorPlugin<V>
impl<V> UnsafeUnpin for MultiGeneratorPlugin<V>
impl<V> UnwindSafe for MultiGeneratorPlugin<V>
Blanket Implementations§
Source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
Source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
Return the
T ShaderType for self. When used in AsBindGroup
derives, it is safe to assume that all images in self exist.Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
impl<T> ConditionalSend for Twhere
T: Send,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Converts
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Converts
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Converts
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Converts
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
impl<S, T> Duplex<S> for Twhere
T: FromSample<S> + ToSample<S>,
Source§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
Source§fn into_result(self) -> Result<T, RunSystemError>
fn into_result(self) -> Result<T, RunSystemError>
Converts this type into the system output type.