#include <ProjectManager.h>

Inheritance diagram for ProjectManager:

Public Member Functions
	ProjectManager (QObject *parent=nullptr)

void	initialize () override

void	reset () override

void	newProject (const QString &workspaceFilePath="") override

void	newProject (const Qt::AlignmentFlag &alignment, bool logging=false) override

void	newBlankProject () override

void	openProject (QString filePath="", bool importDataOnly=false, bool loadWorkspace=true) override

void	importProject (QString filePath="") override

void	saveProject (QString filePath="", const QString &password="") override

void	saveProjectAs () override

void	publishProject (QString filePath="") override

bool	hasProject () const override

const hdps::Project *	getCurrentProject () const override

hdps::Project *	getCurrentProject () override

QString	extractProjectFileFromHdpsFile (const QString &hdpsFilePath, QTemporaryDir &temporaryDir) override

QImage	getPreviewImage (const QString &projectFilePath, const QSize &targetSize=QSize(500, 500)) const override

void	fromVariantMap (const QVariantMap &variantMap) override

QVariantMap	toVariantMap () const override

QMenu &	getNewProjectMenu () override

QMenu &	getImportDataMenu () override

hdps::gui::TriggerAction &	getNewBlankProjectAction () override

hdps::gui::TriggerAction &	getNewProjectFromWorkspaceAction () override

hdps::gui::TriggerAction &	getOpenProjectAction () override

hdps::gui::TriggerAction &	getImportProjectAction () override

hdps::gui::TriggerAction &	getSaveProjectAction () override

hdps::gui::TriggerAction &	getSaveProjectAsAction () override

hdps::gui::TriggerAction &	getEditProjectSettingsAction () override

hdps::gui::RecentFilesAction &	getRecentProjectsAction () override

hdps::gui::TriggerAction &	getPublishAction () override

hdps::gui::TriggerAction &	getPluginManagerAction () override

hdps::gui::ToggleAction &	getShowStartPageAction () override

Public Member Functions inherited from hdps::AbstractProjectManager
	AbstractProjectManager (QObject *parent=nullptr)

virtual State	getState () const final

virtual void	setState (const State &state) final

virtual bool	isOpeningProject () const final

virtual bool	isImportingProject () const final

virtual bool	isSavingProject () const final

virtual bool	isPublishingProject () const final

Public Member Functions inherited from hdps::AbstractManager
	AbstractManager (QObject *parent=nullptr, const QString &name="")

virtual void	beginReset () final

virtual void	endReset () final

virtual void	beginInitialization () final

virtual void	endInitialization () final

virtual bool	isInitialized () const final

virtual QIcon	getIcon () const

gui::LockingAction &	getLockingAction ()

virtual bool	mayLock () const

virtual bool	mayUnlock () const

Public Member Functions inherited from hdps::util::Serializable
	Serializable (const QString &serializationName="")

virtual QString	getId () const final

virtual void	setId (const QString &id) final

virtual QString	getSerializationName () const final

virtual void	setSerializationName (const QString &serializationName) final

virtual void	fromParentVariantMap (const QVariantMap &parentVariantMap)

virtual void	insertIntoVariantMap (QVariantMap &variantMap) const final

virtual void	fromJsonDocument (const QJsonDocument &jsonDocument) final

virtual QJsonDocument	toJsonDocument () const final

virtual void	fromJsonFile (const QString &filePath="") final

virtual void	toJsonFile (const QString &filePath="") final

virtual void	makeUnique () final

Additional Inherited Members
Public Types inherited from hdps::AbstractProjectManager
enum class	State { Idle , OpeningProject , ImportingProject , SavingProject , PublishingProject }

Public Types inherited from hdps::util::Serializable
enum class	State { Idle , Reading , Writing }

Signals inherited from hdps::AbstractProjectManager
void	projectAboutToBeCreated ()

void	projectCreated (const hdps::Project &project)

void	projectDestroyed (const QString &projectId)

void	projectAboutToBeOpened (const hdps::Project &project)

void	projectOpened (const hdps::Project &project)

void	projectAboutToBeImported (const QString &filePath)

void	projectImported (const QString &filePath)

void	projectAboutToBeSaved (const hdps::Project &project)

void	projectSaved (const hdps::Project &project)

void	projectAboutToBePublished (const hdps::Project &project)

void	projectPublished (const hdps::Project &project)

void	projectAboutToBeDestroyed (const hdps::Project &project)

void	stateChanged (const State &state)

Signals inherited from hdps::AbstractManager
void	managerAboutToBeInitialized ()

void	managerInitialized ()

