UnrealEngineUWP/Engine/Source/Editor/LevelEditor/Public/LevelViewportTabContent.h

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

#pragma once

#include "CoreMinimal.h"
#include "LevelViewportLayout.h"
#include "ViewportTabContent.h"

class ILevelEditor;

/**
 * Represents the content in a viewport tab in the level editor.
 * Each SDockTab holding viewports in the level editor contains and owns one of these.
 */
class LEVELEDITOR_API FLevelViewportTabContent : public FViewportTabContent, public TSharedFromThis<FLevelViewportTabContent>
{
public:
	/** Starts the tab content object and creates the initial layout based on the layout string */
	void Initialize(TSharedPtr<ILevelEditor> InParentLevelEditor, TSharedPtr<SDockTab> InParentTab, const FString& InLayoutString);

	/** Returns whether the tab is currently shown */
	bool IsVisible() const;

	/** Returns an array of viewports inside this tab */
	const TMap< FName, TSharedPtr< IEditorViewportLayoutEntity > >* GetViewports() const;

	/**
	 * Sets the current layout by changing the contained layout object
	 * 
	 * @param ConfigurationName		The name of the layout (for the names in namespace LevelViewportConfigurationNames)
	 */
	void SetViewportConfiguration(const FName& ConfigurationName);

	/**
	 * Refresh the current layout.
	 * @note Does not save config
	 */
	void RefreshViewportConfiguration();

	/**
	 * Returns whether the named layout is currently selected
	 *
	 * @param ConfigurationName		The name of the layout (for the names in namespace LevelViewportConfigurationNames)
	 * @return						True, if the named layout is currently active
	 */
	bool IsViewportConfigurationSet(const FName& ConfigurationName) const;

	/** @return True if this viewport belongs to the tab given */
	bool BelongsToTab(TSharedRef<class SDockTab> InParentTab) const;

	/** @return The string used to identify the layout of this viewport tab */
	const FString& GetLayoutString() const
	{
		return LayoutString;
	}

	/** Save any configuration required to persist state for this viewport layout */
	void SaveConfig() const;

private:
	/**
	 * Updates state after the layout is changed by SetViewportConfiguration()
	 */
	void UpdateViewportTabWidget();

	/**
	 * Translates layout names from namespace LevelViewportConfigurationNames into layout class and returns a new object of that class
	 *
	 * @param TypeName	FName of the layout type from those in LevelViewportConfigurationNames
	 * @param bSwitchingLayouts	If true, the new layout is replacing an existing one.
	 * @return	A new layout of the requested type.
	 */
	static TSharedPtr< class FLevelViewportLayout > ConstructViewportLayoutByTypeName(const FName& TypeName, bool bSwitchingLayouts);

private:
	TWeakPtr<ILevelEditor> ParentLevelEditor;

};