UCesiumSubLevelSwitcherComponent Class Reference

Manages the asynchronous switching between sub-levels, making sure that a previous sub-level is hidden before the CesiumGeoreference is switched to a new location and the next sub-level is loaded. More...

#include <CesiumSubLevelSwitcherComponent.h>

Inheritance diagram for UCesiumSubLevelSwitcherComponent:

Public Member Functions
	UCesiumSubLevelSwitcherComponent ()
TArray< ALevelInstance * >	GetRegisteredSubLevels () const noexcept
	Gets the list of sub-levels that are currently registered with this switcher.
const TArray< TWeakObjectPtr< ALevelInstance > > &	GetRegisteredSubLevelsWeak () const noexcept
	Gets the list of sub-levels that are currently registered with this switcher.
ALevelInstance *	GetCurrentSubLevel () const noexcept
	Gets the sub-level that is currently active, or nullptr if none are active.
ALevelInstance *	GetTargetSubLevel () const noexcept
	Gets the sub-level that is in the process of becoming active.
void	SetTargetSubLevel (ALevelInstance *LevelInstance) noexcept
	Sets the sub-level that should be active.

Friends
class	UCesiumSubLevelComponent
class	CesiumEditorSubLevelMutex

Detailed Description

Manages the asynchronous switching between sub-levels, making sure that a previous sub-level is hidden before the CesiumGeoreference is switched to a new location and the next sub-level is loaded.

Definition at line 19 of file CesiumSubLevelSwitcherComponent.h.

Constructor & Destructor Documentation

UCesiumSubLevelSwitcherComponent()

UCesiumSubLevelSwitcherComponent::UCesiumSubLevelSwitcherComponent

(

)

Member Function Documentation

GetCurrentSubLevel()

ALevelInstance * UCesiumSubLevelSwitcherComponent::GetCurrentSubLevel ( ) const

noexcept

Gets the sub-level that is currently active, or nullptr if none are active.

GetRegisteredSubLevels()

TArray< ALevelInstance * > UCesiumSubLevelSwitcherComponent::GetRegisteredSubLevels ( ) const

noexcept

Gets the list of sub-levels that are currently registered with this switcher.

GetRegisteredSubLevelsWeak()

const TArray< TWeakObjectPtr< ALevelInstance > > & UCesiumSubLevelSwitcherComponent::GetRegisteredSubLevelsWeak ( ) const

inlinenoexcept

Gets the list of sub-levels that are currently registered with this switcher.

This is slightly more efficient than GetRegisteredSubLevels but is not accessible from Blueprints.

Definition at line 39 of file CesiumSubLevelSwitcherComponent.h.

GetTargetSubLevel()

ALevelInstance * UCesiumSubLevelSwitcherComponent::GetTargetSubLevel ( ) const

noexcept

Gets the sub-level that is in the process of becoming active.

If nullptr, the target is a state where no sub-levels are active.

SetTargetSubLevel()

void UCesiumSubLevelSwitcherComponent::SetTargetSubLevel ( ALevelInstance * LevelInstance )

noexcept

Sets the sub-level that should be active.

The switcher will asynchronously load and show this sub-level.

Friends And Related Symbol Documentation

CesiumEditorSubLevelMutex

friend class CesiumEditorSubLevelMutex

friend

Definition at line 67 of file CesiumSubLevelSwitcherComponent.h.

UCesiumSubLevelComponent

friend class UCesiumSubLevelComponent

friend

Definition at line 66 of file CesiumSubLevelSwitcherComponent.h.

---

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

• Source/CesiumRuntime/Public/CesiumSubLevelSwitcherComponent.h