#include <UnrealWindow.h>

Public Member Functions
	FUnrealWindow (int32 Width, int32 Height, FString WindowName="Camera", bool IsInitiallyMinized=false)

	~FUnrealWindow ()

void	SetupComponent (UTextureRenderTarget2D *TextureRenderTarget)

void	ResizeWindow (int32 Width, int32 Height)

void	DestroyWindow ()

void	UpdateTexture (FTextureResource *Texture)

void	DrawManually ()

TSharedPtr< FSceneViewport >	GetSceneViewport ()

TSharedPtr< SWindow >	GetSWindow ()

void	SetAutomaticDraw (bool Draw)

bool	IsDrawing ()

void	AddUWidgetToWindow (UWidget *WidgetToAdd)

void	RemoveUWidgetFromWindow (UWidget *WidgetToRemove)

int	GetWindowWidth ()

int	GetWindowHeight ()

Private Member Functions
void	OnWindowClosed (const TSharedRef< SWindow > &Window)

Private Attributes
int32	WindowWidth = 1280

int32	WindowHeight = 720

int32	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

TArray< FAddedWidgetInfo >	AddedWidgets

Detailed Description

Definition at line 35 of file UnrealWindow.h.

Constructor & Destructor Documentation

◆ FUnrealWindow()

FUnrealWindow::FUnrealWindow	(	int32	Width,
		int32	Height,
		FString	WindowName = `"Camera"`,
		bool	IsInitiallyMinized = `false`
	)

Create new Unreal Window

Parameters

width	width of Window
height	height of Window
windowName	Window title name

Definition at line 12 of file UnrealWindow.cpp.

{
    // Set window width and height
    WindowWidth = Width;
    WindowHeight = Height;
 
    // Do not support Window minimize button,
    // because this causes Camera sensors to stop rendering when window is minimized.
    // This is default behavior in Unreal Engine.
    bool SupportMinimize = false;
 
#ifdef EngineAllowRenderingMinimized
    // Unless when we are using AGRARSENSE Unreal Engine fork,
    // where SWindow has extra boolean which allows rendering when a window is minimized.
    SupportMinimize = true;
#endif
 
    // Create SWindow
    sWindow = SNew(SWindow)
        .Title(FText::FromString(WindowName))
        .ScreenPosition(FVector2D(0, 0))
        .ClientSize(FVector2D(WindowWidth, WindowHeight))
        .AutoCenter(EAutoCenter::PreferredWorkArea)
        .UseOSWindowBorder(true)
        .SaneWindowPlacement(false)
        .SizingRule(ESizingRule::UserSized)
        .SupportsMinimize(SupportMinimize)
#if PLATFORM_LINUX
        .FocusWhenFirstShown(IsInitiallyMinized) // only for Linux, on Windows this causes Window to be wrong size for some reason
#endif
        .IsInitiallyMinimized(IsInitiallyMinized);
        
#ifdef EngineAllowRenderingMinimized
    // Set SWindow AllowRenderingMinimized to true that allows SWindow to be rendered even when minimized.
    // Defined and implemented in AGRARSENSE Unreal Engine fork
    sWindow->AllowRenderingMinimized = true;
#endif
 
    // Add window to FSlateApplication
    FSlateApplication::Get().AddWindow(sWindow.ToSharedRef());
 
    // Assign window events delegates
    onWindowClosedDelegate.BindRaw(this, &FUnrealWindow::OnWindowClosed);
    sWindow->SetOnWindowClosed(onWindowClosedDelegate);
 
    // Create and assign viewport to window
    Viewport = SNew(SUnrealWindowViewport);
    sWindow->SetContent(Viewport.ToSharedRef());
 
    // Set references
    ViewportClient = Viewport->ViewportClient;
    SceneViewport = Viewport->SceneViewport;
    sViewport = Viewport->Viewport;
 
    // Resize window
    ResizeWindow(WindowWidth, WindowHeight);
}

References OnWindowClosed(), onWindowClosedDelegate, ResizeWindow(), SceneViewport, sViewport, sWindow, Viewport, ViewportClient, WindowHeight, and WindowWidth.

◆ ~FUnrealWindow()

FUnrealWindow::~FUnrealWindow ( )

Definition at line 70 of file UnrealWindow.cpp.

