Struct tiled::GroupLayer

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

A group layer, used to organize the layers of the map in a hierarchy. Also see the TMX docs.

Note

In Tiled, the properties of the group layer recursively affect child layers. Implementing this behavior is left up to the user of this library.

Implementations

impl<'map> GroupLayer<'map>

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

Get the map this object is from.

impl<'map> GroupLayer<'map>

pub fn layers(&self) -> impl ExactSizeIterator<Item = Layer<'map>> + 'map

Returns an iterator over the layers present in this group in display order.

Example

use tiled::Layer;

let nested_layers: Vec<Layer> = map
    .layers()
    .filter_map(|layer| match layer.layer_type() {
        tiled::LayerType::Group(layer) => Some(layer),
        _ => None,
    })
    .flat_map(|layer| layer.layers())
    .collect();

dbg!(nested_layers);

pub fn get_layer(&self, index: usize) -> Option<Layer<'_>>

Gets a specific layer from the group by index.

Trait Implementations

impl<'map> Clone for GroupLayer<'map>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'map> Debug for GroupLayer<'map>

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

Formats the value using the given formatter.

impl<'map> Deref for GroupLayer<'map>

type Target = GroupLayerData

The resulting type after dereferencing.

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

Dereferences the value.

impl<'map> PartialEq for GroupLayer<'map>

fn eq(&self, other: &GroupLayer<'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 GroupLayer<'map>

impl<'map> StructuralPartialEq for GroupLayer<'map>