Magnum::Ui::Plane class

Default UI plane.

Base classes

template<class... Layers>
class BasicPlane
Base for planes.

Constructors, destructors, conversion operators

Plane(UserInterface& ui, const Anchor& anchor) explicit
Constructor.
Plane(UserInterface& ui, const Anchor& anchor, std::size_t backgroundCapacity, std::size_t foregroundCapacity, std::size_t textCapacity) explicit
Construct and reserve capacity.

Public functions

auto ui() -> UserInterface&
User interface this plane is part of.
auto ui() const -> const UserInterface&
auto previousActivePlane() -> Plane*
Previous active plane.
auto previousActivePlane() const -> const Plane*
void reset(std::size_t backgroundCapacity, std::size_t foregroundCapacity, std::size_t textCapacity)
Reset plane contents.

Function documentation

Magnum::Ui::Plane::Plane(UserInterface& ui, const Anchor& anchor) explicit

Constructor.

Parameters
ui User interface this plane is part of
anchor Positioning anchor

Magnum::Ui::Plane::Plane(UserInterface& ui, const Anchor& anchor, std::size_t backgroundCapacity, std::size_t foregroundCapacity, std::size_t textCapacity) explicit

Construct and reserve capacity.

Parameters
ui User interface this plane is part of
anchor Positioning anchor
backgroundCapacity Number of background elements to reserve
foregroundCapacity Number of foreground elements to reserve
textCapacity Number of text glyphs to reserve

Calls reset() as part of the construction.

const UserInterface& Magnum::Ui::Plane::ui() const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Plane* Magnum::Ui::Plane::previousActivePlane()

Previous active plane.

See AbstractPlane::previousActivePlane() for more information.

const Plane* Magnum::Ui::Plane::previousActivePlane() const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void Magnum::Ui::Plane::reset(std::size_t backgroundCapacity, std::size_t foregroundCapacity, std::size_t textCapacity)

Reset plane contents.

Parameters
backgroundCapacity Number of background elements to reserve
foregroundCapacity Number of foreground elements to reserve
textCapacity Number of text glyphs to reserve

Clears contents of the plane and reserves memory. If the memory capacity is enough, no reallocation is done.