GUI.h

Go to the documentation of this file.

/*
   Copyright (c) 2018 DIVIDE-Studio
   Copyright (c) 2009 Ionut Cava
 
   This file is part of DIVIDE Framework.
 
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software
   and associated documentation files (the "Software"), to deal in the Software
   without restriction,
   including without limitation the rights to use, copy, modify, merge, publish,
   distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so,
   subject to the following conditions:
 
   The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software.
 
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED,
   INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
   PARTICULAR PURPOSE AND NONINFRINGEMENT.
   IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
   DAMAGES OR OTHER LIABILITY,
   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
   IN CONNECTION WITH THE SOFTWARE
   OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 */
 
#pragma once
#ifndef GUI_H_
#define GUI_H_
 
#include "GUIInterface.h"
#include "Core/Headers/FrameListener.h"
#include "Core/Headers/KernelComponent.h"
#include "GUI/CEGUIAddons/Headers/CEGUIInput.h"
#include "Platform/Video/Headers/PushConstants.h"
#include "Platform/Video/Textures/Headers/Texture.h"
#include "Platform/Input/Headers/InputAggregatorInterface.h"
namespace CEGUI
{
    class CEGUIRenderer;
    class DVDTextureTarget;
};
 
struct FONScontext;
 
namespace Divide
{
 
namespace GFX
{
    class CommandBuffer;
    struct MemoryBarrierCommand;
};
 
class Scene;
class Pipeline;
class GUIConsole;
class GUIElement;
class ShaderProgram;
class ResourceCache;
class SceneGraphNode;
class PlatformContext;
class SceneGUIElements;
 
struct ImageView;
struct TextElementBatch;
struct SizeChangeParams;
 
FWD_DECLARE_MANAGED_STRUCT( DVDFONSContext );
 
class GUI final : public GUIInterface,
                  public KernelComponent,
                  public FrameListener,
                  public Input::InputAggregatorInterface
{
    public:
        using GUIMapPerScene = hashMap<I64, SceneGUIElements*>;
 
    public:
        explicit GUI( Kernel& parent );
        ~GUI() override;
 
        [[nodiscard]] ErrorCode init( PlatformContext& context );
        void destroy();
 
        void preDraw( GFXDevice& context, const Rect<I32>& viewport, GFX::CommandBuffer& bufferInOut, GFX::MemoryBarrierCommand& memCmdInOut );
        void draw( GFXDevice& context, const Rect<I32>& viewport, GFX::CommandBuffer& bufferInOut, GFX::MemoryBarrierCommand& memCmdInOut );
        void drawText( const TextElementBatch& batch, const Rect<I32>& targetViewport, GFX::CommandBuffer& bufferInOut, GFX::MemoryBarrierCommand& memCmdInOut, bool pushCamera = true);
        void onResolutionChange( const SizeChangeParams& params );
        void onChangeScene( Scene* newScene );
        void onUnloadScene( Scene* scene );
        void update( U64 deltaTimeUS );
        template <typename T> requires std::is_base_of_v<GUIElement, T>
        [[nodiscard]] T* getSceneGUIElementImpl( const I64 sceneID, const U64 elementName ) { return static_cast<T*>(getSceneGUIElementImpl( sceneID, elementName, T::Type )); }
        template <typename T> requires std::is_base_of_v<GUIElement, T>
        [[nodiscard]] T* getSceneGUIElementImpl( const I64 sceneID, const I64 elementID ) { return static_cast<T*>(getSceneGUIElementImpl( sceneID, elementID, T::Type )); }
        [[nodiscard]] GUIConsole& getConsole() noexcept { return *_console; }
        [[nodiscard]] const GUIConsole& getConsole() const noexcept { return *_console; }
        [[nodiscard]] CEGUI::Window* rootSheet() const noexcept { return _rootSheet; }
        [[nodiscard]] GUIMessageBox* getDefaultMessageBox() const noexcept { return _defaultMsgBox.get(); }
        void setCursorPosition( I32 x, I32 y );
        [[nodiscard]] CEGUI::GUIContext* getCEGUIContext() noexcept;
        void showDebugCursor( bool state );
        PROPERTY_R( bool, showDebugCursor, false );
        PROPERTY_R( string, defaultGUIScheme, "GWEN" );
        PROPERTY_RW( U64, textRenderInterval, Time::MillisecondsToMicroseconds( 10 ) );
 
 
    protected:
         bool frameStarted( const FrameEvent& evt ) override;
 
        [[nodiscard]] bool onKeyDown( const Input::KeyEvent& key ) override;
        [[nodiscard]] bool onKeyUp( const Input::KeyEvent& key ) override;
        [[nodiscard]] bool joystickAxisMoved( const Input::JoystickEvent& arg ) override;
        [[nodiscard]] bool joystickPovMoved( const Input::JoystickEvent& arg ) override;
        [[nodiscard]] bool joystickButtonPressed( const Input::JoystickEvent& arg ) override;
        [[nodiscard]] bool joystickButtonReleased( const Input::JoystickEvent& arg ) override;
        [[nodiscard]] bool joystickBallMoved( const Input::JoystickEvent& arg ) override;
        [[nodiscard]] bool joystickAddRemove( const Input::JoystickEvent& arg ) override;
        [[nodiscard]] bool joystickRemap( const Input::JoystickEvent& arg ) override;
        [[nodiscard]] bool mouseMoved( const Input::MouseMoveEvent& arg ) override;
        [[nodiscard]] bool mouseButtonPressed( const Input::MouseButtonEvent& arg ) override;
        [[nodiscard]] bool mouseButtonReleased( const Input::MouseButtonEvent& arg ) override;
        [[nodiscard]] bool onTextEvent( const Input::TextEvent& arg ) noexcept override;
 
    private:
        [[nodiscard]] I32 getFont( const Str<64>& fontName );
        [[nodiscard]] GUIElement* getSceneGUIElementImpl( I64 sceneID, U64 elementName, GUIType type ) const;
        [[nodiscard]] GUIElement* getSceneGUIElementImpl( I64 sceneID, I64 elementID, GUIType type ) const;
        void recreateDefaultMessageBox();
 
    protected:
        friend class SceneGUIElements;
        CEGUI::Window* _rootSheet{nullptr};
        CEGUI::GUIContext* _ceguiContext{nullptr};
 
    private:
        bool _init{false};
        CEGUIInput _ceguiInput;  
        CEGUI::CEGUIRenderer* _ceguiRenderer{ nullptr };
        CEGUI::DVDTextureTarget* _renderTextureTarget{nullptr};
        std::unique_ptr<GUIConsole> _console;
        std::unique_ptr<GUIMessageBox> _defaultMsgBox;
        Scene* _activeScene{nullptr};
        GUIMapPerScene _guiStack{};
        mutable SharedMutex _guiStackLock{};
        DVDFONSContext_uptr _fonsContext;
        hashMap<U64, I32> _fonts;
        hashAlg::pair<Str<64>, I32> _fontCache = { "", -1 };
        Pipeline* _textRenderPipeline{nullptr};
        Handle<ShaderProgram> _textRenderShader = INVALID_HANDLE<ShaderProgram>;
        Handle<ShaderProgram> _ceguiRenderShader = INVALID_HANDLE<ShaderProgram>;
    };
 
};  // namespace Divide
#endif