{
    onWindowClosedDelegate.Unbind();
 
    FullScreenOverlay.Reset();
    ViewportClient.Reset();
    SceneViewport.Reset();
    sViewport.Reset();
    Viewport.Reset();
    sWindow.Reset();
 
    AddedWidgets.Empty();
}

References AddedWidgets, FullScreenOverlay, onWindowClosedDelegate, SceneViewport, sViewport, sWindow, Viewport, and ViewportClient.

Member Function Documentation

◆ AddUWidgetToWindow()

void FUnrealWindow::AddUWidgetToWindow ( UWidget * WidgetToAdd )

Add a UWidget to this window.

Parameters

WidgetToAdd - The UWidget to add to this window.

Definition at line 149 of file UnrealWindow.cpp.

{
    if (!WidgetToAdd || !sWindow.IsValid())
    {
        return;
    }
 
    if (!FullScreenOverlay.IsValid())
    {
        // Create a full-screen SOverlay to contain the camera image and custom widget
        FullScreenOverlay = SNew(SOverlay);
 
        // Create a slot for current viewport widget
        FullScreenOverlay->AddSlot(0)
            .HAlign(HAlign_Fill)
            .VAlign(VAlign_Fill)
            [
                Viewport.ToSharedRef()
            ];
    }
 
    ++AddedWidgetCount;
 
    // Create a slot for the new widget
    FullScreenOverlay->AddSlot(AddedWidgetCount)
        .HAlign(HAlign_Fill)
        .VAlign(VAlign_Fill)
        [
            WidgetToAdd->TakeWidget()
        ];
 
    // Store information about the added widget
    FAddedWidgetInfo WidgetInfo;
    WidgetInfo.Widget = WidgetToAdd;
    WidgetInfo.Index = AddedWidgetCount;
    AddedWidgets.Add(WidgetInfo);
 
    // Set the updated overlay as the window content
    sWindow->SetContent(FullScreenOverlay.ToSharedRef());
}

References AddedWidgetCount, AddedWidgets, FullScreenOverlay, FAddedWidgetInfo::Index, sWindow, Viewport, and FAddedWidgetInfo::Widget.

◆ DestroyWindow()

void FUnrealWindow::DestroyWindow ( )

Destroy this Window

Definition at line 126 of file UnrealWindow.cpp.

{
    if (sWindow.IsValid())
    {
        sWindow->RequestDestroyWindow();
    }
}

References sWindow.

Referenced by OnWindowClosed().

◆ DrawManually()

void FUnrealWindow::DrawManually ( )

Definition at line 105 of file UnrealWindow.cpp.

{
    if (DrawToScreen)
    {
#if WITH_EDITOR
        UE_LOG(LogTemp, Warning, TEXT("UnrealWindow.cpp: We are already drawing automatically, we should not draw manually!"));
#endif
        return;
    }
 
    if (SceneViewport.IsValid())
    {
        SceneViewport->Draw();
    }
}

References DrawToScreen, and SceneViewport.

◆ GetSceneViewport()

TSharedPtr< FSceneViewport > FUnrealWindow::GetSceneViewport ( )

inline

Get FSceneViewport TSharedPtr

Returns: TSharedPtr<FSceneViewport>

Definition at line 83 of file UnrealWindow.h.

    {
        return SceneViewport;
    }

References SceneViewport.

◆ GetSWindow()

TSharedPtr< SWindow > FUnrealWindow::GetSWindow ( )

inline

Get SWindow TSharedPtr

Returns: TSharedPtr<SWindow>

Definition at line 92 of file UnrealWindow.h.

    {
        return sWindow;
    }

References sWindow.

◆ GetWindowHeight()

int FUnrealWindow::GetWindowHeight ( )

inline

Definition at line 138 of file UnrealWindow.h.

    {
        return WindowHeight;
    }

References WindowHeight.

◆ GetWindowWidth()

int FUnrealWindow::GetWindowWidth ( )

inline

Definition at line 133 of file UnrealWindow.h.

    {
        return WindowWidth;
    }

References WindowWidth.

◆ IsDrawing()

bool FUnrealWindow::IsDrawing ( )

inline

Check if this window is currently in the process of drawing to the screen.

Returns: True if drawing to the screen is enabled, false otherwise.

Definition at line 115 of file UnrealWindow.h.

    {
        return DrawToScreen;
    }

References DrawToScreen.

