UnrealWindow.h

Go to the documentation of this file.

// Copyright (c) 2023 FrostBit Software Lab at the Lapland University of Applied Sciences
//
// This work is licensed under the terms of the MIT license.
// For a copy, see <https://opensource.org/licenses/MIT>.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Slate/SceneViewport.h"
#include "Widgets/SViewport.h"
#include "Widgets/SWindow.h"
#include "TextureResource.h"
 
#include "UnrealWindowViewportClient.h"
#include "UnrealWindowViewport.h"
 
class UWidget;
class SOverlay;
 
struct FAddedWidgetInfo
{
    UWidget* Widget;
 
    int Index;
};
 
/*
* Class for custom Unreal Engine window.
* This is used to create new window for each camera in the AGRARSENSE simulation.
* This allows to use FrameGrabber class to capture Window pixels in efficient manner.
* Otherwise we would need to use other methods of capturing the pixels (ReadPixels for example),
* which for whatever reason are extremely slow in Unreal Engine.
* See Camera.cpp for how to setup.
*/
class FUnrealWindow
{
 
public:
 
    FUnrealWindow(int32 Width, int32 Height, FString WindowName = "Camera");
 
    ~FUnrealWindow();
 
    void SetupComponent(UTextureRenderTarget2D* TextureRenderTarget);
 
    void ResizeWindow(int32 Width, int32 Height);
 
    void DestroyWindow();
 
    /*
    * Change window texture (DVSCamera)
    */
    void UpdateTexture(FTextureResource* Texture);
 
    /*
    * Draw current texture manually to screen.
    * If bool DrawToScreen is true and this is called, function will print warning and return.
    */
    void DrawManually();
 
    TSharedPtr<FSceneViewport> GetSceneViewport()
    {
        return SceneViewport;
    }
 
    TSharedPtr<SWindow> GetSWindow()
    {
        return sWindow;
    }
 
    void SetAutomaticDraw(bool Draw)
    {
        DrawToScreen = Draw;
        if (Viewport.IsValid())
        {
            Viewport->DrawToScreen = DrawToScreen;
        }
    }
 
    bool IsDrawing()
    {
        return DrawToScreen;
    }
 
    void AddUWidgetToWindow(UWidget* WidgetToAdd);
 
    void RemoveUWidgetFromWindow(UWidget* WidgetToRemove);
 
 
    int GetWindowWidth()
    {
        return WindowWidth;
    }
 
    int GetWindowHeight()
    {
        return WindowHeight;
    }
 
private:
 
    void OnWindowClosed(const TSharedRef<SWindow>& Window);
 
    int WindowWidth = 1280;
    int WindowHeight = 720;
 
    int AddedWidgetCount = 0;
 
    bool DrawToScreen = true;
 
    FOnWindowClosed onWindowClosedDelegate;
 
    TSharedPtr<FUnrealWindowViewportClient> ViewportClient;
    TSharedPtr<SUnrealWindowViewport> Viewport;
 
    TSharedPtr<FSceneViewport> SceneViewport;
    TSharedPtr<SViewport> sViewport;
    TSharedPtr<SWindow> sWindow;
 
    TSharedPtr<SOverlay> FullScreenOverlay;
 
    UPROPERTY()
    TArray<FAddedWidgetInfo> AddedWidgets;
 
};