EditorStatus.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Valentin Eloy
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include <cstddef>
#include <cstdint>
#include <optional>
#include <string>
#include <utility>
#include <vector>
 
#include "Core/Levels/CameraFraming.h"
#include "Core/Levels/GridPosition.h"
#include "HMI/Editor/EditorTool.h"
#include "HMI/Editor/PixelTool.h"

 
namespace hmi {
 
class Localization;

struct LevelStatusInfo {
    std::string name;                               
    bool dirty = false;                             
    EditorTool tool = EditorTool::Paint;            
    std::optional<core::GridPosition> hoveredCell;  
    float zoom = 1.0f;                              
    core::CameraFramingMode cameraFraming = core::CameraFramingMode::WholeLevel;
};

struct PlaneEditStatusInfo {
    int widthPixels = 0;           
    int heightPixels = 0;          
    int pixelsPerUnit = 16;        
    std::size_t textureBytes = 0;  
};

struct PixelEditStatusInfo {
    std::string assetName;              
    bool dirty = false;                 
    PixelTool tool = PixelTool::Brush;  
    std::optional<std::pair<int, int>> hoveredPixel;  
    int zoom = 1;                              
    std::uint32_t currentColor = 0xFF000000u;  
    bool paletteConstrained = false;           
    std::optional<PlaneEditStatusInfo> plane;
};

struct EditorStatusContext {
    std::optional<LevelStatusInfo> level;
    std::optional<PixelEditStatusInfo> pixelEdit;
};

struct EditorStatusLines {
    std::vector<std::string> permanent;
    std::string help;
};

[[nodiscard]] EditorStatusLines editorStatusLines(const EditorStatusContext& context,
                                                  const Localization& localization);
 
}  // namespace hmi