Mirrored_Repos/veloren
1
0
Fork 0
mirror of https://gitlab.com/veloren/veloren.git synced 2024-08-30 18:12:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add some documentation to pos_key/key_pos/pos_chunk methods which are easy to mix up

Browse Source
This commit is contained in:
Imbris 2023-03-10 02:24:09 -05:00
parent 0d8aa16d89
commit 2d66145620
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
common/src/volumes/vol_grid_2d.rs
View File

@ -221,12 +221,19 @@ impl<V: RectRasterableVol> VolGrid2d<V> {
pub fn remove(&mut self, key: Vec2<i32>) -> Option<Arc<V>> { self.chunks.remove(&key) }
/// Converts a chunk key (i.e. coordinates in terms of chunks) into a
/// position in the world (aka "wpos").
///
/// The returned position will be in the corner of the chunk.
#[inline(always)]
pub fn key_pos(&self, key: Vec2<i32>) -> Vec2<i32> { Self::key_chunk(key) }
/// Converts a position in the world into a chunk key (i.e. coordinates in
/// terms of chunks).
#[inline(always)]
pub fn pos_key(&self, pos: Vec3<i32>) -> Vec2<i32> { Self::chunk_key(pos) }
/// Gets the chunk that contains the provided world position.
#[inline(always)]
pub fn pos_chunk(&self, pos: Vec3<i32>) -> Option<&V> { self.get_key(self.pos_key(pos)) }