EVEngine: eve::ui::PcgPhotoModeSession类参考

载入中...

搜索中...

未找到

Transactional lifecycle state for Pcg PhotoMode setup, disable and destroy. 更多...

#include <PcgPhotoModeSession.h>

Public 成员函数
Result< void >	begin (const std::string &capturedJson, const std::string &savedJson, bool loadSaved, bool savedEver, int currentPipeline, int savedPipeline, const std::string &sceneName, int lightingProfile)
	Begin from captured engine values and optionally select a compatible saved profile.

Result< void >	replaceWorkingJson (const std::string &json)
	Replace the working values after a UI or engine edit.

Result< void >	end (bool resetOnDisable, bool applicationPlaying)
	End the session; restore captured settings only when both flags are true.

Result< std::string >	workingJson () const
	Encode the currently selected working profile.

Result< std::string >	outputJson () const
	Encode values that the caller must apply after end.

bool	getActive () const noexcept
	Returns the active.

bool	getRestoreRequested () const noexcept

bool	getRemovePhotoCameraRequested () const noexcept
	Returns the remove photo camera requested.

bool	getUnfreezePlayerRequested () const noexcept
	Returns the unfreeze player requested.

int	getLoadDecision () const noexcept
	Returns the load decision.

uint64_t	getRevision () const noexcept

详细描述

Transactional lifecycle state for Pcg PhotoMode setup, disable and destroy.

在文件 PcgPhotoModeSession.h 第 13 行定义.

成员函数说明

◆ begin()

Result< void > eve::ui::PcgPhotoModeSession::begin	(	const std::string &	capturedJson,
		const std::string &	savedJson,
		bool	loadSaved,
		bool	savedEver,
		int	currentPipeline,
		int	savedPipeline,
		const std::string &	sceneName,
		int	lightingProfile
	)

Begin from captured engine values and optionally select a compatible saved profile.

在文件 PcgPhotoModeSession.cpp 第 10 行定义.

引用了 eve::ui::Current, eve::Diagnostic::error(), eve::Result< T >::failure(), eve::ui::PcgPhotoModeValues::getBool(), eve::ui::PcgPhotoModeValues::getInt(), eve::ui::PcgPhotoModeValues::getString(), eve::InvalidArgument, eve::ui::PcgPhotoModeValues::restoreJson(), eve::ui::SaveCurrent, eve::ui::Saved , 以及 eve::Result< T >::success().

被这些函数引用 eve::ui::exposePcgPhotoModeSessionBindings().

◆ end()

Result< void > eve::ui::PcgPhotoModeSession::end	(	bool	resetOnDisable,
		bool	applicationPlaying
	)

End the session; restore captured settings only when both flags are true.

在文件 PcgPhotoModeSession.cpp 第 65 行定义.

引用了 eve::Diagnostic::error(), eve::Result< T >::failure(), eve::InvalidArgument , 以及 eve::Result< T >::success().

被这些函数引用 eve::ui::exposePcgPhotoModeSessionBindings().

◆ getActive()

bool eve::ui::PcgPhotoModeSession::getActive ( ) const

inlinenoexcept

Returns the active.

在文件 PcgPhotoModeSession.h 第 22 行定义.

被这些函数引用 eve::ui::exposePcgPhotoModeSessionBindings().

◆ getLoadDecision()

int eve::ui::PcgPhotoModeSession::getLoadDecision ( ) const

inlinenoexcept

Returns the load decision.

在文件 PcgPhotoModeSession.h 第 28 行定义.

被这些函数引用 eve::ui::exposePcgPhotoModeSessionBindings().

◆ getRemovePhotoCameraRequested()

bool eve::ui::PcgPhotoModeSession::getRemovePhotoCameraRequested ( ) const

inlinenoexcept

Returns the remove photo camera requested.

在文件 PcgPhotoModeSession.h 第 24 行定义.

被这些函数引用 eve::ui::exposePcgPhotoModeSessionBindings().

◆ getRestoreRequested()

bool eve::ui::PcgPhotoModeSession::getRestoreRequested ( ) const

inlinenoexcept

在文件 PcgPhotoModeSession.h 第 22 行定义.

被这些函数引用 eve::ui::exposePcgPhotoModeSessionBindings().

◆ getRevision()

uint64_t eve::ui::PcgPhotoModeSession::getRevision ( ) const

inlinenoexcept

在文件 PcgPhotoModeSession.h 第 28 行定义.

被这些函数引用 eve::ui::exposePcgPhotoModeSessionBindings().

◆ getUnfreezePlayerRequested()

bool eve::ui::PcgPhotoModeSession::getUnfreezePlayerRequested ( ) const

inlinenoexcept

Returns the unfreeze player requested.

在文件 PcgPhotoModeSession.h 第 26 行定义.

被这些函数引用 eve::ui::exposePcgPhotoModeSessionBindings().

◆ outputJson()

Result< std::string > eve::ui::PcgPhotoModeSession::outputJson ( ) const

Encode values that the caller must apply after end.

在文件 PcgPhotoModeSession.cpp 第 78 行定义.

引用了 eve::ui::PcgPhotoModeValues::snapshotJson().

被这些函数引用 eve::ui::exposePcgPhotoModeSessionBindings().

◆ replaceWorkingJson()

Result< void > eve::ui::PcgPhotoModeSession::replaceWorkingJson ( const std::string & json )

Replace the working values after a UI or engine edit.

在文件 PcgPhotoModeSession.cpp 第 53 行定义.

引用了 eve::Diagnostic::error(), eve::Result< T >::failure(), eve::InvalidArgument, eve::ui::PcgPhotoModeValues::restoreJson() , 以及 eve::Result< T >::success().

被这些函数引用 eve::ui::exposePcgPhotoModeSessionBindings().

◆ workingJson()

Result< std::string > eve::ui::PcgPhotoModeSession::workingJson ( ) const

Encode the currently selected working profile.

在文件 PcgPhotoModeSession.cpp 第 77 行定义.

引用了 eve::ui::PcgPhotoModeValues::snapshotJson().

被这些函数引用 eve::ui::exposePcgPhotoModeSessionBindings().

该类的文档由以下文件生成:

src/modules/ui/PcgPhotoModeSession.h
src/modules/ui/PcgPhotoModeSession.cpp