void	managerAboutToBeReset ()

void	managerReset ()

Static Public Member Functions inherited from hdps::util::Serializable
static QString	createId ()

Static Protected Member Functions inherited from hdps::util::Serializable
static void	fromVariantMap (Serializable *serializable, const QVariantMap &variantMap)

static void	fromVariantMap (Serializable &serializable, const QVariantMap &variantMap, const QString &key)

static QVariantMap	toVariantMap (const Serializable *serializable)

static void	insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap, const QString &key)

static void	insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap)

Detailed Description

Project class

Class for managing the creation/loading/saving of projects and contains a single project instance.

Author: Thomas Kroes

Constructor & Destructor Documentation

◆ ProjectManager()

ProjectManager::ProjectManager ( QObject * parent = nullptr )

Creates a new project manager from with parent object

Parameters

parent Pointer to parent object

Member Function Documentation

◆ extractProjectFileFromHdpsFile()

QString ProjectManager::extractProjectFileFromHdpsFile	(	const QString &	hdpsFilePath,
		QTemporaryDir &	temporaryDir
	)

overridevirtual

Extract the project JSON file (project.json) from a compressed HDPS file (*.hdps)

Parameters

hdpsFilePath	File path of the compressed HDPS file (*.hdps)
temporaryDir	Temporary directory to store the project.json file

Returns: File path of the extracted project.json file, empty string if extraction failed

Implements hdps::AbstractProjectManager.

◆ fromVariantMap()

void ProjectManager::fromVariantMap ( const QVariantMap & variantMap )

overridevirtual

Load widget action from variant

Parameters

Variant representation of the widget action

Reimplemented from hdps::util::Serializable.

◆ getCurrentProject() [1/2]

const hdps::Project * ProjectManager::getCurrentProject ( ) const

overridevirtual

Get current project

Returns: Pointer to current project (nullptr if no project is loaded)

Implements hdps::AbstractProjectManager.

◆ getCurrentProject() [2/2]

hdps::Project * ProjectManager::getCurrentProject ( )

overridevirtual

Get current project

Returns: Pointer to current project (nullptr if no project is loaded)

Implements hdps::AbstractProjectManager.

◆ getEditProjectSettingsAction()

hdps::gui::TriggerAction & ProjectManager::getEditProjectSettingsAction ( )

inlineoverridevirtual

Implements hdps::AbstractProjectManager.

◆ getImportDataMenu()

QMenu & ProjectManager::getImportDataMenu ( )

overridevirtual

Get import data menu

Returns: Pointer to import data menu

Implements hdps::AbstractProjectManager.

◆ getImportProjectAction()

hdps::gui::TriggerAction & ProjectManager::getImportProjectAction ( )

inlineoverridevirtual

Implements hdps::AbstractProjectManager.

◆ getNewBlankProjectAction()

hdps::gui::TriggerAction & ProjectManager::getNewBlankProjectAction ( )

inlineoverridevirtual

Implements hdps::AbstractProjectManager.

◆ getNewProjectFromWorkspaceAction()

hdps::gui::TriggerAction & ProjectManager::getNewProjectFromWorkspaceAction ( )

inlineoverridevirtual

Implements hdps::AbstractProjectManager.

◆ getNewProjectMenu()

QMenu & ProjectManager::getNewProjectMenu ( )

overridevirtual

Get new project menu

Returns: Pointer to new project menu

Implements hdps::AbstractProjectManager.

◆ getOpenProjectAction()

hdps::gui::TriggerAction & ProjectManager::getOpenProjectAction ( )

inlineoverridevirtual

Implements hdps::AbstractProjectManager.

◆ getPluginManagerAction()

hdps::gui::TriggerAction & ProjectManager::getPluginManagerAction ( )

inlineoverridevirtual

Implements hdps::AbstractProjectManager.

◆ getPreviewImage()

QImage ProjectManager::getPreviewImage	(	const QString &	projectFilePath,
		const QSize &	targetSize = `QSize(500, 500)`
	)		const

overridevirtual

Get preview image of the project

Parameters

projectFilePath Path of the project file

Returns: Preview image

Implements hdps::AbstractProjectManager.

◆ getPublishAction()

hdps::gui::TriggerAction & ProjectManager::getPublishAction ( )

inlineoverridevirtual

Implements hdps::AbstractProjectManager.

◆ getRecentProjectsAction()

hdps::gui::RecentFilesAction & ProjectManager::getRecentProjectsAction ( )

inlineoverridevirtual

Implements hdps::AbstractProjectManager.

◆ getSaveProjectAction()