◆ OnWindowClosed()

void FUnrealWindow::OnWindowClosed ( const TSharedRef< SWindow > & Window )

private

On Window closed event from SWindow

Parameters

Window Window reference

Definition at line 121 of file UnrealWindow.cpp.

{
    DestroyWindow();
}

References DestroyWindow().

Referenced by FUnrealWindow().

◆ RemoveUWidgetFromWindow()

void FUnrealWindow::RemoveUWidgetFromWindow ( UWidget * WidgetToRemove )

Remove a UWidget from this window.

Parameters

WidgetToRemove - The UWidget to remove from this window.

Definition at line 190 of file UnrealWindow.cpp.

{
    if (!WidgetToRemove || !sWindow.IsValid() || !FullScreenOverlay.IsValid())
    {
        return;
    }
 
    // Not the prettiest but works for this use case.
    int32 WidgetIndexToRemove = -1;
    for (int32 Index = 0; Index < AddedWidgets.Num(); ++Index)
    {
        if (AddedWidgets[Index].Widget == WidgetToRemove)
        {
            WidgetIndexToRemove = Index;
            break;
        }
    }
 
    if (WidgetIndexToRemove != -1)
    {
        // Remove Widget from slot (arrays start at 0 but slot 0 is the camera view)
        FullScreenOverlay->RemoveSlot(WidgetIndexToRemove + 1);
 
        // Set the updated overlay as the window content
        sWindow->SetContent(FullScreenOverlay.ToSharedRef());
 
        // Remove the widget info from the array
        AddedWidgets.RemoveAt(WidgetIndexToRemove);
    }
}

References AddedWidgets, FullScreenOverlay, and sWindow.

◆ ResizeWindow()

void FUnrealWindow::ResizeWindow	(	int32	Width,
		int32	Height
	)

Resize Window into given size.

Parameters

width	width of Window
height	height of Window

Definition at line 134 of file UnrealWindow.cpp.

{
    if (ViewportClient.IsValid() && SceneViewport.IsValid() && sWindow.IsValid())
    {
        WindowWidth = width;
        WindowHeight = height;
 
        ViewportClient->width = WindowWidth;
        ViewportClient->height = WindowHeight;
 
        SceneViewport->SetViewportSize(WindowWidth, WindowHeight);
        sWindow->Resize(FVector2D(WindowWidth, WindowHeight));
    }
}

References SceneViewport, sWindow, ViewportClient, WindowHeight, and WindowWidth.

Referenced by FUnrealWindow().

◆ SetAutomaticDraw()

void FUnrealWindow::SetAutomaticDraw ( bool Draw )

inline

Set whether automatic drawing to the screen is enabled. If set to false, you must call DrawManually() whenever you want to draw anything to the window.

Parameters

draw	- If true, automatic drawing is enabled; if false, manual drawing is required.

Definition at line 102 of file UnrealWindow.h.

    {
        DrawToScreen = Draw;
        if (Viewport.IsValid())
        {
            Viewport->DrawToScreen = DrawToScreen;
        }
    }

References DrawToScreen, and Viewport.

◆ SetupComponent()

void FUnrealWindow::SetupComponent ( UTextureRenderTarget2D * TextureRenderTarget )

Setup UTextureRenderTarget2D in order to render to this Window

Parameters

textureRenderTarget UTextureRenderTarget2D for rendering into Window

Definition at line 84 of file UnrealWindow.cpp.

{
    if (ViewportClient.IsValid() && TextureRenderTarget)
    {
        ViewportClient->TextRenderTarget2D = TextureRenderTarget;
        ViewportClient->texture = TextureRenderTarget->GetResource();
        ViewportClient->width = WindowWidth;
        ViewportClient->height = WindowHeight;
    }
}

References ViewportClient, WindowHeight, and WindowWidth.

◆ UpdateTexture()

void FUnrealWindow::UpdateTexture ( FTextureResource * Texture )

Definition at line 95 of file UnrealWindow.cpp.

{
    if (ViewportClient.IsValid() && Texture)
    {
        ViewportClient->texture = Texture;
        ViewportClient->width = WindowWidth;
        ViewportClient->height = WindowHeight;
    }
}

References ViewportClient, WindowHeight, and WindowWidth.

Member Data Documentation

◆ AddedWidgetCount

int32 FUnrealWindow::AddedWidgetCount = 0

