Magnum::Ui::AbstractPlane class

Non-templated base for planes.

See BasicPlane for more information.

Derived classes

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

Public types

using Flag = PlaneFlag deprecated
Plane flag.
using Flags = PlaneFlags deprecated
Plane flags.

Constructors, destructors, conversion operators

AbstractPlane(AbstractUserInterface& ui, const Anchor& anchor, const Range2D& padding, const Vector2& margin) explicit
Constructor.

Public functions

auto ui() -> AbstractUserInterface&
User interface this plane is part of.
auto ui() const -> const AbstractUserInterface&
auto rect() const -> Range2D
Plane rectangle.
auto padding() const -> Range2D
Padding for widgets inside.
auto margin() const -> Vector2
Margin between the widgets inside.
auto flags() const -> PlaneFlags
Flags.
auto previousActivePlane() -> AbstractPlane*
Previous active plane.
auto previousActivePlane() const -> const AbstractPlane*
auto nextActivePlane() -> AbstractPlane*
Next active plane.
auto nextActivePlane() const -> const AbstractPlane*
void activate()
Activate the plane.
void hide()
Hide the plane.

Typedef documentation

typedef PlaneFlag Magnum::Ui::AbstractPlane::Flag

Plane flag.

typedef PlaneFlags Magnum::Ui::AbstractPlane::Flags

Plane flags.

Function documentation

Magnum::Ui::AbstractPlane::AbstractPlane(AbstractUserInterface& ui, const Anchor& anchor, const Range2D& padding, const Vector2& margin) explicit

Constructor.

Parameters
ui User interface this plane is part of
anchor Positioning anchor
padding Padding for widgets inside
margin Margin between the widgets inside

const AbstractUserInterface& Magnum::Ui::AbstractPlane::ui() const

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

Vector2 Magnum::Ui::AbstractPlane::margin() const

Margin between the widgets inside.

Used also as margin around the plane.

PlaneFlags Magnum::Ui::AbstractPlane::flags() const

Flags.

AbstractPlane* Magnum::Ui::AbstractPlane::previousActivePlane()

Previous active plane.

Plane that was active before this plane was active. If this plane is at the back of the active hierarchy or not part of the active hierarchy at all, the function returns nullptr.

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

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

AbstractPlane* Magnum::Ui::AbstractPlane::nextActivePlane()

Next active plane.

Active plane immediately in front of current. If this plane is at the front of the active hierarchy or not part of the active hierarchy at all, the function returns nullptr.

const AbstractPlane* Magnum::Ui::AbstractPlane::nextActivePlane() 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::AbstractPlane::activate()

Activate the plane.

Activates the plane so it is frontmost, receives input events and visible. If the plane is already active, the function is a no-op.

void Magnum::Ui::AbstractPlane::hide()

Hide the plane.

Hides the plane and transfers the focus to previously active plane. If the plane is already hidden, the function is a no-op.