Muto::LayerStack Class Reference

Manages an ordered stack of Layer pointers. Layers can be pushed or popped and the stack can be iterated in forward or reverse order. More...

#include <LayerStack.h>

Public Member Functions
std::vector< Layer * >::iterator	begin ()
	Returns an iterator to the beginning of the layer stack.
std::vector< Layer * >::iterator	end ()
	Returns an iterator to the end of the layer stack.
	LayerStack ()
void	PopLayer (Layer *layer)
	Removes the specified layer from the stack.
void	PopOverlay (Layer *overlay)
	Removes the specified overlay layer from the stack.
void	PushLayer (Layer *layer)
	Adds the layer to the stack at the position before the first overlay.
void	PushOverlay (Layer *overlay)
	Pushes the overlay layer on top of all other layers.
std::vector< Layer * >::reverse_iterator	rbegin ()
	Returns a reverse iterator to the beginning of the layer stack.
std::vector< Layer * >::reverse_iterator	rend ()
	Returns a reverse iterator to the end of the layer stack.
	~LayerStack ()

Private Attributes
unsigned int	m_LayerInsertIndex = 0
	Index indicating where to insert new layers (before overlays).
std::vector< Layer * >	m_Layers
	Vector holding pointers to the layers in the stack.

Detailed Description

Manages an ordered stack of Layer pointers. Layers can be pushed or popped and the stack can be iterated in forward or reverse order.

Todo:

Add layer priority system (maybe?)

Constructor & Destructor Documentation

LayerStack()

Muto::LayerStack::LayerStack

(

)

    {
    }

~LayerStack()

Muto::LayerStack::~LayerStack

(

)

    {
        for (Layer* layer : m_Layers)
        {
            layer->OnDetach();
            delete layer;
        }
    }

Member Function Documentation

begin()

std::vector< Layer * >::iterator Muto::LayerStack::begin ( )

inline

Returns an iterator to the beginning of the layer stack.

{ return m_Layers.begin(); }

end()

std::vector< Layer * >::iterator Muto::LayerStack::end ( )

inline

Returns an iterator to the end of the layer stack.

{ return m_Layers.end(); }

PopLayer()

void Muto::LayerStack::PopLayer

(

Layer *

layer

)

Removes the specified layer from the stack.

Parameters

layer

Pointer to the layer to be removed.

    {
        MU_PROFILE_FUNCTION();
        auto it = std::find(m_Layers.begin(), m_Layers.end(), layer);
        if (it != m_Layers.end())
        {
            m_Layers.erase(it);
            m_LayerInsertIndex--;
        }
    }

References m_LayerInsertIndex.

PopOverlay()

void Muto::LayerStack::PopOverlay

(

Layer *

overlay

)

Removes the specified overlay layer from the stack.

Parameters

overlay

Pointer to the overlay layer to be removed.

    {
        MU_PROFILE_FUNCTION();
        auto it = std::find(m_Layers.begin(), m_Layers.end(), overlay);
        if (it != m_Layers.end())
        {
            m_Layers.erase(it);
        }
    }

PushLayer()

void Muto::LayerStack::PushLayer

(

Layer *

layer

)

Adds the layer to the stack at the position before the first overlay.

Parameters

layer

Pointer to the layer to be added.

    {
        MU_PROFILE_FUNCTION();
        m_Layers.emplace(m_Layers.begin() + m_LayerInsertIndex, layer);
        m_LayerInsertIndex++;
    }

References m_LayerInsertIndex.

PushOverlay()

void Muto::LayerStack::PushOverlay

(

Layer *

overlay

)

Pushes the overlay layer on top of all other layers.

Parameters

overlay

Pointer to the overlay layer to be added.

    {
        MU_PROFILE_FUNCTION();
        m_Layers.emplace_back(overlay);
    }

rbegin()

std::vector< Layer * >::reverse_iterator Muto::LayerStack::rbegin ( )

inline

Returns a reverse iterator to the beginning of the layer stack.

{ return m_Layers.rbegin(); }

rend()

std::vector< Layer * >::reverse_iterator Muto::LayerStack::rend ( )

inline

Returns a reverse iterator to the end of the layer stack.

{ return m_Layers.rend(); }

Member Data Documentation

m_LayerInsertIndex

unsigned int Muto::LayerStack::m_LayerInsertIndex = 0

private

Index indicating where to insert new layers (before overlays).

Referenced by PopLayer(), and PushLayer().

m_Layers

std::vector<Layer*> Muto::LayerStack::m_Layers

private

Vector holding pointers to the layers in the stack.

---

The documentation for this class was generated from the following files:

• Muto/src/App/LayerStack.h
• Muto/src/App/LayerStack.cpp