forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ecs: only borrow/iterate archetypes currently used by a given query

Browse Source
This commit is contained in:
Carter Anderson 2020-07-28 16:37:37 -07:00
parent 64cc382477
commit bd8e979de8
2 changed files with 24 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
crates/bevy_ecs/src/system/query.rs
View File

@ -1,8 +1,8 @@
use crate::ArchetypeAccess;
use hecs::{
Component, ComponentError, Entity, Query as HecsQuery, Ref, RefMut, World, Archetype, Access, Without, With, Fetch,
Archetype, Component, ComponentError, Entity, Fetch, Query as HecsQuery, Ref, RefMut, World,
};
use std::marker::PhantomData;
use crate::ArchetypeAccess;
pub struct Query<'a, Q: HecsQuery> {
pub(crate) world: &'a World,
@ -23,13 +23,13 @@ impl<'a, Q: HecsQuery> Query<'a, Q> {
Self {
world,
archetype_access,
_marker: PhantomData::default()
_marker: PhantomData::default(),
}
}
#[inline]
pub fn iter(&mut self) -> QueryBorrow<'_, Q> {
QueryBorrow::new(&self.world.archetypes)
QueryBorrow::new(&self.world.archetypes, self.archetype_access)
}
/// Gets a reference to the entity's component of the given type. This will fail if the entity does not have
@ -105,15 +105,22 @@ impl<'a, Q: HecsQuery> Query<'a, Q> {
/// Note that borrows are not released until this object is dropped.
pub struct QueryBorrow<'w, Q: HecsQuery> {
archetypes: &'w [Archetype],
borrowed: bool,
archetype_access: &'w ArchetypeAccess,
_marker: PhantomData<Q>,
}
impl<'w, Q: HecsQuery> QueryBorrow<'w, Q> {
pub(crate) fn new(archetypes: &'w [Archetype]) -> Self {
pub(crate) fn new(archetypes: &'w [Archetype], archetype_access: &'w ArchetypeAccess) -> Self {
for index in archetype_access.immutable.ones() {
Q::Fetch::borrow(&archetypes[index]);
}
for index in archetype_access.mutable.ones() {
Q::Fetch::borrow(&archetypes[index]);
}
Self {
archetypes,
borrowed: false,
archetype_access,
_marker: PhantomData,
}
}
@ -123,101 +130,26 @@ impl<'w, Q: HecsQuery> QueryBorrow<'w, Q> {
/// Must be called only once per query.
#[inline]
pub fn iter<'q>(&'q mut self) -> QueryIter<'q, 'w, Q> {
self.borrow();
QueryIter {
borrow: self,
archetype_index: 0,
iter: None,
}
}
fn borrow(&mut self) {
if self.borrowed {
panic!(
"called QueryBorrow::iter twice on the same borrow; construct a new query instead"
);
}
for x in self.archetypes {
// TODO: Release prior borrows on failure?
if Q::Fetch::access(x) >= Some(Access::Read) {
Q::Fetch::borrow(x);
}
}
self.borrowed = true;
}
/// Transform the query into one that requires a certain component without borrowing it
///
/// This can be useful when the component needs to be borrowed elsewhere and it isn't necessary
/// for the iterator to expose its data directly.
///
/// Equivalent to using a query type wrapped in `With`.
///
/// # Example
/// ```
/// # use hecs::*;
/// let mut world = World::new();
/// let a = world.spawn((123, true, "abc"));
/// let b = world.spawn((456, false));
/// let c = world.spawn((42, "def"));
/// let entities = world.query::<(Entity, &i32)>()
/// .with::<bool>()
/// .iter()
/// .map(|(e, &i)| (e, i)) // Copy out of the world
/// .collect::<Vec<_>>();
/// assert!(entities.contains(&(a, 123)));
/// assert!(entities.contains(&(b, 456)));
/// ```
pub fn with<T: Component>(self) -> QueryBorrow<'w, With<T, Q>> {
self.transform()
}
/// Transform the query into one that skips entities having a certain component
///
/// Equivalent to using a query type wrapped in `Without`.
///
/// # Example
/// ```
/// # use hecs::*;
/// let mut world = World::new();
/// let a = world.spawn((123, true, "abc"));
/// let b = world.spawn((456, false));
/// let c = world.spawn((42, "def"));
/// let entities = world.query::<(Entity, &i32)>()
/// .without::<bool>()
/// .iter()
/// .map(|(e, &i)| (e, i)) // Copy out of the world
/// .collect::<Vec<_>>();
/// assert_eq!(entities, &[(c, 42)]);
/// ```
pub fn without<T: Component>(self) -> QueryBorrow<'w, Without<T, Q>> {
self.transform()
}
/// Helper to change the type of the query
fn transform<R: HecsQuery>(mut self) -> QueryBorrow<'w, R> {
let x = QueryBorrow {
archetypes: self.archetypes,
borrowed: self.borrowed,
_marker: PhantomData,
};
// Ensure `Drop` won't fire redundantly
self.borrowed = false;
x
}
}
unsafe impl<'w, Q: HecsQuery> Send for QueryBorrow<'w, Q> {}
unsafe impl<'w, Q: HecsQuery> Sync for QueryBorrow<'w, Q> {}
impl<'w, Q: HecsQuery> Drop for QueryBorrow<'w, Q> {
#[inline]
fn drop(&mut self) {
if self.borrowed {
for x in self.archetypes {
if Q::Fetch::access(x) >= Some(Access::Read) {
Q::Fetch::release(x);
}
}
for index in self.archetype_access.immutable.ones() {
Q::Fetch::release(&self.archetypes[index]);
}
for index in self.archetype_access.mutable.ones() {
Q::Fetch::release(&self.archetypes[index]);
}
}
}
@ -312,4 +244,4 @@ impl<Q: HecsQuery> ChunkIter<Q> {
break Some(self.fetch.next());
}
}
}
}

8
examples/2d/texture_atlas.rs
View File

@ -20,15 +20,10 @@ pub struct RpgSpriteHandles {
atlas_loaded: bool,
}
fn setup(
mut commands: Commands,
mut rpg_sprite_handles: ResMut<RpgSpriteHandles>,
asset_server: Res<AssetServer>,
) {
fn setup(mut rpg_sprite_handles: ResMut<RpgSpriteHandles>, asset_server: Res<AssetServer>) {
rpg_sprite_handles.handles = asset_server
.load_asset_folder("assets/textures/rpg")
.unwrap();
commands.spawn(Camera2dComponents::default());
}
fn load_atlas(
@ -63,6 +58,7 @@ fn load_atlas(
// set up a scene to display our texture atlas
commands
.spawn(Camera2dComponents::default())
// draw a sprite from the atlas
.spawn(SpriteSheetComponents {
scale: Scale(4.0),