hdps::gui::TriggerAction & ProjectManager::getSaveProjectAction ( )

inlineoverridevirtual

Implements hdps::AbstractProjectManager.

◆ getSaveProjectAsAction()

hdps::gui::TriggerAction & ProjectManager::getSaveProjectAsAction ( )

inlineoverridevirtual

Implements hdps::AbstractProjectManager.

◆ getShowStartPageAction()

hdps::gui::ToggleAction & ProjectManager::getShowStartPageAction ( )

inlineoverridevirtual

Implements hdps::AbstractProjectManager.

◆ hasProject()

bool ProjectManager::hasProject ( ) const

overridevirtual

Get whether a project exists

Returns: Boolean determining whether a project exists

Implements hdps::AbstractProjectManager.

◆ importProject()

void ProjectManager::importProject ( QString filePath = "" )

overridevirtual

Import project from filePath (only import the data)

Parameters

filePath File path of the project (choose file path when empty)

Implements hdps::AbstractProjectManager.

◆ initialize()

void ProjectManager::initialize ( )

overridevirtual

Perform manager startup initialization

Reimplemented from hdps::AbstractManager.

◆ newBlankProject()

void ProjectManager::newBlankProject ( )

overridevirtual

Creates a new blank project (without any view plugins or data)

Implements hdps::AbstractProjectManager.

◆ newProject() [1/2]

void ProjectManager::newProject ( const QString & workspaceFilePath = "" )

overridevirtual

Creates a new project, possibly also loading a workspace located at workspaceFilePath

Parameters

workspaceFilePath File path of the workspace to load (will not attempt to load workspace if empty)

Implements hdps::AbstractProjectManager.

◆ newProject() [2/2]

void ProjectManager::newProject	(	const Qt::AlignmentFlag &	alignment,
		bool	logging = `false`
	)

overridevirtual

Creates a new project with default system view plugins (either on the left or right, other alignments are ignored)

Parameters

alignment	Alignment of the default plugins
logging	Whether to add a logging view at the bottom

Implements hdps::AbstractProjectManager.

◆ openProject()

void ProjectManager::openProject	(	QString	filePath = `""`,
		bool	importDataOnly = `false`,
		bool	loadWorkspace = `true`
	)

overridevirtual

Open project from filePath

Parameters

filePath	File path of the project (choose file path when empty)
importDataOnly	Whether to only import the data from the project
loadWorkspace	Whether to load the workspace which is accompanied with the project

Implements hdps::AbstractProjectManager.

◆ publishProject()

void ProjectManager::publishProject ( QString filePath = "" )

overridevirtual

Publish project to filePath

Parameters

filePath File path of the published project

Implements hdps::AbstractProjectManager.

◆ reset()

void ProjectManager::reset ( )

overridevirtual

Resets the contents of the project manager

Implements hdps::AbstractManager.

◆ saveProject()

void ProjectManager::saveProject	(	QString	filePath = `""`,
		const QString &	password = `""`
	)

overridevirtual

Save a project to filePath

Parameters

filePath	File path of the project (choose file path when empty)
password	Encryption password

Implements hdps::AbstractProjectManager.

◆ saveProjectAs()

void ProjectManager::saveProjectAs ( )

overridevirtual

Save project to different file (user is prompted to choose the file location)

Implements hdps::AbstractProjectManager.

◆ toVariantMap()

QVariantMap ProjectManager::toVariantMap ( ) const

overridevirtual

Save widget action to variant

Returns: Variant representation of the widget action

Reimplemented from hdps::util::Serializable.

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

D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/private/ProjectManager.h
D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/private/ProjectManager.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ProjectManager()

Member Function Documentation

◆ extractProjectFileFromHdpsFile()

◆ fromVariantMap()

◆ getCurrentProject() [1/2]

◆ getCurrentProject() [2/2]

◆ getEditProjectSettingsAction()

◆ getImportDataMenu()

◆ getImportProjectAction()

◆ getNewBlankProjectAction()

◆ getNewProjectFromWorkspaceAction()

◆ getNewProjectMenu()

◆ getOpenProjectAction()

◆ getPluginManagerAction()

◆ getPreviewImage()

◆ getPublishAction()

◆ getRecentProjectsAction()

◆ getSaveProjectAction()

◆ getSaveProjectAsAction()

◆ getShowStartPageAction()

◆ hasProject()

◆ importProject()

◆ initialize()

◆ newBlankProject()

◆ newProject() [1/2]

◆ newProject() [2/2]

◆ openProject()

◆ publishProject()

◆ reset()

◆ saveProject()

◆ saveProjectAs()

◆ toVariantMap()