ImguiHelp.h

Go to the documentation of this file.

/**
* @file ImguiHelp.h
* @brief The ImguiHelp Class Definitions.
* @author Spices.
*/
 
#pragma once
#include "Core/Core.h"
#include "Slate/Imgui/ImguiUtils.h"
 
namespace Spices {
 
    /**
    * @brief Forward Declare.
    */
    class ImguiAbout;
 
    /**
    * @brief The ImguiHelp Class.
    * This class defines how to render a Help.
    */
    class ImguiHelp : public ImguiSlate
    {
    public:
 
        /**
        * @brief Constructor Function.
        * @param[in] panelName The Slate's name to show.
        * @param[in] frameInfo The Frame Date that in use.
        */
        ImguiHelp(
            const std::string& panelName ,
            FrameInfo&         frameInfo
        );
 
        /**
        * @brief Destructor Function.
        */
        virtual ~ImguiHelp() override = default;
 
        /**
        * @brief This interface is called On SlateSystem Update.
        * @param[in] ts TimeStep.
        */
        virtual void OnUpdate(TimeStep& ts) override {};
 
        /**
        * @brief This interface is called On SlateRenderer Render.
        */
        virtual void OnRender() override;
 
        /**
        * @brief This interface is called On Global Event Function Pointer is called.
        */
        virtual void OnEvent(Event& event) override {};
 
    private:
 
        /**
        * @brief The shared pointer of ImguiAbout.
        */
        std::shared_ptr<ImguiAbout> m_About;
    };
}