private

Definition at line 154 of file UnrealWindow.h.

Referenced by AddUWidgetToWindow().

◆ AddedWidgets

TArray<FAddedWidgetInfo> FUnrealWindow::AddedWidgets

private

Definition at line 170 of file UnrealWindow.h.

Referenced by AddUWidgetToWindow(), RemoveUWidgetFromWindow(), and ~FUnrealWindow().

◆ DrawToScreen

bool FUnrealWindow::DrawToScreen = true

private

Definition at line 156 of file UnrealWindow.h.

Referenced by DrawManually(), IsDrawing(), and SetAutomaticDraw().

◆ FullScreenOverlay

TSharedPtr<SOverlay> FUnrealWindow::FullScreenOverlay

private

Definition at line 167 of file UnrealWindow.h.

Referenced by AddUWidgetToWindow(), RemoveUWidgetFromWindow(), and ~FUnrealWindow().

◆ onWindowClosedDelegate

FOnWindowClosed FUnrealWindow::onWindowClosedDelegate

private

Definition at line 158 of file UnrealWindow.h.

Referenced by FUnrealWindow(), and ~FUnrealWindow().

◆ SceneViewport

TSharedPtr<FSceneViewport> FUnrealWindow::SceneViewport

private

Definition at line 163 of file UnrealWindow.h.

Referenced by DrawManually(), FUnrealWindow(), GetSceneViewport(), ResizeWindow(), and ~FUnrealWindow().

◆ sViewport

TSharedPtr<SViewport> FUnrealWindow::sViewport

private

Definition at line 164 of file UnrealWindow.h.

Referenced by FUnrealWindow(), and ~FUnrealWindow().

◆ sWindow

TSharedPtr<SWindow> FUnrealWindow::sWindow

private

Definition at line 165 of file UnrealWindow.h.

Referenced by AddUWidgetToWindow(), DestroyWindow(), FUnrealWindow(), GetSWindow(), RemoveUWidgetFromWindow(), ResizeWindow(), and ~FUnrealWindow().

◆ Viewport

TSharedPtr<SUnrealWindowViewport> FUnrealWindow::Viewport

private

Definition at line 161 of file UnrealWindow.h.

Referenced by AddUWidgetToWindow(), FUnrealWindow(), SetAutomaticDraw(), and ~FUnrealWindow().

◆ ViewportClient

TSharedPtr<FUnrealWindowViewportClient> FUnrealWindow::ViewportClient

private

Definition at line 160 of file UnrealWindow.h.

Referenced by FUnrealWindow(), ResizeWindow(), SetupComponent(), UpdateTexture(), and ~FUnrealWindow().

◆ WindowHeight

int32 FUnrealWindow::WindowHeight = 720

private

Definition at line 152 of file UnrealWindow.h.

Referenced by FUnrealWindow(), GetWindowHeight(), ResizeWindow(), SetupComponent(), and UpdateTexture().

◆ WindowWidth

int32 FUnrealWindow::WindowWidth = 1280

private

Definition at line 151 of file UnrealWindow.h.

Referenced by FUnrealWindow(), GetWindowWidth(), ResizeWindow(), SetupComponent(), and UpdateTexture().

The documentation for this class was generated from the following files:

Unreal/Agrarsense/Source/Agrarsense/UnrealWindow/UnrealWindow.h
Unreal/Agrarsense/Source/Agrarsense/UnrealWindow/UnrealWindow.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FUnrealWindow()

◆ ~FUnrealWindow()

Member Function Documentation

◆ AddUWidgetToWindow()

◆ DestroyWindow()

◆ DrawManually()

◆ GetSceneViewport()

◆ GetSWindow()

◆ GetWindowHeight()

◆ GetWindowWidth()

◆ IsDrawing()

◆ OnWindowClosed()

◆ RemoveUWidgetFromWindow()

◆ ResizeWindow()

◆ SetAutomaticDraw()

◆ SetupComponent()

◆ UpdateTexture()

Member Data Documentation

◆ AddedWidgetCount

◆ AddedWidgets

◆ DrawToScreen

◆ FullScreenOverlay

◆ onWindowClosedDelegate

◆ SceneViewport

◆ sViewport

◆ sWindow

◆ Viewport

◆ ViewportClient

◆ WindowHeight

◆ WindowWidth