Magnum::Ui::LayoutLayer class new in Git master
#include <Magnum/Ui/LayoutLayer.h>

Layout properties layer.

Allows attaching layout properties such as min/max sizes, aspect ratios, paddings and margins to particular nodes.

Setting up a layout layer instance

If you create a UserInterfaceGL instance with a style and don't exclude StyleFeature::LayoutLayer, an implicit instance is already provided and available through UserInterface::layoutLayer().

Otherwise, the layout layer is constructed from a fresh AbstractUserInterface::createLayer() handle along with a count of how many distinct layout styles you intend to use — which is for example the number 3u in the following snippet. Afterwards, pass the newly created layer to UserInterface::setLayoutLayerInstance():

ui.setLayoutLayerInstance(
    Containers::pointer<Ui::LayoutLayer>(ui.createLayer(), 3u));

In comparison, if you want to set up a custom layout layer that's independent of the one exposed through UserInterface::layoutLayer(), pass the newly created instance to AbstractUserInterface::setLayerInstance() instead:

Ui::LayoutLayer& layer = ui.setLayerInstance(
    Containers::pointer<Ui::LayoutLayer>(ui.createLayer(), 3u));

Afterwards, with either of the above, assuming AbstractUserInterface::draw() is called in an appropriate place, the layer is ready to use.

Debug layer integration

When using DebugLayer node inspect and DebugLayerSource::NodeDataDetails is enabled, passing this layer to DebugLayer::setLayerName() will make it list style assignments of all data. For example:

Node {0x18, 0x1}
  Data {0x0, 0x1} from layer {0x9, 0x1} Layout with style 9

By default only style IDs are shown, but the DebugIntegration constructor accepts an optional function to map them from an UnsignedInt to a Containers::StringView. Assuming a LayoutStyle enum is used by given layer, the function could look like this, resulting in the output below:

debugLayer.setLayerName(layoutLayer, "Layout", [](UnsignedInt style) {
    using namespace Containers::Literals;

    switch(LayoutStyle(style)) {
        case LayoutStyle::Button: return "Button"_s;
        case LayoutStyle::Label: return "Label"_s;
        case LayoutStyle::Panel: return "Panel"_s;
        …
    }

    return ""_s;
});

Node {0x18, 0x1}
  Data {0x0, 0x1} from layer {0x9, 0x1} Layout with style Panel (9)

Base classes

class AbstractLayer new in Git master: Base for data layers.

Public types

class DebugIntegration: Debug layer integration.

Constructors, destructors, conversion operators

LayoutLayer(LayerHandle handle, UnsignedInt styleCount) explicit: Constructor.
LayoutLayer(const LayoutLayer&) deleted: Copying is not allowed.
LayoutLayer(LayoutLayer&&) noexcept: Move constructor.

Public functions

auto operator=(const LayoutLayer&) -> LayoutLayer& deleted: Copying is not allowed.
auto operator=(LayoutLayer&&) -> LayoutLayer& noexcept: Move assignment.
auto styleCount() const -> UnsignedInt: Style count.
auto styleMinSizes() const -> Containers::StridedArrayView1D<const Vector2>: Minimal node size for each style.
auto styleMaxSizes() const -> Containers::StridedArrayView1D<const Vector2>: Maximal node size for each style.
auto styleAspectRatios() const -> Containers::StridedArrayView1D<const Float>: Node aspect ratio for each style.
auto stylePaddings() const -> Containers::StridedArrayView1D<const Vector4>: Node padding for each style.
auto styleMargins() const -> Containers::StridedArrayView1D<const Vector4>: Node margin for each style.
void setStyle(const Containers::StridedArrayView1D<const Vector2>& minSizes, const Containers::StridedArrayView1D<const Vector2>& maxSizes, const Containers::StridedArrayView1D<const Float>& aspectRatios, const Containers::StridedArrayView1D<const Vector4>& paddings, const Containers::StridedArrayView1D<const Vector4>& margins): Set style data.
void setStyle(std::initializer_list<Vector2> minSizes, std::initializer_list<Vector2> maxSizes, std::initializer_list<Float> aspectRatios, std::initializer_list<Vector4> paddings, std::initializer_list<Vector4> margins)
auto create(UnsignedInt style, NodeHandle node = NodeHandle::Null) -> DataHandle: Create a data with given style index.
template<class StyleIndex> auto create(StyleIndex style, NodeHandle node = NodeHandle::Null) -> DataHandle: Create a data with given style index in a concrete enum type.
void remove(DataHandle handle): Remove a data.
void remove(LayerDataHandle handle): Remove a data assuming it belongs to this layer.
auto style(DataHandle handle) const -> UnsignedInt: Type-erased data style index.
template<class StyleIndex> auto style(DataHandle handle) const -> StyleIndex: Data style index in a concrete enum type.
auto style(LayerDataHandle handle) const -> UnsignedInt: Type-erased data style index assuming it belongs to this layer.
template<class StyleIndex> auto style(LayerDataHandle handle) const -> StyleIndex: Data style index in a concrete enum type assuming it belongs to this layer.
void setStyle(DataHandle handle, UnsignedInt style): Set data style index.
template<class StyleIndex> void setStyle(DataHandle handle, StyleIndex style): Set data style index in a concrete enum type.
void setStyle(LayerDataHandle handle, UnsignedInt style): Set data style index assuming it belongs to this layer.
template<class StyleIndex> void setStyle(LayerDataHandle handle, StyleIndex style): Set data style index in a concrete enum type assuming it belongs to this layer.

Function documentation

Magnum::Ui::LayoutLayer::LayoutLayer(LayerHandle handle, UnsignedInt styleCount) explicit

Constructor.

Parameters
handle	Layer handle returned from AbstractUserInterface::createLayer()
styleCount	Number of distinct styles to use

Expects that styleCount is not 0. In order to update the UI containing this layer it's expected that setStyle() was called.

Magnum::Ui::LayoutLayer::LayoutLayer(LayoutLayer&&) noexcept

Move constructor.

Performs a destructive move, i.e. the original object isn't usable afterwards anymore.