EVEngine: eve::ui::PcgLoadingScreen类参考

载入中...

搜索中...

未找到

Caller-owned loading-screen state driven by Pcg terrain load-progress events. 更多...

#include <PcgLoadingScreen.h>

Public 成员函数
Result< void >	configure (float fadeOutSpeed)
	Set the alpha units removed per second.

void	onLoadProgressStarted () noexcept
	Reset canvas, background alpha and progress when load tracking starts.

Result< void >	onLoadProgressUpdated (float progress)
	Publish progress; values at least one automatically begin fade-out.

void	onLoadProgressEnded () noexcept
	Hide progress/text and begin fading the background.

void	beginTimeout () noexcept
	Start a transactional missing-scene diagnostic.

Result< int >	addMissingScene (const std::string &terrainName, const std::string &impostorName)
	Append one missing terrain scene and return its stable index in the pending diagnostic.

Result< void >	addRegularReference (int sceneIndex, const std::string &objectName)
	Append a regular referencing object name to a pending scene.

Result< void >	addImpostorReference (int sceneIndex, const std::string &objectName)
	Append an impostor referencing object name to a pending scene.

Result< void >	endTimeout ()
	Publish the timeout warning and begin fade-out.

Result< void >	tick (float deltaTime)
	Advance background fade using explicit frame delta time.

bool	getCanvasVisible () const noexcept
	Return whether the loading canvas is enabled.

bool	getProgressVisible () const noexcept
	Return whether the progress bar is active.

bool	getTextVisible () const noexcept
	Return whether the loading text is enabled.

bool	getFading () const noexcept
	Return whether fade-out is running.

float	getProgress () const noexcept
	Return current progress without clamping Pcg's event value.

float	getBackgroundAlpha () const noexcept
	Return current background alpha.

const std::string &	getTimeoutMessage () const noexcept
	Return the most recently published timeout warning.

详细描述

Caller-owned loading-screen state driven by Pcg terrain load-progress events.

The terrain loader forwards start, update, end and timeout events. This object owns diagnostic strings, invokes no callbacks and exposes an immutable UI snapshot through getters. @thread UI thread only.

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

成员函数说明

◆ addImpostorReference()

Result< void > eve::ui::PcgLoadingScreen::addImpostorReference	(	int	sceneIndex,
		const std::string &	objectName
	)

Append an impostor referencing object name to a pending scene.

在文件 PcgLoadingScreen.cpp 第 73 行定义.

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

◆ addMissingScene()

Result< int > eve::ui::PcgLoadingScreen::addMissingScene	(	const std::string &	terrainName,
		const std::string &	impostorName
	)

Append one missing terrain scene and return its stable index in the pending diagnostic.

在文件 PcgLoadingScreen.cpp 第 48 行定义.

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

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

◆ addRegularReference()

Result< void > eve::ui::PcgLoadingScreen::addRegularReference	(	int	sceneIndex,
		const std::string &	objectName
	)

Append a regular referencing object name to a pending scene.

在文件 PcgLoadingScreen.cpp 第 69 行定义.

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

◆ beginTimeout()

void eve::ui::PcgLoadingScreen::beginTimeout ( )

noexcept

Start a transactional missing-scene diagnostic.

在文件 PcgLoadingScreen.cpp 第 43 行定义.

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

◆ configure()

Result< void > eve::ui::PcgLoadingScreen::configure ( float fadeOutSpeed )

Set the alpha units removed per second.

在文件 PcgLoadingScreen.cpp 第 14 行定义.

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

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

◆ endTimeout()

Result< void > eve::ui::PcgLoadingScreen::endTimeout ( )

Publish the timeout warning and begin fade-out.

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

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

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

◆ getBackgroundAlpha()

float eve::ui::PcgLoadingScreen::getBackgroundAlpha ( ) const

inlinenoexcept

Return current background alpha.

在文件 PcgLoadingScreen.h 第 62 行定义.

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

◆ getCanvasVisible()

bool eve::ui::PcgLoadingScreen::getCanvasVisible ( ) const

inlinenoexcept

Return whether the loading canvas is enabled.

在文件 PcgLoadingScreen.h 第 52 行定义.

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

◆ getFading()

bool eve::ui::PcgLoadingScreen::getFading ( ) const

inlinenoexcept

Return whether fade-out is running.

在文件 PcgLoadingScreen.h 第 58 行定义.

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

◆ getProgress()

float eve::ui::PcgLoadingScreen::getProgress ( ) const

inlinenoexcept

Return current progress without clamping Pcg's event value.

在文件 PcgLoadingScreen.h 第 60 行定义.

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

◆ getProgressVisible()

bool eve::ui::PcgLoadingScreen::getProgressVisible ( ) const

inlinenoexcept

Return whether the progress bar is active.

在文件 PcgLoadingScreen.h 第 54 行定义.

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

◆ getTextVisible()

bool eve::ui::PcgLoadingScreen::getTextVisible ( ) const

inlinenoexcept

Return whether the loading text is enabled.

在文件 PcgLoadingScreen.h 第 56 行定义.

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

◆ getTimeoutMessage()

const std::string & eve::ui::PcgLoadingScreen::getTimeoutMessage ( ) const

inlinenoexcept

Return the most recently published timeout warning.

在文件 PcgLoadingScreen.h 第 64 行定义.

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

◆ onLoadProgressEnded()

void eve::ui::PcgLoadingScreen::onLoadProgressEnded ( )

noexcept

Hide progress/text and begin fading the background.

在文件 PcgLoadingScreen.cpp 第 37 行定义.

被这些函数引用 endTimeout(), eve::ui::exposePcgLoadingScreenBindings() , 以及 onLoadProgressUpdated().

◆ onLoadProgressStarted()

void eve::ui::PcgLoadingScreen::onLoadProgressStarted ( )

noexcept

Reset canvas, background alpha and progress when load tracking starts.

在文件 PcgLoadingScreen.cpp 第 22 行定义.

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

◆ onLoadProgressUpdated()

Result< void > eve::ui::PcgLoadingScreen::onLoadProgressUpdated ( float progress )

Publish progress; values at least one automatically begin fade-out.

在文件 PcgLoadingScreen.cpp 第 28 行定义.

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

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

◆ tick()

Result< void > eve::ui::PcgLoadingScreen::tick ( float deltaTime )

Advance background fade using explicit frame delta time.

在文件 PcgLoadingScreen.cpp 第 101 行定义.

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

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

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

src/modules/ui/PcgLoadingScreen.h
src/modules/ui/PcgLoadingScreen.cpp