AWindowActor Class Reference

#include <WindowActor.h>

Inheritance diagram for AWindowActor:

Collaboration diagram for AWindowActor:

Public Member Functions
	AWindowActor (const FObjectInitializer &ObjectInitializer)
void	SetupWindow (int Width=1280, int Height=720, FString Title="Window", UTextureRenderTarget2D *TextureRenderTarget=nullptr)
void	SetupTextureRenderTarget (UTextureRenderTarget2D *TextureRenderTarget)
void	AddWidgetToWindow (UWidget *WidgetToAdd)
void	RemoveWidgetFromWindow (UWidget *WidgetToAdd)
void	ResizeWindow (int Width=1280, int Height=720)
TSharedPtr< FUnrealWindow >	GetUnrealWindow ()

Public Attributes
FOnWindowClosed	OnWindowClosedDelegate

Protected Member Functions
virtual void	BeginPlay () override
virtual void	EndPlay (const EEndPlayReason::Type EndPlayReason) override

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

Private Attributes
TSharedPtr< FUnrealWindow >	UnrealWindow

Detailed Description

Example Actor how to use FUnrealWindow to modify and create custom Window. Usage example: Create new blueprint based on this Actor - At blueprint BeginPlay call SetupWindow. To Add/Remove widgets call AddWidgetToWindow/RemoveWidgetFromWindow. To Resize window call ResizeWindow.

Definition at line 26 of file WindowActor.h.

Constructor & Destructor Documentation

AWindowActor()

AWindowActor::AWindowActor

(

const FObjectInitializer &

ObjectInitializer

)

Definition at line 8 of file WindowActor.cpp.

                                                                      : Super(ObjectInitializer)
{
    PrimaryActorTick.bCanEverTick = false;
}

Member Function Documentation

AddWidgetToWindow()

void AWindowActor::AddWidgetToWindow

(

UWidget *

WidgetToAdd

)

Definition at line 57 of file WindowActor.cpp.

{
    if (UnrealWindow.IsValid())
    {
        UnrealWindow->AddUWidgetToWindow(WidgetToAdd);
    }
}

References UnrealWindow.

BeginPlay()

void AWindowActor::BeginPlay ( )

overrideprotectedvirtual

Definition at line 39 of file WindowActor.cpp.

{
    Super::BeginPlay();
}

EndPlay()

void AWindowActor::EndPlay ( const EEndPlayReason::Type  EndPlayReason )

overrideprotectedvirtual

Definition at line 44 of file WindowActor.cpp.

{
    Super::EndPlay(EndPlayReason);
 
    // At EndPlay destroy Window
    if (UnrealWindow.IsValid())
    {
        OnWindowClosedDelegate.Unbind();
        UnrealWindow->DestroyWindow();
        UnrealWindow.Reset();
    }
}

References OnWindowClosedDelegate, and UnrealWindow.

GetUnrealWindow()

TSharedPtr< FUnrealWindow > AWindowActor::GetUnrealWindow ( )

inline

Definition at line 49 of file WindowActor.h.

    {
        return UnrealWindow;
    }

OnWindowClosed()

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

private

Definition at line 81 of file WindowActor.cpp.

{
    // Destroy this Actor when Window is closed
    this->Destroy();
}

References Destroy.

Referenced by SetupWindow().

RemoveWidgetFromWindow()

void AWindowActor::RemoveWidgetFromWindow

(

UWidget *

WidgetToAdd

)

Definition at line 65 of file WindowActor.cpp.

{
    if (UnrealWindow.IsValid())
    {
        UnrealWindow->RemoveUWidgetFromWindow(WidgetToAdd);
    }
}

References UnrealWindow.

ResizeWindow()

void AWindowActor::ResizeWindow	(	int	Width = 1280,
		int	Height = 720
	)

Definition at line 73 of file WindowActor.cpp.

{
    if (UnrealWindow.IsValid())
    {
        UnrealWindow->ResizeWindow(Width, Height);
    }
}

References UnrealWindow.

SetupTextureRenderTarget()

void AWindowActor::SetupTextureRenderTarget

(

UTextureRenderTarget2D *

TextureRenderTarget

)

Definition at line 31 of file WindowActor.cpp.

{
    if (UnrealWindow.IsValid())
    {
        UnrealWindow->SetupComponent(TextureRenderTarget);
    }
}

References UnrealWindow.

Referenced by SetupWindow().

SetupWindow()

void AWindowActor::SetupWindow	(	int	Width = 1280,
		int	Height = 720,
		FString	Title = "Window",
		UTextureRenderTarget2D *	TextureRenderTarget = nullptr
	)

Definition at line 13 of file WindowActor.cpp.

{
    if (!UnrealWindow.IsValid())
    {
        // Create FUnrealWindow
        UnrealWindow = MakeShareable(new FUnrealWindow(Width, Height, Title));
 
        // Setup on window closed event (user clicks Window's closed button)
        OnWindowClosedDelegate.BindUObject(this, &AWindowActor::OnWindowClosed);
        UnrealWindow->GetSWindow()->SetOnWindowClosed(OnWindowClosedDelegate);
 
        if (TextureRenderTarget) 
        {
            SetupTextureRenderTarget(TextureRenderTarget);
        }
    }
}

References OnWindowClosed(), OnWindowClosedDelegate, SetupTextureRenderTarget(), and UnrealWindow.

Member Data Documentation

OnWindowClosedDelegate

FOnWindowClosed AWindowActor::OnWindowClosedDelegate

Definition at line 54 of file WindowActor.h.

Referenced by EndPlay(), and SetupWindow().

UnrealWindow

TSharedPtr<FUnrealWindow> AWindowActor::UnrealWindow

private

Definition at line 66 of file WindowActor.h.

Referenced by AddWidgetToWindow(), EndPlay(), RemoveWidgetFromWindow(), ResizeWindow(), SetupTextureRenderTarget(), and SetupWindow().

---

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

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