UnrealEngineUWP/Engine/Source/Editor/AdvancedPreviewScene/Public/AssetViewerSettings.h

// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "UObject/SoftObjectPtr.h"
#include "UObject/ObjectRedirector.h"
#include "Engine/Scene.h"
#include "Engine/TextureCube.h"
#include "EditorUndoClient.h"
#include "AssetViewerSettings.generated.h"

/**
* Preview scene profile settings structure.
*/
USTRUCT()
struct FPreviewSceneProfile
{
	GENERATED_BODY()

	FPreviewSceneProfile()
	{		
		bSharedProfile = false;
		bUseSkyLighting = true;
		bShowFloor = true;
		bShowEnvironment = true;
		bRotateLightingRig = false;
		DirectionalLightIntensity = 1.0f;
		DirectionalLightColor = FLinearColor::White;
		SkyLightIntensity = 1.0f;
		LightingRigRotation = 0.0f;
		RotationSpeed = 2.0f;
		EnvironmentIntensity = 1.0f;
		EnvironmentColor = FLinearColor(0.2f, 0.2f, 0.2f, 1.0f);
		// Set up default cube map texture from editor/engine textures
		EnvironmentCubeMap = nullptr;
		EnvironmentCubeMapPath = TEXT("/Engine/EditorMaterials/AssetViewer/EpicQuadPanorama_CC+EV1.EpicQuadPanorama_CC+EV1");
		bPostProcessingEnabled = true;
		DirectionalLightRotation = FRotator(-40.f, -67.5f, 0.f);
	}

	/** Name to identify the profile */
	UPROPERTY(EditAnywhere, config, Category=Profile)
	FString ProfileName;

	/** Whether or not this profile should be stored in the Project ini file */
	UPROPERTY(EditAnywhere, config, Category = Profile)
	bool bSharedProfile;

	/** Whether or not image based lighting is enabled for the environment cube map */
	UPROPERTY(EditAnywhere, AdvancedDisplay, config, Category = Lighting)
	bool bUseSkyLighting;

	/** Manually set the directional light intensity (0.0 - 20.0) */
	UPROPERTY(EditAnywhere, config, Category = Lighting, meta = (UIMin = "0.0", UIMax = "20.0"))
	float DirectionalLightIntensity;

	/** Manually set the directional light colour */
	UPROPERTY(EditAnywhere, config, Category = Lighting)
	FLinearColor DirectionalLightColor;
	
	/** Manually set the sky light intensity (0.0 - 20.0) */
	UPROPERTY(EditAnywhere, config, Category = Lighting, meta = (UIMin = "0.0", UIMax = "20.0"))
	float SkyLightIntensity;

	/** Toggle rotating of the sky and directional lighting, press K and drag for manual rotating of Sky and L for Directional lighting */
	UPROPERTY(EditAnywhere, config, Category = Lighting, meta = (DisplayName = "Rotate Sky and Directional Lighting"))
	bool bRotateLightingRig;
	
	/** Toggle visibility of the environment sphere */
	UPROPERTY(EditAnywhere, config, Category = Environment)
	bool bShowEnvironment;

	/** Toggle visibility of the floor mesh */
	UPROPERTY(EditAnywhere, config, Category = Environment)
	bool bShowFloor;

	/** The environment color, used if Show Environment is false. */
	UPROPERTY(EditAnywhere, config, Category = Environment, meta=(EditCondition="!bShowEnvironment"))
	FLinearColor EnvironmentColor;
	
	/** The environment intensity (0.0 - 20.0), used if Show Environment is false. */
	UPROPERTY(EditAnywhere, config, Category = Lighting, meta = (UIMin = "0.0", UIMax = "20.0", EditCondition="!bShowEnvironment"))
	float EnvironmentIntensity;

	/** Sets environment cube map used for sky lighting and reflections */
	UPROPERTY(EditAnywhere, transient, Category = Environment)
	TSoftObjectPtr<UTextureCube> EnvironmentCubeMap;

	/** Storing path to environment cube to prevent it from getting cooked */
	UPROPERTY(config)
	FString EnvironmentCubeMapPath;

	/** Whether or not the Post Processing should influence the scene */
	UPROPERTY(EditAnywhere, config, Category = PostProcessing, AdvancedDisplay)
	bool bPostProcessingEnabled;

	/** Manual set post processing settings */
	UPROPERTY(EditAnywhere, config, Category = PostProcessing, AdvancedDisplay, meta=(ShowOnlyInnerProperties))
	FPostProcessSettings PostProcessingSettings;

