DirectionalNeighbor.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include "phosphorgeometry_export.h"
 
#include <QList>
#include <QRectF>
#include <QStringView>
 
#include <optional>
 
namespace PhosphorGeometry {
 
enum class Direction {
    Left,
    Right,
    Up,
    Down
};
 
PHOSPHORGEOMETRY_EXPORT std::optional<Direction> directionFromString(QStringView token);
 
constexpr Direction opposite(Direction direction)
{
    switch (direction) {
    case Direction::Left:
        return Direction::Right;
    case Direction::Right:
        return Direction::Left;
    case Direction::Up:
        return Direction::Down;
    case Direction::Down:
        return Direction::Up;
    }
    return direction;
}
 
PHOSPHORGEOMETRY_EXPORT int edgeMostRect(const QList<QRectF>& candidates, Direction edge);
 
PHOSPHORGEOMETRY_EXPORT int directionalNeighbor(const QRectF& focus, const QList<QRectF>& candidates,
                                                Direction direction, bool requireOverlap = false);
 
PHOSPHORGEOMETRY_EXPORT int neighborDesktopInDirection(int currentDesktop, int desktopCount, int rows,
                                                       Direction direction);
 
} // namespace PhosphorGeometry