CesiumSubLevelSwitcherComponent.h

Go to the documentation of this file.

// Copyright 2020-2024 CesiumGS, Inc. and Contributors
 
#pragma once
 
#include "Components/ActorComponent.h"
#include "CesiumSubLevelSwitcherComponent.generated.h"
 
class ACesiumGeoreference;
class ALevelInstance;
class ULevelStreaming;
class UWorld;
 
UCLASS(ClassGroup = "Cesium")
class CESIUMRUNTIME_API UCesiumSubLevelSwitcherComponent
    : public UActorComponent {
  GENERATED_BODY()
 
public:
  UCesiumSubLevelSwitcherComponent();
 
  UFUNCTION(BlueprintPure, Category = "Cesium|Sub-levels")
  TArray<ALevelInstance*> GetRegisteredSubLevels() const noexcept;
 
  const TArray<TWeakObjectPtr<ALevelInstance>>&
  GetRegisteredSubLevelsWeak() const noexcept {
    return this->_sublevels;
  }
 
  UFUNCTION(BlueprintPure, Category = "Cesium|Sub-levels")
  ALevelInstance* GetCurrentSubLevel() const noexcept;
 
  UFUNCTION(BlueprintPure, Category = "Cesium|Sub-levels")
  ALevelInstance* GetTargetSubLevel() const noexcept;
 
  UFUNCTION(BlueprintCallable, Category = "Cesium|Sub-levels")
  void SetTargetSubLevel(ALevelInstance* LevelInstance) noexcept;
 
private:
  // To allow the sub-level to register/unregister itself with the functions
  // below.
  friend class UCesiumSubLevelComponent;
  friend class CesiumEditorSubLevelMutex;
 
  void RegisterSubLevel(ALevelInstance* pSubLevel) noexcept;
 
  void UnregisterSubLevel(ALevelInstance* pSubLevel) noexcept;
 
  virtual void TickComponent(
      float DeltaTime,
      enum ELevelTick TickType,
      FActorComponentTickFunction* ThisTickFunction) override;
 
  void _updateSubLevelStateGame();
#if WITH_EDITOR
  void _updateSubLevelStateEditor();
#endif
 
  ULevelStreaming*
  _getLevelStreamingForSubLevel(ALevelInstance* SubLevel) const;
 
  // Don't save/load or copy this.
  UPROPERTY(Transient, DuplicateTransient, TextExportTransient)
  TArray<TWeakObjectPtr<ALevelInstance>> _sublevels;
 
  // Don't save/load or copy this.
  UPROPERTY(Transient, DuplicateTransient, TextExportTransient)
  TWeakObjectPtr<ALevelInstance> _pCurrent = nullptr;
 
  // Save/load this, but don't copy it.
  UPROPERTY(DuplicateTransient, TextExportTransient)
  TWeakObjectPtr<ALevelInstance> _pTarget = nullptr;
 
  bool _doExtraChecksOnNextTick = false;
  bool _isTransitioningSubLevels = false;
};