Skip to content
This repository has been archived by the owner on May 7, 2022. It is now read-only.

Commit

Permalink
Remove deprecations
Browse files Browse the repository at this point in the history
  • Loading branch information
@joshuajbouw
joshuajbouw committed Nov 19, 2020
1 parent 0d9fc1f commit 1a2bc7e
Show file tree
Hide file tree
Showing 7 changed files with 121 additions and 774 deletions.
3 changes: 0 additions & 3 deletions Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@ exclude = ["assets/**/*", ".github/**/*"]
[features]
default = ["serde"]

# Prelude version to use.
v0_1 = []

[dependencies]
bevy = { version = "0.3", features = ["default"] }
serde = { version = "1.0", optional = true, features = ["derive"] }
Expand Down
67 changes: 0 additions & 67 deletions src/coord.rs
View file

This file was deleted.

267 changes: 0 additions & 267 deletions src/dimensions.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -241,270 +241,3 @@ impl Dimensions3 {
Ok(self.decode_coord_unchecked(index))
}
}

#[deprecated(
since = "0.2.0",
note = "please use do not use, will be removed by v0.3.0"
)]
#[doc(hidden)]
pub mod deprecated {
use crate::lib::*;

#[derive(Clone, Copy, PartialEq)]
/// The kinds of errors that can occur for a `[DimensionError]`.
pub enum ErrorKind {
/// If the coordinate or index is out of bounds.
OutOfBounds,
}

impl Debug for ErrorKind {
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
use ErrorKind::*;
match *self {
OutOfBounds => write!(f, "out of bounds in the chunk"),
}
}
}

#[derive(Clone, PartialEq)]
/// A MapError indicates that an error with the `[Chunk]` has occurred.
pub struct DimensionError(Box<ErrorKind>);

impl Debug for DimensionError {
fn fmt(&self, f: &mut Formatter) -> FmtResult {
self.0.fmt(f)
}
}

impl From<ErrorKind> for DimensionError {
fn from(err: ErrorKind) -> DimensionError {
DimensionError::new(err)
}
}

impl DimensionError {
/// Creates a new `MapError`.
pub fn new(kind: ErrorKind) -> DimensionError {
DimensionError(Box::new(kind))
}

/// Returns the underlying error kind `ErrorKind`.
pub fn kind(&self) -> ErrorKind {
*self.0
}
}

/// A chunk result.
pub type DimensionResult<T> = Result<T, DimensionError>;

/// Trait methods that have to do with the 2nd dimension.
pub trait Dimensions2 {
/// A `Vec2` containing the dimensions.
fn dimensions(&self) -> Vec2;

/// The width of this dimension.
fn width(&self) -> f32 {
self.dimensions().x()
}

/// The height of this dimension.
fn height(&self) -> f32 {
self.dimensions().y()
}

/// The minimum X value of this dimension.
fn min_x(&self) -> f32 {
0.
}

/// The minimum Y value of this dimension.
fn min_y(&self) -> f32 {
0.
}

/// The maximum X value of this dimension.
fn max_x(&self) -> f32 {
self.dimensions().x() - 1.
}

/// The maximum Y value of this dimension.
fn max_y(&self) -> f32 {
self.dimensions().y() - 1.
}

/// Returns the center of the `Map` as a `Vec2` `Chunk` coordinate.
fn center(&self) -> Vec2 {
Vec2::new(self.dimensions().x() / 2., self.dimensions().y() / 2.)
}

/// Checks if a coordinate is valid and inbounds.
fn check_coord(&self, coord: &Vec2) -> DimensionResult<()> {
if coord.x() > self.max_x()
|| coord.y() > self.max_y()
|| coord.x() < self.min_x()
|| coord.y() < self.min_y()
{
Err(ErrorKind::OutOfBounds.into())
} else {
Ok(())
}
}

/// Checks if an index is valid and inbounds.
fn check_index(&self, idx: usize) -> DimensionResult<()> {
// NOTE: I think this should have a min case?
if idx > (self.dimensions().x() * self.dimensions().y()) as usize {
Err(ErrorKind::OutOfBounds.into())
} else {
Ok(())
}
}

/// Encodes a coordinate and returns an index value, unchecked.
fn encode_coord_unchecked(&self, coord: &Vec2) -> usize {
((coord.y() * self.dimensions().x()) + coord.x()) as usize
}

/// Encodes a coordinate and returns an index value.
fn encode_coord(&self, coord: &Vec2) -> DimensionResult<usize> {
self.check_coord(coord)?;
Ok(self.encode_coord_unchecked(coord))
}

/// Decodes an index value and returns a coordinate, unchecked.
fn decode_coord_unchecked(&self, idx: usize) -> Vec2 {
let y = idx / self.dimensions().y() as usize;
let x = idx % self.dimensions().x() as usize;
Vec2::new(x as f32, y as f32)
}

/// Decodes an index value and returns a coordinate.
fn decode_coord(&self, idx: usize) -> DimensionResult<Vec2> {
self.check_index(idx)?;
Ok(self.decode_coord_unchecked(idx))
}
}

