Magnum::Ui::AbstractUserInterface class

Non-templated base for user interfaces.

Contents

See BasicUserInterface for more information.

Derived classes

template<class ... Layers>
class BasicUserInterface
Base for user interfaces.
template<class ... Layers>
class BasicUserInterface
Base for user interfaces.

Constructors, destructors, conversion operators

AbstractUserInterface(const Vector2& size, const Vector2i& screenSize) explicit
Constructor.

Public functions

auto size() const -> Vector2
User interface size.
auto activePlane() -> AbstractPlane*
Active plane.
auto activePlane() const -> const AbstractPlane*
auto handleMoveEvent(const Vector2i& screenPosition) -> bool
Handle application mouse move event.
auto handlePressEvent(const Vector2i& screenPosition) -> bool
Handle application mouse press event.
auto handleReleaseEvent(const Vector2i& screenPosition) -> bool
Handle application mouse release event.

Function documentation

Magnum::Ui::AbstractUserInterface::AbstractUserInterface(const Vector2& size, const Vector2i& screenSize) explicit

Constructor.

See BasicUserInterface::BasicUserInterface(const Vector2&, const Vector2i&) for more information.

AbstractPlane* Magnum::Ui::AbstractUserInterface::activePlane()

Active plane.

If there is no active plane, returns nullptr.

const AbstractPlane* Magnum::Ui::AbstractUserInterface::activePlane() const

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