1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
use std::{path::Path, sync::Arc};
use xml::attribute::OwnedAttribute;
use crate::{
error::Result, properties::Properties, util::*, Color, Map, MapTilesetGid, ResourceCache,
ResourceReader, Tileset,
};
mod image;
pub use image::*;
mod object;
pub use object::*;
mod tile;
pub use tile::*;
mod group;
pub use group::*;
#[derive(Clone, PartialEq, Debug)]
pub(crate) enum LayerDataType {
Tiles(TileLayerData),
Objects(ObjectLayerData),
Image(ImageLayerData),
Group(GroupLayerData),
}
#[derive(Clone, Copy)]
pub(crate) enum LayerTag {
Tiles,
Objects,
Image,
Group,
}
/// The raw data of a [`Layer`]. Does not include a reference to its parent [`Map`](crate::Map).
#[derive(Clone, PartialEq, Debug)]
pub struct LayerData {
/// The layer's name, set arbitrarily by the user.
pub name: String,
id: u32,
/// Whether this layer should be visible or not.
pub visible: bool,
/// The layer's x offset (in pixels).
pub offset_x: f32,
/// The layer's y offset (in pixels).
pub offset_y: f32,
/// The layer's x parallax factor.
pub parallax_x: f32,
/// The layer's y parallax factor.
pub parallax_y: f32,
/// The layer's opacity.
pub opacity: f32,
/// The layer's tint color.
pub tint_color: Option<Color>,
/// The layer's custom properties, as arbitrarily set by the user.
pub properties: Properties,
/// The layer's type, which is arbitrarily setby the user.
pub user_type: Option<String>,
layer_type: LayerDataType,
}
impl LayerData {
/// Get the layer's id. Unique within the parent map. Valid only if greater than 0. Defaults to
/// 0 if the layer was loaded from a file that didn't have the attribute present.
#[inline]
pub fn id(&self) -> u32 {
self.id
}
pub(crate) fn new(
parser: &mut impl Iterator<Item = XmlEventResult>,
attrs: Vec<OwnedAttribute>,
tag: LayerTag,
infinite: bool,
map_path: &Path,
tilesets: &[MapTilesetGid],
for_tileset: Option<Arc<Tileset>>,
reader: &mut impl ResourceReader,
cache: &mut impl ResourceCache,
) -> Result<Self> {
let (
opacity,
tint_color,
visible,
offset_x,
offset_y,
parallax_x,
parallax_y,
name,
id,
user_type,
user_class,
) = get_attrs!(
for v in attrs {
Some("opacity") => opacity ?= v.parse(),
Some("tintcolor") => tint_color ?= v.parse(),
Some("visible") => visible ?= v.parse().map(|x:i32| x == 1),
Some("offsetx") => offset_x ?= v.parse(),
Some("offsety") => offset_y ?= v.parse(),
Some("parallaxx") => parallax_x ?= v.parse(),
Some("parallaxy") => parallax_y ?= v.parse(),
Some("name") => name = v,
Some("id") => id ?= v.parse(),
Some("type") => user_type ?= v.parse(),
Some("class") => user_class ?= v.parse(),
}
(opacity, tint_color, visible, offset_x, offset_y, parallax_x, parallax_y, name, id, user_type, user_class)
);
let (ty, properties) = match tag {
LayerTag::Tiles => {
let (ty, properties) = TileLayerData::new(parser, attrs, infinite, tilesets)?;
(LayerDataType::Tiles(ty), properties)
}
LayerTag::Objects => {
let (ty, properties) = ObjectLayerData::new(
parser,
attrs,
Some(tilesets),
for_tileset,
map_path.parent().ok_or(crate::Error::PathIsNotFile)?,
reader,
cache,
)?;
(LayerDataType::Objects(ty), properties)
}
LayerTag::Image => {
let (ty, properties) = ImageLayerData::new(parser, map_path)?;
(LayerDataType::Image(ty), properties)
}
LayerTag::Group => {
let (ty, properties) = GroupLayerData::new(
parser,
infinite,
map_path,
tilesets,
for_tileset,
reader,
cache,
)?;
(LayerDataType::Group(ty), properties)
}
};
Ok(Self {
visible: visible.unwrap_or(true),
offset_x: offset_x.unwrap_or(0.0),
offset_y: offset_y.unwrap_or(0.0),
parallax_x: parallax_x.unwrap_or(1.0),
parallax_y: parallax_y.unwrap_or(1.0),
opacity: opacity.unwrap_or(1.0),
tint_color,
name: name.unwrap_or_default(),
id: id.unwrap_or(0),
user_type: user_type.or(user_class),
properties,
layer_type: ty,
})
}
}
map_wrapper!(
#[doc = "A generic map layer, accessed via [`Map::layers()`]."]
Layer => LayerData
);
impl<'map> Layer<'map> {
/// Get the layer's type.
#[inline]
pub fn layer_type(&self) -> LayerType<'map> {
LayerType::new(self.map, &self.data.layer_type)
}
/// Convenience method to return this layer as a tile layer, only if it is one.
///
/// Identical to:
/// ```ignore
/// match layer.layer_type() {
/// LayerType::Tiles(x) => Some(x),
/// _ => None,
/// }
/// ```
#[inline]
pub fn as_tile_layer(self) -> Option<TileLayer<'map>> {
match self.layer_type() {
LayerType::Tiles(x) => Some(x),
_ => None,
}
}
/// Convenience method to return this layer as an object group, only if it is one.
///
/// Identical to:
/// ```ignore
/// match layer.layer_type() {
/// LayerType::Objects(x) => Some(x),
/// _ => None,
/// }
/// ```
#[inline]
pub fn as_object_layer(self) -> Option<ObjectLayer<'map>> {
match self.layer_type() {
LayerType::Objects(x) => Some(x),
_ => None,
}
}
/// Convenience method to return this layer as an image layer, only if it is one.
///
/// Identical to:
/// ```ignore
/// match layer.layer_type() {
/// LayerType::Image(x) => Some(x),
/// _ => None,
/// }
/// ```
#[inline]
pub fn as_image_layer(self) -> Option<ImageLayer<'map>> {
match self.layer_type() {
LayerType::Image(x) => Some(x),
_ => None,
}
}
/// Convenience method to return this layer as a group layer, only if it is one.
///
/// Identical to:
/// ```ignore
/// match layer.layer_type() {
/// LayerType::Group(x) => Some(x),
/// _ => None,
/// }
/// ```
#[inline]
pub fn as_group_layer(self) -> Option<GroupLayer<'map>> {
match self.layer_type() {
LayerType::Group(x) => Some(x),
_ => None,
}
}
}
/// Represents some kind of map layer.
#[derive(Debug)]
pub enum LayerType<'map> {
/// A tile layer; Also see [`TileLayer`].
Tiles(TileLayer<'map>),
/// An object layer (also called object group); Also see [`ObjectLayer`].
Objects(ObjectLayer<'map>),
/// An image layer; Also see [`ImageLayer`].
Image(ImageLayer<'map>),
/// A group layer; Also see [`GroupLayer`].
Group(GroupLayer<'map>),
}
impl<'map> LayerType<'map> {
fn new(map: &'map Map, data: &'map LayerDataType) -> Self {
match data {
LayerDataType::Tiles(data) => Self::Tiles(TileLayer::new(map, data)),
LayerDataType::Objects(data) => Self::Objects(ObjectLayer::new(map, data)),
LayerDataType::Image(data) => Self::Image(ImageLayer::new(map, data)),
LayerDataType::Group(data) => Self::Group(GroupLayer::new(map, data)),
}
}
}