impl Dimensions2 for Vec2 {
fn dimensions(&self) -> Vec2 {
*self
}
}

/// Trait methods that have to do with the 3rd dimension.
pub trait Dimensions3 {
/// A `Vec3` containing the dimensions.
fn dimensions(&self) -> Vec3;

/// The width of this dimension.
fn width(&self) -> f32 {
self.dimensions().x()
}

/// The height of this dimension.
fn height(&self) -> f32 {
self.dimensions().y()
}

/// The depth of this dimension.
fn depth(&self) -> f32 {
self.dimensions().z()
}

/// The minimum X value of this dimension.
fn min_x(&self) -> f32 {
0.
}

/// The minimum Y value of this dimension.
fn min_y(&self) -> f32 {
0.
}

/// The minimum Z value of this dimension.
fn min_z(&self) -> f32 {
0.
}

/// The maximum X value of this dimension.
fn max_x(&self) -> f32 {
self.dimensions().x() - 1.
}

/// The maximum Y value of this dimension.
fn max_y(&self) -> f32 {
self.dimensions().y() - 1.
}

/// The maximum Z value of this dimension.
fn max_z(&self) -> f32 {
self.dimensions().z() - 1.
}

/// Returns the center as a `Vec3`.
fn center(&self) -> Vec3 {
Vec3::new(
self.dimensions().x() / 2.,
self.dimensions().y() / 2.,
self.dimensions().z() / 2.,
)
}

/// Checks if a given coordinate is within bounds of the `Chunk`.
fn check_coord(&self, coord: &Vec3) -> DimensionResult<()> {
if coord.x() > self.dimensions().x()
|| coord.y() > self.dimensions().y()
|| coord.z() > self.dimensions().z()
{
Err(ErrorKind::OutOfBounds.into())
} else {
Ok(())
}
}

/// Checks if a given index is within bounds of the `Chunk`.
fn check_index(&self, idx: usize) -> DimensionResult<()> {
if idx
> (self.dimensions().x() * self.dimensions().y() * self.dimensions().z()) as usize
{
Err(ErrorKind::OutOfBounds.into())
} else {
Ok(())
}
}

/// Encodes a Vec3 coordinate to an usize index to use in the Tile vector, unchecked.
fn encode_coord_unchecked(&self, coord: &Vec3) -> usize {
((coord.z() * self.dimensions().x() * self.dimensions().y())
+ (coord.y() * self.dimensions().x())
+ coord.x()) as usize
}

/// Encodes a `Vec3` coordinate to an `usize` index to use in the `Tile` vector.
fn encode_coord(&self, coord: &Vec3) -> DimensionResult<usize> {
self.check_coord(coord)?;
Ok(self.encode_coord_unchecked(coord))
}

/// Decodes a Tile index and returns the coordinates in the Chunk, unchecked.
fn decode_coord_unchecked(&self, idx: usize) -> Vec3 {
let z = idx as f32 / (self.dimensions().x() * self.dimensions().y());
let idx = idx as f32 - (z * self.dimensions().x() * self.dimensions().y());
let y = self.dimensions().y() - 1. - (idx / self.dimensions().x());
let x = idx % self.dimensions().x();
Vec3::new(x, y, z)
}

/// Decodes a `Tile` index and returns the coordinates in the `Chunk`.
fn decode_coord(&self, idx: usize) -> DimensionResult<Vec3> {
self.check_index(idx)?;
Ok(self.decode_coord_unchecked(idx))
}
}

impl Dimensions3 for Vec3 {
fn dimensions(&self) -> Vec3 {
*self
}
}
}
15 changes: 1 addition & 14 deletions src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,6 @@

/// Chunk traits to implement for a custom chunk and a basic struct for use.
pub mod chunk;
/// Various coordinate traits used for converting indexes and coordinates.
#[deprecated(
since = "0.2.0",
note = "please use `point::Point2` and `point::Point3` instead, will be removed by v0.3.0"
)]
#[doc(hidden)]
pub mod coord;
/// Various dimension based traits.
mod dimensions;
/// Bundles of components for spawning entities.
Expand All @@ -38,12 +31,6 @@ pub mod prelude;
pub(crate) mod render;
/// Tile traits to implement for a custom tile.
pub mod tile;
/// A growable heap used for setting multiple tiles at once.
#[deprecated(
since = "0.2.0",
note = "please use `tile::Tiles` instead, will be removed by v0.3.0"
)]
pub mod tile_setter;
/// Map traits to implement for a custom map and a basic struct for use.
pub mod tilemap;

Expand Down Expand Up @@ -125,7 +112,7 @@ mod lib {
convert::{AsMut, AsRef, From, Into},
default::Default,
fmt::{Debug, Formatter, Result as FmtResult},
iter::{Extend, IntoIterator, Iterator},
iter::{Extend, Iterator},
ops::{FnMut, FnOnce},
option::Option::{self, *},
result::Result::{self, *},
Expand Down
Loading

0 comments on commit 1a2bc7e

Please sign in to comment.