UIWindow.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "Forward.hpp"
#include "CeresEngine/RenderAPI/Forward.hpp"
#include "CeresEngine/Renderer/Forward.hpp"
 
#include "UILayout.hpp"
#include "UIResponder.hpp"
#include "UIView.hpp"
#include "UIViewController.hpp"
 
#include "CeresEngine/Macros.hpp"
 
#include "CeresEngine/Input/InputManager.hpp"
#include "CeresEngine/Math/Extent.hpp"
#include "CeresEngine/Platform/PlatformWindow.hpp"
 
namespace CeresEngine {
    class UIView;
 
    enum class UIWindowState {
        NeedsDisplay = 1 << 0
    };
 
    using UIWindowStateFlags = Flags<UIWindowState>;
    CE_FLAGS_OPERATORS(UIWindowState);
 
    class UIWindow : public UIResponder, public RefCounted<UIWindow> {
    private:
        UIResponder* CE_NON_NULL mFirstResponder = this;
 
        UIViewPtr mContentView = nullptr;
 
        UIViewControllerPtr mContentViewController = nullptr;
 
        UIRect mFrame;
 
        UIAppearancePtr mAppearance = nullptr;
 
        UIWindowStateFlags mFlags = UIWindowState::NeedsDisplay;
 
        UIViewPtr mMouseDownView;
 
        UIViewPtr mPreviousHitView = nullptr;
 
        UIBackingStorePtr mBackingStore;
 
        UIWindowDevicePtr mDevice;
 
    public:
        explicit UIWindow();
        explicit UIWindow(UIWindowDevice& device);
 
        ~UIWindow() override;
 
    public:
        [[nodiscard]] const String& getTitle() const;
 
        virtual void setTitle(const String& title);
 
        [[nodiscard]] virtual UIView* CE_NULLABLE getContentView() const { return mContentView.get(); }
 
        virtual void setContentView(UIView* CE_NULLABLE contentView);
 
        [[nodiscard]] UIViewController* CE_NULLABLE getContentViewController() const { return mContentViewController.get(); }
 
        void setContentViewController(UIViewController* CE_NULLABLE contentViewController);
 
        void setContentViewController(const UIViewControllerPtr& contentViewController) { setContentViewController(contentViewController.get()); }
 
    public: // Sizing Windows
        [[nodiscard]] UIRect getFrame() const;
 
        virtual void setFrame(const UIRect& frame);
 
    public: // Layout
        void layoutIfNeeded();
 
    public: // Drawing Windows
        void display();
 
        void display(UIDrawCommandBuffer& commandBuffer);
 
        void displayIfNeeded();
 
        void displayIfNeeded(UIDrawCommandBuffer& commandBuffer);
 
        void flush();
 
        [[nodiscard]] bool getViewsNeedDisplay() const;
 
        void setViewsNeedDisplay();
 
        void setViewsNeedDisplay(bool state);
 
        [[nodiscard]] double getBackingScaleFactor() const;
 
    public: // Devices & Backing Store
        [[nodiscard]] UIWindowDevice* CE_NULLABLE getDevice() const noexcept { return mDevice.get(); }
 
        void setDevice(UIWindowDevice& device);
 
        [[nodiscard]] UIBackingStore* CE_NULLABLE getBackingStore() const noexcept { return mBackingStore.get(); }
 
        [[nodiscard]] UIBackingStorePtr createBackingStore() const;
 
    private:
        void setBackingStore(UIBackingStorePtr&& backingStore);
 
    public: // UIResponder
        [[nodiscard]] UIView* CE_NON_NULL getInitialFirstResponder() const;
 
        [[nodiscard]] UIResponder* CE_NON_NULL getFirstResponder() const;
 
        bool makeFirstResponder(UIResponder* CE_NULLABLE responder);
 
        // TODO: Write docs
        bool resignFirstResponder(const UIResponder* CE_NON_NULL responder);
 
        using UIResponder::resignFirstResponder;
 
    public: // Appearance
        [[nodiscard]] const UIAppearance& getAppearance() const noexcept;
 
        void setAppearance(UIAppearance* CE_NULLABLE appearance);
 
        static const UIAppearancePtr kDefaultAppearance;
 
    public: // Converting Coordinates
        [[nodiscard]] AffineTransform getTransformToScreen() const;
 
        [[nodiscard]] AffineTransform getTransformToBacking() const;
 
        [[nodiscard]] AffineTransform getTransformFromScreen() const;
 
        [[nodiscard]] AffineTransform getTransformFromBacking() const;
 
        [[nodiscard]] UIRect convertToScreen(const UIRect& rect) const;
 
        [[nodiscard]] UIPoint convertToScreen(const UIPoint& point) const;
 
        [[nodiscard]] UIRect convertToBacking(const UIRect& rect) const;
 
        [[nodiscard]] UIPoint convertToBacking(const UIPoint& point) const;
 
        [[nodiscard]] UIRect convertFromScreen(const UIRect& rect) const;
 
        [[nodiscard]] UIPoint convertFromScreen(const UIPoint& point) const;
 
        [[nodiscard]] UIRect convertFromBacking(const UIRect& rect) const;
 
        [[nodiscard]] UIPoint convertFromBacking(const UIPoint& point) const;
 
    public: // Handling Events
        void sendEvent(const UIEvent& event);
 
    private:
        friend class UIWindowDevice;
        void notifyFrameChanged(const UIRect& newFrame);
        void notifyBackingScaleFactorChange(double newBackingScalingFactor);
    };
 
} // namespace CeresEngine