Struct tiled::Layer

pub struct Layer<'map> { /* private fields */ }

A generic map layer, accessed via Map::layers().

Implementations

impl<'map> Layer<'map>

pub fn map(&self) -> &'map Map

Get the map this object is from.

impl<'map> Layer<'map>

pub fn layer_type(&self) -> LayerType<'map>

Get the layer’s type.

pub fn as_tile_layer(self) -> Option<TileLayer<'map>>

Convenience method to return this layer as a tile layer, only if it is one.

Identical to:

match layer.layer_type() {
    LayerType::Tiles(x) => Some(x),
    _ => None,
}

pub fn as_object_layer(self) -> Option<ObjectLayer<'map>>

Convenience method to return this layer as an object group, only if it is one.

Identical to:

match layer.layer_type() {
    LayerType::Objects(x) => Some(x),
    _ => None,
}

pub fn as_image_layer(self) -> Option<ImageLayer<'map>>

Convenience method to return this layer as an image layer, only if it is one.

Identical to:

match layer.layer_type() {
    LayerType::Image(x) => Some(x),
    _ => None,
}

pub fn as_group_layer(self) -> Option<GroupLayer<'map>>

Convenience method to return this layer as a group layer, only if it is one.

Identical to:

match layer.layer_type() {
    LayerType::Group(x) => Some(x),
    _ => None,
}

Methods from Deref<Target = LayerData>

pub fn id(&self) -> u32

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.

Trait Implementations

impl<'map> Clone for Layer<'map>

fn clone(&self) -> Layer<'map>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'map> Debug for Layer<'map>

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

Formats the value using the given formatter.

impl<'map> Deref for Layer<'map>

type Target = LayerData

The resulting type after dereferencing.

fn deref(&self) -> &'map Self::Target

Dereferences the value.

impl<'map> PartialEq for Layer<'map>

fn eq(&self, other: &Layer<'map>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'map> Copy for Layer<'map>

impl<'map> StructuralPartialEq for Layer<'map>