Skip to main content

ChunkManager

Struct ChunkManager 

Source
pub struct ChunkManager {
    pub load_distance: f32,
    pub unload_distance: f32,
    /* private fields */
}
Expand description

Central registry that tracks the state of every chunk in the streaming system.

ChunkManager is inserted as a Bevy Resource by WorldPlugin and updated by systems::streaming_system every frame. It maintains two internal sets:

  • Loaded — chunks that have a live Bevy entity with a built mesh. Query membership with is_loaded and retrieve the entity with get_entity.
  • Pending — chunk coordinates for which a ChunkLoadRequest has been emitted but whose generation is not yet complete. Query membership with is_pending.

The two public distance fields, load_distance and unload_distance, are read every frame by the streaming system. They default to DEFAULT_LOAD_DISTANCE and DEFAULT_UNLOAD_DISTANCE respectively, and can be overridden at runtime or by loading a config::WorldConfig.

§Querying chunks

use bevy::prelude::*;
use voxel_framework::world::ChunkManager;

fn inspect_chunks(manager: Res<ChunkManager>) {
    println!("loaded: {}, pending: {}", manager.loaded_count(), manager.pending_count());

    for (coord, entity) in manager.iter_loaded() {
        println!("chunk {:?} → entity {:?}", coord, entity);
    }
}

§Registering a generated chunk

After generating voxel data and spawning the entity, call register to promote the coord from pending to loaded:

use bevy::prelude::*;
use voxel_framework::world::ChunkManager;

fn finish_generation(mut manager: ResMut<ChunkManager>, mut commands: Commands) {
    let coord = IVec3::new(1, 0, 0);
    let entity = commands.spawn_empty().id();
    manager.register(coord, entity);
}

Fields§

§load_distance: f32

Distance (world units) within which chunks are loaded.

§unload_distance: f32

Distance (world units) beyond which chunks are unloaded.

Implementations§

Source§

impl ChunkManager

Source

pub fn new(load_distance: f32, unload_distance: f32) -> Self

Creates a new ChunkManager with the given streaming distances.

Source

pub fn is_loaded(&self, coord: IVec3) -> bool

Returns true if the chunk at coord is fully loaded.

Source

pub fn is_pending(&self, coord: IVec3) -> bool

Returns true if the chunk at coord is queued or in-flight.

Source

pub fn get_entity(&self, coord: IVec3) -> Option<Entity>

Returns the Bevy entity for a fully loaded chunk, if any.

Source

pub fn mark_pending(&mut self, coord: IVec3)

Marks a chunk coord as pending load.

No-op if the chunk is already loaded or already pending.

Source

pub fn register(&mut self, coord: IVec3, entity: Entity)

Registers a fully loaded chunk with its Bevy entity.

Removes the coord from the pending set if it was there.

Source

pub fn unregister(&mut self, coord: IVec3) -> Option<Entity>

Unregisters a chunk, removing it from loaded and pending sets.

Returns the entity if it was loaded, None otherwise.

Source

pub fn iter_loaded(&self) -> impl Iterator<Item = (IVec3, Entity)> + '_

Returns an iterator over all loaded chunk coordinates and their entities.

Source

pub fn loaded_count(&self) -> usize

Returns the number of fully loaded chunks.

Source

pub fn pending_count(&self) -> usize

Returns the number of chunks queued for loading.

Trait Implementations§

Source§

impl Debug for ChunkManager

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ChunkManager

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Resource for ChunkManager
where Self: Send + Sync + 'static,

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

Source§

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> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> Downcast for T
where T: Any,

Source§

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>

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)

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)

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
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using default().

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

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 more
Source§

impl<T> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Settings for T
where T: 'static + Send + Sync,

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more