	/** Current rotation value of the sky in degrees (0 - 360) */
	UPROPERTY(EditAnywhere, config, Category = Lighting, meta = (UIMin = "0", UIMax = "360"), AdvancedDisplay)
	float LightingRigRotation;

	/** Speed at which the sky rotates when rotating is toggled */
	UPROPERTY(EditAnywhere, config, Category = Lighting, AdvancedDisplay)
	float RotationSpeed;

	/** Rotation for directional light */
	UPROPERTY(config)
	FRotator DirectionalLightRotation;

	/** Retrieve the environment map texture using the saved path */
	void LoadEnvironmentMap()
	{
		if (EnvironmentCubeMap == nullptr)
		{
			if (!EnvironmentCubeMapPath.IsEmpty())
			{
				// Load cube map from stored path
				UObject* LoadedObject = LoadObject<UObject>(nullptr, *EnvironmentCubeMapPath);
				while (UObjectRedirector* Redirector = Cast<UObjectRedirector>(LoadedObject))
				{
					LoadedObject = Redirector->DestinationObject;
				}

				EnvironmentCubeMap = LoadedObject;
			}
		}		
	}
};


UCLASS(config = Editor)
class ULocalProfiles : public UObject
{
	GENERATED_BODY()
public:
	/** Collection of local scene profiles */
	UPROPERTY(config)
	TArray<FPreviewSceneProfile> Profiles;
};

UCLASS(config = Editor, defaultconfig )
class USharedProfiles : public UObject
{
	GENERATED_BODY()
public:
	/** Collection of shared scene profiles */
	UPROPERTY(config)
	TArray<FPreviewSceneProfile> Profiles;
};

/**
* Default asset viewer settings.
*/
UCLASS(config=Editor, meta=(DisplayName = "Asset Viewer"))
class ADVANCEDPREVIEWSCENE_API UAssetViewerSettings : public UObject, public FEditorUndoClient
{
	GENERATED_BODY()
public:
	UAssetViewerSettings();
	virtual ~UAssetViewerSettings();

	static UAssetViewerSettings* Get();
	
	/**
	 * Saves the config data out to the ini files
	 * @param bWarnIfFail Should we log a warning if a ini file couldn't be saved.
	 */
	void Save(bool bWarnIfFail = true);

	DECLARE_EVENT_OneParam(UAssetViewerSettings, FOnAssetViewerSettingsChangedEvent, const FName&);
	FOnAssetViewerSettingsChangedEvent& OnAssetViewerSettingsChanged() { return OnAssetViewerSettingsChangedEvent; }

	DECLARE_EVENT(UAssetViewerSettings, FOnAssetViewerProfileAddRemovedEvent);
	FOnAssetViewerProfileAddRemovedEvent& OnAssetViewerProfileAddRemoved() { return OnAssetViewerProfileAddRemovedEvent; }

	DECLARE_EVENT(UAssetViewerSettings, FOnAssetViewerSettingsPostUndo);
	FOnAssetViewerSettingsPostUndo& OnAssetViewerSettingsPostUndo() { return OnAssetViewerSettingsPostUndoEvent; }

	/** Begin UObject */
	virtual void PostEditChangeProperty(struct FPropertyChangedEvent& PropertyChangedEvent) override;
	virtual void PostInitProperties() override;
	/** End UObject */

	/** Begin FEditorUndoClient */
	virtual void PostUndo(bool bSuccess) override;
	virtual void PostRedo(bool bSuccess) override;
	/** End FEditorUndoClient */

	/** Collection of scene profiles */
	UPROPERTY(EditAnywhere, transient, Category = Settings, meta=(ShowOnlyInnerProperties))
	TArray<FPreviewSceneProfile> Profiles;

	/** Cached value to determine whether or not a profile was added or removed */
	int32 NumProfiles;
protected:
	/** Broadcasts after an scene profile was added or deleted from the asset viewer singleton instance */
	FOnAssetViewerSettingsChangedEvent OnAssetViewerSettingsChangedEvent;

	FOnAssetViewerProfileAddRemovedEvent OnAssetViewerProfileAddRemovedEvent;

	FOnAssetViewerSettingsPostUndo OnAssetViewerSettingsPostUndoEvent;

	// This will enforce mutable CDO of UAssetViewerSettings transacted
	UPROPERTY(Config)
	bool bFakeConfigValue_HACK;
};