MechanismVisuals.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 <set>
#include <string>
#include <vector>
 
#include "Core/Levels/TileType.h"
#include "HMI/Graphics/AnimationCatalog.h"  // core::Animation, hmi::AnimationDescription
#include "HMI/Graphics/RenderMode.h"

 
namespace hmi {

inline constexpr const char* MECHANISM_CLIP_DOOR_CLOSED = "closed";
inline constexpr const char* MECHANISM_CLIP_DOOR_OPENING = "opening";
inline constexpr const char* MECHANISM_CLIP_DOOR_OPEN = "open";
inline constexpr const char* MECHANISM_CLIP_DOOR_CLOSING = "closing";
inline constexpr const char* MECHANISM_CLIP_SWITCH_INACTIVE = "inactive";
inline constexpr const char* MECHANISM_CLIP_SWITCH_ACTIVE = "active";
inline constexpr const char* MECHANISM_CLIP_PLATE_RELEASED = "released";
inline constexpr const char* MECHANISM_CLIP_PLATE_PRESSED = "pressed";
inline constexpr const char* MECHANISM_CLIP_KEY_PRESENT = "present";
inline constexpr const char* MECHANISM_CLIP_KEY_COLLECTED = "collected";
inline constexpr const char* MECHANISM_CLIP_LOCKED_DOOR_CLOSED = "closed";
inline constexpr const char* MECHANISM_CLIP_LOCKED_DOOR_OPEN = "open";

[[nodiscard]] bool isStatefulMechanism(core::TileType type) noexcept;

[[nodiscard]] std::optional<std::string> mechanismTargetClip(core::TileType type,
                                                             bool active) noexcept;

[[nodiscard]] std::optional<std::string> mechanismTransitionClip(core::TileType type,
                                                                 bool wasActive,
                                                                 bool isActive) noexcept;

[[nodiscard]] std::vector<std::string> mechanismExpectedClips(core::TileType type);

struct MechanismVisualState {
    core::Animation animation;
    bool previousActive = false;
    bool initialized = false;
};

[[nodiscard]] core::AtlasRegion advanceMechanismVisual(MechanismVisualState& state,
                                                       const AnimationDescription& description,
                                                       core::TileType type, bool active,
                                                       const std::string& assetKey,
                                                       float fixedDelta,
                                                       std::set<std::string>& warnedMissingClips);

[[nodiscard]] float mechanismDiagnosticAlpha(RenderMode mode, bool active, float activeAlpha,
                                             float inactiveAlpha) noexcept;
 
}  // namespace hmi