Files
UnrealEngineUWP/Engine/Source/Developer/FunctionalTesting/Classes/ScreenshotFunctionalTestBase.h
Marc Audy d90da4ab1a Merge to Dev-Main for 4.20 @ 4090813
#rb
#rnx
#lockdown Nick.Penwarden

[CL 4091081 by Marc Audy in Main branch]
2018-05-23 21:04:31 -04:00

84 lines
2.6 KiB
C++

// Copyright 1998-2018 Epic Games, Inc. All Rights Reserved.
#pragma once
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "FunctionalTest.h"
#include "AutomationScreenshotOptions.h"
#include "Misc/AutomationTest.h"
#include "ScreenshotFunctionalTestBase.generated.h"
class FAutomationTestScreenshotEnvSetup;
/**
* Base class for screenshot functional test
*/
UCLASS(Blueprintable, abstract)
class FUNCTIONALTESTING_API AScreenshotFunctionalTestBase : public AFunctionalTest
{
GENERATED_BODY()
public:
AScreenshotFunctionalTestBase(const FObjectInitializer& ObjectInitializer);
#if WITH_EDITOR
virtual bool CanEditChange(const UProperty* InProperty) const override;
virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
virtual void Serialize(FArchive& Ar) override;
protected:
// Set player view target to screenshot camera and call PrepareForScreenshot
virtual void PrepareTest() override;
// Handle screenshot delay
virtual bool IsReady_Implementation() override;
// Register OnScreenshotTakenAndCompared and call RequestScreenshot
virtual void StartTest() override;
// Call RestoreViewport and finish this test
virtual void OnScreenshotTakenAndCompared();
// Resize viewport to screenshot size (if possible) and set up screenshot environment (disable AA, etc.)
void PrepareForScreenshot();
// Doesn't actually request in base class. It simply register OnScreenshotCaptured
virtual void RequestScreenshot();
// Pass screenshot pixels and meta data to FAutomationTestFramework. Register
// OnComparisonComplete which will be called the automation test system when
// screenshot comparison is complete
void OnScreenShotCaptured(int32 InSizeX, int32 InSizeY, const TArray<FColor>& InImageData);
// Do some logging and trigger OnScreenshotTakenAndCompared
void OnComparisonComplete(const FAutomationScreenshotCompareResults& CompareResults);
// Restore viewport size and original environment settings
void RestoreViewSettings();
protected:
UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Screenshot", meta = (MultiLine = "true"))
FString Notes;
UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Screenshot")
class UCameraComponent* ScreenshotCamera;
UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Screenshot", SimpleDisplay)
FAutomationScreenshotOptions ScreenshotOptions;
FIntPoint ViewportRestoreSize;
#if (WITH_DEV_AUTOMATION_TESTS || WITH_PERF_AUTOMATION_TESTS)
TSharedPtr<FAutomationTestScreenshotEnvSetup> ScreenshotEnvSetup;
#endif
private:
bool bNeedsViewSettingsRestore;
bool bNeedsViewportRestore;
};