#pragma once #include #include #include #include #include #include namespace hex { class TutorialManager { public: enum class Position : u8 { None = 0, Top = 1, Bottom = 2, Left = 4, Right = 8 }; struct Tutorial { Tutorial() = delete; Tutorial(const UnlocalizedString &unlocalizedName, const UnlocalizedString &unlocalizedDescription) : m_unlocalizedName(unlocalizedName), m_unlocalizedDescription(unlocalizedDescription) { } struct Step { explicit Step(Tutorial *parent) : m_parent(parent) { } /** * @brief Adds a highlighting with text to a specific element * @param unlocalizedText Unlocalized text to display next to the highlighting * @param ids ID of the element to highlight * @return Current step */ Step& addHighlight(const UnlocalizedString &unlocalizedText, std::initializer_list> &&ids); /** * @brief Adds a highlighting to a specific element * @param ids ID of the element to highlight * @return Current step */ Step& addHighlight(std::initializer_list> &&ids); /** * @brief Sets the text that will be displayed in the tutorial message box * @param unlocalizedTitle Title of the message box * @param unlocalizedMessage Main message of the message box * @param position Position of the message box * @return Current step */ Step& setMessage(const UnlocalizedString &unlocalizedTitle, const UnlocalizedString &unlocalizedMessage, Position position = Position::None); /** * @brief Allows this step to be skipped by clicking on the advance button * @return Current step */ Step& allowSkip(); Step& onAppear(std::function callback); Step& onComplete(std::function callback); /** * @brief Checks if this step is the current step * @return True if this step is the current step */ bool isCurrent() const; /** * @brief Completes this step if it is the current step */ void complete() const; private: struct Highlight { UnlocalizedString unlocalizedText; std::vector> highlightIds; }; struct Message { Position position; UnlocalizedString unlocalizedTitle; UnlocalizedString unlocalizedMessage; bool allowSkip; }; private: void addHighlights() const; void removeHighlights() const; void advance(i32 steps = 1) const; friend class TutorialManager; Tutorial *m_parent; std::vector m_highlights; std::optional m_message; std::function m_onAppear, m_onComplete; }; Step& addStep(); const UnlocalizedString& getUnlocalizedName() const { return m_unlocalizedName; } const UnlocalizedString& getUnlocalizedDescription() const { return m_unlocalizedDescription; } private: friend class TutorialManager; void start(); UnlocalizedString m_unlocalizedName; UnlocalizedString m_unlocalizedDescription; std::list m_steps; decltype(m_steps)::iterator m_currentStep, m_latestStep; }; static void init(); /** * @brief Gets a list of all tutorials * @return List of all tutorials */ static const std::map& getTutorials(); /** * @brief Gets the currently running tutorial * @return Iterator pointing to the current tutorial */ static std::map::iterator getCurrentTutorial(); /** * @brief Creates a new tutorial that can be started later * @param unlocalizedName Name of the tutorial * @param unlocalizedDescription * @return Reference to created tutorial */ static Tutorial& createTutorial(const UnlocalizedString &unlocalizedName, const UnlocalizedString &unlocalizedDescription); /** * @brief Starts the tutorial with the given name * @param unlocalizedName Name of tutorial to start */ static void startTutorial(const UnlocalizedString &unlocalizedName); static void startHelpHover(); static void addInteractiveHelpText(std::initializer_list> &&ids, UnlocalizedString unlocalizedString); static void addInteractiveHelpLink(std::initializer_list> &&ids, std::string link); /** * @brief Draws the tutorial * @note This function should only be called by the main GUI */ static void drawTutorial(); /** * @brief Resets the tutorial manager */ static void reset(); private: TutorialManager() = delete; static void drawHighlights(); static void drawMessageBox(std::optional message); }; inline TutorialManager::Position operator|(TutorialManager::Position a, TutorialManager::Position b) { return static_cast(static_cast(a) | static_cast(b)); } inline TutorialManager::Position operator&(TutorialManager::Position a, TutorialManager::Position b) { return static_cast(static_cast(a) & static_cast(b)); } }