CesiumGlobeAnchorComponent.h

Go to the documentation of this file.

// Copyright 2020-2024 CesiumGS, Inc. and Contributors
 
#pragma once
 
#include "CesiumGeospatial/GlobeAnchor.h"
#include "Components/ActorComponent.h"
#include "Delegates/IDelegateInstance.h"
#include "CesiumGlobeAnchorComponent.generated.h"
 
class ACesiumGeoreference;
 
UCLASS(ClassGroup = Cesium, Meta = (BlueprintSpawnableComponent))
class CESIUMRUNTIME_API UCesiumGlobeAnchorComponent : public UActorComponent {
  GENERATED_BODY()
 
#pragma region Properties
private:
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      BlueprintGetter = GetGeoreference,
      BlueprintSetter = SetGeoreference,
      Category = "Cesium",
      Meta = (AllowPrivateAccess))
  TSoftObjectPtr<ACesiumGeoreference> Georeference = nullptr;
 
  UPROPERTY(
      Transient,
      VisibleAnywhere,
      BlueprintReadOnly,
      BlueprintGetter = GetResolvedGeoreference,
      Category = "Cesium",
      Meta = (AllowPrivateAccess))
  ACesiumGeoreference* ResolvedGeoreference = nullptr;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      BlueprintGetter = GetAdjustOrientationForGlobeWhenMoving,
      BlueprintSetter = SetAdjustOrientationForGlobeWhenMoving,
      Category = "Cesium",
      Meta = (AllowPrivateAccess))
  bool AdjustOrientationForGlobeWhenMoving = true;
 
  UPROPERTY(
      EditAnywhere,
      BlueprintReadWrite,
      BlueprintGetter = GetTeleportWhenUpdatingTransform,
      BlueprintSetter = SetTeleportWhenUpdatingTransform,
      Category = "Cesium",
      Meta = (AllowPrivateAccess))
  bool TeleportWhenUpdatingTransform = true;
 
  UPROPERTY(
      BlueprintReadWrite,
      BlueprintGetter = GetActorToEarthCenteredEarthFixedMatrix,
      BlueprintSetter = SetActorToEarthCenteredEarthFixedMatrix,
      Category = "Cesium",
      Meta = (AllowPrivateAccess))
  FMatrix ActorToEarthCenteredEarthFixedMatrix;
 
#pragma endregion
 
#pragma region Property Accessors
public:
  UFUNCTION(BlueprintGetter)
  TSoftObjectPtr<ACesiumGeoreference> GetGeoreference() const;
 
  UFUNCTION(BlueprintSetter)
  void SetGeoreference(TSoftObjectPtr<ACesiumGeoreference> NewGeoreference);
 
  UFUNCTION(BlueprintGetter)
  ACesiumGeoreference* GetResolvedGeoreference() const;
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  ACesiumGeoreference* ResolveGeoreference(bool bForceReresolve = false);
 
  UFUNCTION(BlueprintGetter, Category = "Cesium")
  UCesiumEllipsoid* GetEllipsoid() const;
 
  UFUNCTION(BlueprintGetter, Category = "Cesium")
  FMatrix GetActorToEarthCenteredEarthFixedMatrix() const;
 
  UFUNCTION(BlueprintSetter, Category = "Cesium")
  void SetActorToEarthCenteredEarthFixedMatrix(const FMatrix& Value);
 
  UFUNCTION(BlueprintGetter, Category = "Cesium")
  bool GetTeleportWhenUpdatingTransform() const;
 
  UFUNCTION(BlueprintSetter, Category = "Cesium")
  void SetTeleportWhenUpdatingTransform(bool Value);
 
  UFUNCTION(BlueprintGetter, Category = "Cesium")
  bool GetAdjustOrientationForGlobeWhenMoving() const;
 
  UFUNCTION(BlueprintSetter, Category = "Cesium")
  void SetAdjustOrientationForGlobeWhenMoving(bool Value);
 
#pragma endregion
 
#pragma region Public Methods
 
