CesiumSubLevelComponent.h

Go to the documentation of this file.

// Copyright 2020-2024 CesiumGS, Inc. and Contributors
 
#pragma once
 
#include "Components/ActorComponent.h"
#include "UObject/ObjectMacros.h"
#include "CesiumSubLevelComponent.generated.h"
 
class ACesiumGeoreference;
class ALevelInstance;
class UCesiumSubLevelSwitcherComponent;
 
UCLASS(ClassGroup = (Cesium), meta = (BlueprintSpawnableComponent))
class CESIUMRUNTIME_API UCesiumSubLevelComponent : public UActorComponent {
  GENERATED_BODY()
 
public:
  UFUNCTION(BlueprintGetter, Category = "Cesium")
  bool GetEnabled() const;
 
  UFUNCTION(BlueprintSetter, Category = "Cesium")
  void SetEnabled(bool value);
 
  UFUNCTION(BlueprintGetter, Category = "Cesium")
  double GetOriginLongitude() const;
 
  UFUNCTION(BlueprintSetter, Category = "Cesium")
  void SetOriginLongitude(double value);
 
  UFUNCTION(BlueprintGetter, Category = "Cesium")
  double GetOriginLatitude() const;
 
  UFUNCTION(BlueprintSetter, Category = "Cesium")
  void SetOriginLatitude(double value);
 
  UFUNCTION(BlueprintGetter, Category = "Cesium")
  double GetOriginHeight() const;
 
  UFUNCTION(BlueprintSetter, Category = "Cesium")
  void SetOriginHeight(double value);
 
  UFUNCTION(BlueprintGetter, Category = "Cesium")
  double GetLoadRadius() const;
 
  UFUNCTION(BlueprintSetter, Category = "Cesium")
  void SetLoadRadius(double value);
 
  UFUNCTION(BlueprintGetter, Category = "Cesium")
  TSoftObjectPtr<ACesiumGeoreference> GetGeoreference() const;
 
  UFUNCTION(BlueprintSetter, Category = "Cesium")
  void SetGeoreference(TSoftObjectPtr<ACesiumGeoreference> NewGeoreference);
 
  UFUNCTION(BlueprintGetter, Category = "Cesium")
  ACesiumGeoreference* GetResolvedGeoreference() const;
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  ACesiumGeoreference* ResolveGeoreference(bool bForceReresolve = false);
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void SetOriginLongitudeLatitudeHeight(const FVector& longitudeLatitudeHeight);
 
#if WITH_EDITOR
  UFUNCTION(CallInEditor, Category = "Cesium")
  void PlaceGeoreferenceOriginAtSubLevelOrigin();
 
  UFUNCTION(CallInEditor, Category = "Cesium")
  void PlaceGeoreferenceOriginHere();
#endif
 
  void UpdateGeoreferenceIfSubLevelIsActive();
 
  virtual void BeginDestroy() override;
  virtual void OnComponentCreated() override;
 
#if WITH_EDITOR
  virtual void
  PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
 
protected:
  virtual void BeginPlay() override;
 
  virtual void OnRegister() override;
 
  virtual void OnUnregister() override;
 
#if WITH_EDITOR
  virtual bool CanEditChange(const FProperty* InProperty) const override;
#endif
 
private:
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium",
      BlueprintGetter = GetEnabled,
      BlueprintSetter = SetEnabled,
      meta = (AllowPrivateAccess = true))
  bool Enabled = true;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium",
      BlueprintGetter = GetOriginLatitude,
      BlueprintSetter = SetOriginLatitude,
      meta = (ClampMin = -90.0, ClampMax = 90.0, AllowPrivateAccess = true))
  double OriginLatitude = 39.736401;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium",
      BlueprintGetter = GetOriginLongitude,
      BlueprintSetter = SetOriginLongitude,
      meta = (ClampMin = -180.0, ClampMax = 180.0, AllowPrivateAccess = true))
  double OriginLongitude = -105.25737;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium",
      BlueprintGetter = GetOriginHeight,
      BlueprintSetter = SetOriginHeight,
      meta = (AllowPrivateAccess = true))
  double OriginHeight = 2250.0;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      Category = "Cesium",
      BlueprintGetter = GetLoadRadius,
      BlueprintSetter = SetLoadRadius,
      meta = (ClampMin = 0.0, AllowPrivateAccess = true))
  double LoadRadius = 1000.0;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      BlueprintGetter = GetGeoreference,
      BlueprintSetter = SetGeoreference,
      Category = "Cesium",
      Meta = (AllowPrivateAccess))
  TSoftObjectPtr<ACesiumGeoreference> Georeference;
 
  UPROPERTY(
      Transient,
      VisibleAnywhere,
      BlueprintReadOnly,
      BlueprintGetter = GetResolvedGeoreference,
      Category = "Cesium",
      Meta = (AllowPrivateAccess))
  ACesiumGeoreference* ResolvedGeoreference = nullptr;
 
  UCesiumSubLevelSwitcherComponent* _getSwitcher() noexcept;
 
  ALevelInstance* _getLevelInstance() const noexcept;
 
  void _invalidateResolvedGeoreference();
 
  void PlaceOriginAtEcef(const FVector& NewOriginEcef);
};