CameraFraming.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Valentin Eloy
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include <optional>
#include <string>
#include <string_view>
#include <vector>

 
namespace core {

enum class CameraFramingMode {
    WholeLevel,  
    PerRoom,     
    Follow,      
};

[[nodiscard]] std::string_view cameraFramingModeName(CameraFramingMode mode) noexcept;

[[nodiscard]] std::optional<CameraFramingMode> parseCameraFramingMode(
    std::string_view name) noexcept;

inline constexpr int DEFAULT_ROOM_WIDTH_TILES = 24;
inline constexpr int DEFAULT_ROOM_HEIGHT_TILES = 14;

struct CameraZone {
    int x = 0;
    int y = 0;
    int width = 1;
    int height = 1;
 
    [[nodiscard]] bool operator==(const CameraZone&) const noexcept = default;
};

struct CameraFramingConfig {
    CameraFramingMode mode = CameraFramingMode::WholeLevel;
    std::optional<int> roomWidthTiles;
    std::optional<int> roomHeightTiles;
    std::vector<CameraZone> zones;
 
    [[nodiscard]] bool operator==(const CameraFramingConfig&) const noexcept = default;
};

[[nodiscard]] CameraFramingConfig resolveCameraFraming(
    const std::optional<CameraFramingConfig>& declared, int levelWidth, int levelHeight) noexcept;

[[nodiscard]] std::optional<std::string> validateCameraFramingConfig(
    const CameraFramingConfig& config, int levelWidth, int levelHeight);
 
}  // namespace core