GlobeAwareDefaultPawn.h

Go to the documentation of this file.

// Copyright 2020-2024 CesiumGS, Inc. and Contributors
 
#pragma once
 
#include "CesiumGeospatial/Ellipsoid.h"
#include "CoreMinimal.h"
#include "GameFramework/DefaultPawn.h"
#include <glm/mat3x3.hpp>
#include <glm/vec3.hpp>
#include <vector>
#include "GlobeAwareDefaultPawn.generated.h"
 
class ACesiumGeoreference;
class UCesiumGlobeAnchorComponent;
class UCurveFloat;
class UCesiumFlyToComponent;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FCompletedFlight);
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FInterruptedFlight);
 
UCLASS()
class CESIUMRUNTIME_API AGlobeAwareDefaultPawn : public ADefaultPawn {
  GENERATED_BODY()
 
public:
  AGlobeAwareDefaultPawn();
 
  virtual void MoveForward(float Val) override;
 
  virtual void MoveRight(float Val) override;
 
  virtual void MoveUp_World(float Val) override;
 
  virtual FRotator GetViewRotation() const override;
 
  virtual FRotator GetBaseAimRotation() const override;
 
  UPROPERTY(
      meta =
          (DeprecatedProperty,
           DeprecationMessage =
               "FlyToGranularityDegrees has been deprecated. This property no longer needs to be set."))
  float FlyToGranularityDegrees_DEPRECATED = 0.01f;
 
  UPROPERTY(
      BlueprintAssignable,
      meta =
          (DeprecatedProperty,
           DeprecationMessage =
               "Use OnFlightComplete on CesiumFlyToComponent instead."))
  FCompletedFlight OnFlightComplete_DEPRECATED;
 
  UPROPERTY(
      BlueprintAssignable,
      meta =
          (DeprecatedProperty,
           DeprecationMessage =
               "Use OnFlightInterrupted on CesiumFlyToComponent instead."))
  FInterruptedFlight OnFlightInterrupt_DEPRECATED;
 
  UFUNCTION(BlueprintPure, Category = "Cesium")
  const FTransform& GetGlobeToUnrealWorldTransform() const;
 
  UFUNCTION(
      BlueprintCallable,
      meta =
          (DeprecatedFunction,
           DeprecationMessage =
               "Use FlyToEarthCenteredEarthFixed on CesiumFlyToComponent instead."))
  void FlyToLocationECEF(
      const FVector& ECEFDestination,
      double YawAtDestination,
      double PitchAtDestination,
      bool CanInterruptByMoving);
 
  UFUNCTION(
      BlueprintCallable,
      meta =
          (DeprecatedFunction,
           DeprecationMessage =
               "Use FlyToLocationLongitudeLatitudeHeight on CesiumFlyToComponent instead."))
  void FlyToLocationLongitudeLatitudeHeight(
      const FVector& LongitudeLatitudeHeightDestination,
      double YawAtDestination,
      double PitchAtDestination,
      bool CanInterruptByMoving);
 
protected:
  virtual void Serialize(FArchive& Ar) override;
  virtual void PostLoad() override;
 
  UPROPERTY(
      Category = "Cesium",
      BlueprintReadOnly,
      BlueprintGetter = GetGeoreference,
      Meta =
          (DeprecatedProperty,
           DeprecationMessage =
               "Get the Georeference instance from the Globe Anchor Component instead."))
  ACesiumGeoreference* Georeference_DEPRECATED;
 
  UFUNCTION(BlueprintGetter, Category = "Cesium")
  ACesiumGeoreference* GetGeoreference() const;
 
  UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category = "Cesium")
  UCesiumGlobeAnchorComponent* GlobeAnchor;
 
private:
  UPROPERTY(
      Category = "Cesium",
      BlueprintGetter = GetFlyToProgressCurve_DEPRECATED,
      BlueprintSetter = SetFlyToProgressCurve_DEPRECATED,
      meta =
          (AllowPrivateAccess,
           DeprecatedProperty,
           DeprecationMessage =
               "Use ProgressCurve on CesiumFlyToComponent instead."))
  UCurveFloat* FlyToProgressCurve_DEPRECATED;
  UFUNCTION(BlueprintGetter)
  UCurveFloat* GetFlyToProgressCurve_DEPRECATED() const;
  UFUNCTION(BlueprintSetter)
  void SetFlyToProgressCurve_DEPRECATED(UCurveFloat* NewValue);
 
  UPROPERTY(
      Category = "Cesium",
      BlueprintGetter = GetFlyToAltitudeProfileCurve_DEPRECATED,
      BlueprintSetter = SetFlyToAltitudeProfileCurve_DEPRECATED,
      meta =
          (AllowPrivateAccess,
           DeprecatedProperty,
           DeprecationMessage =
               "Use HeightPercentageCurve on CesiumFlyToComponent instead."))
  UCurveFloat* FlyToAltitudeProfileCurve_DEPRECATED;
  UFUNCTION(BlueprintGetter)
  UCurveFloat* GetFlyToAltitudeProfileCurve_DEPRECATED() const;
  UFUNCTION(BlueprintSetter)
  void SetFlyToAltitudeProfileCurve_DEPRECATED(UCurveFloat* NewValue);
 
  UPROPERTY(
      Category = "Cesium",
      BlueprintGetter = GetFlyToMaximumAltitudeCurve_DEPRECATED,
      BlueprintSetter = SetFlyToMaximumAltitudeCurve_DEPRECATED,
      meta =
          (AllowPrivateAccess,
           DeprecatedProperty,
           DeprecationMessage =
               "Use MaximumHeightByDistanceCurve on CesiumFlyToComponent instead."))
  UCurveFloat* FlyToMaximumAltitudeCurve_DEPRECATED;
  UFUNCTION(BlueprintGetter)
  UCurveFloat* GetFlyToMaximumAltitudeCurve_DEPRECATED() const;
  UFUNCTION(BlueprintSetter)
  void SetFlyToMaximumAltitudeCurve_DEPRECATED(UCurveFloat* NewValue);
 
  UPROPERTY(
      Category = "Cesium",
      BlueprintGetter = GetFlyToDuration_DEPRECATED,
      BlueprintSetter = SetFlyToDuration_DEPRECATED,
      meta =
          (AllowPrivateAccess,
           DeprecatedProperty,
           DeprecationMessage =
               "Use Duration on CesiumFlyToComponent instead."))
  float FlyToDuration_DEPRECATED = 5.0f;
  UFUNCTION(BlueprintGetter)
  float GetFlyToDuration_DEPRECATED() const;
  UFUNCTION(BlueprintSetter)
  void SetFlyToDuration_DEPRECATED(float NewValue);
 
  void _moveAlongViewAxis(EAxis::Type axis, double Val);
  void _moveAlongVector(const FVector& axis, double Val);
 
  UFUNCTION()
  void _onFlightComplete();
 
  UFUNCTION()
  void _onFlightInterrupted();
};