public:
  UFUNCTION(
      BlueprintPure,
      Category = "Cesium",
      Meta = (ReturnDisplayName = "LongitudeLatitudeHeight"))
  FVector GetLongitudeLatitudeHeight() const;
 
  UFUNCTION(
      BlueprintPure,
      Category = "Cesium",
      Meta = (ReturnDisplayName = "Longitude"))
  double GetLongitude() const { return this->GetLongitudeLatitudeHeight().X; }
 
  UFUNCTION(
      BlueprintPure,
      Category = "Cesium",
      Meta = (ReturnDisplayName = "Latitude"))
  double GetLatitude() const { return this->GetLongitudeLatitudeHeight().Y; }
 
  UFUNCTION(
      BlueprintPure,
      Category = "Cesium",
      Meta = (ReturnDisplayName = "Height"))
  double GetHeight() const { return this->GetLongitudeLatitudeHeight().Z; }
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void MoveToLongitudeLatitudeHeight(const FVector& LongitudeLatitudeHeight);
 
  UFUNCTION(
      BlueprintPure,
      Category = "Cesium",
      meta = (ReturnDisplayName = "EarthCenteredEarthFixedPosition"))
  FVector GetEarthCenteredEarthFixedPosition() const;
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void MoveToEarthCenteredEarthFixedPosition(
      const FVector& EarthCenteredEarthFixedPosition);
 
  UFUNCTION(
      BlueprintPure,
      Category = "Cesium",
      meta = (ReturnDisplayName = "EastSouthUpRotation"))
  FQuat GetEastSouthUpRotation() const;
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void SetEastSouthUpRotation(const FQuat& EastSouthUpRotation);
 
  UFUNCTION(
      BlueprintPure,
      Category = "Cesium",
      meta = (ReturnDisplayName = "EarthCenteredEarthFixedRotation"))
  FQuat GetEarthCenteredEarthFixedRotation() const;
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void SetEarthCenteredEarthFixedRotation(
      const FQuat& EarthCenteredEarthFixedRotation);
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void SnapLocalUpToEllipsoidNormal();
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void SnapToEastSouthUp();
 
  UFUNCTION(BlueprintCallable, Category = "Cesium")
  void Sync();
 
#pragma endregion
 
#pragma region Obsolete
public:
  UE_DEPRECATED(
      "Cesium For Unreal v2.0",
      "The resolved georeference can no longer be explicitly invalidated. To change the georeference, call SetGeoreference or ReregisterComponent.")
  UFUNCTION(
      BlueprintCallable,
      Category = "Cesium",
      Meta =
          (DeprecatedFunction,
           DeprecationMessage =
               "The resolved georeference can no longer be explicitly invalidated. To change the georeference, call SetGeoreference or ReregisterComponent."))
  void InvalidateResolvedGeoreference();
#pragma endregion
 
#pragma region Unreal Lifecycle
protected:
  virtual void Serialize(FArchive& Ar) override;
 
  virtual void OnComponentCreated() override;
 
#if WITH_EDITOR
  virtual void
  PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
 
  virtual void OnRegister() override;
 
  virtual void OnUnregister() override;
#pragma endregion
 
#pragma region Implementation Details
private:
  CesiumGeospatial::GlobeAnchor _createNativeGlobeAnchor() const;
 
  USceneComponent* _getRootComponent(bool warnIfNull) const;
 
  FTransform _getCurrentRelativeTransform() const;
 
  void _setCurrentRelativeTransform(const FTransform& relativeTransform);
 
  CesiumGeospatial::GlobeAnchor
  _createOrUpdateNativeGlobeAnchorFromRelativeTransform(
      const FTransform& newRelativeTransform);
 
  CesiumGeospatial::GlobeAnchor
  _createOrUpdateNativeGlobeAnchorFromECEF(const FMatrix& newActorToECEFMatrix);
 
  void _updateFromNativeGlobeAnchor(
      const CesiumGeospatial::GlobeAnchor& nativeAnchor);
 
  void _setNewActorToECEFFromRelativeTransform();
 
#if WITH_EDITORONLY_DATA
  // This is used only to preserve the transformation saved by old versions of
  // Cesium for Unreal. See the Serialize method.
  UPROPERTY(Meta = (DeprecatedProperty))
  double _actorToECEF_Array_DEPRECATED[16];
#endif
 
  UPROPERTY()
  bool _actorToECEFIsValid = false;
 
  bool _updatingActorTransform = false;
 
  bool _lastRelativeTransformIsValid = false;
  FTransform _lastRelativeTransform{};
 
  void _onActorTransformChanged(
      USceneComponent* InRootComponent,
      EUpdateTransformFlags UpdateTransformFlags,
      ETeleportType Teleport);
 
  UFUNCTION(CallInEditor)
  void _onGeoreferenceChanged();
 
  friend class FCesiumGlobeAnchorCustomization;
#pragma endregion
};