1. Epic GamesDeveloper
  3. ARoundPlanetPawn

ARoundPlanetPawn

This pawn can be used to easily move around the globe while maintaining a sensible orientation.

API > API/Plugins > API/Plugins/GeoReferencing

This pawn can be used to easily move around the globe while maintaining a sensible orientation. As the pawn moves across the horizon, it automatically changes its own up direction such that the world always looks right-side up.

   
Name ARoundPlanetPawn
Type class
Header File /Engine/Plugins/Runtime/GeoReferencing/Source/GeoReferencing/Public/RoundPlanetPawn.h
Include Path #include "RoundPlanetPawn.h"

Syntax

UCLASS ()  
class ARoundPlanetPawn : public ADefaultPawn

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

ARoundPlanetPawn()

   RoundPlanetPawn.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Altitude float The distance between the geographic ellipsoid surface and the pawn RoundPlanetPawn.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category="Movement"
AltitudeProfileCurve TObjectPtr< UCurveFloat > This curve dictates what percentage of the max altitude the pawn should take at a given time on the curve. RoundPlanetPawn.h
  • EditAnywhere
  • Category="FlyToLocation"
BaseSpeedKmh float The Reference maximum speed for the pawn, before being altered by any Scalar modifier or by altitude curve ActualMaxSpeed = BaseSpeedKmh * SpeedScalar * AltitudeSpeedModifierCurve(Altitude) RoundPlanetPawn.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Movement"
FlyDuration float Fly to Location duration (in seconds) RoundPlanetPawn.h
  • EditAnywhere
  • Category="FlyToLocation"
  • Meta=(ClampMin=0.0)
GranularityDegrees float The granularity in degrees with which keypoints should be generated for the Fly to Location interpolation. RoundPlanetPawn.h
  • EditAnywhere
  • Category="FlyToLocation"
  • Meta=(ClampMin=0.0)
HAT float Height Above Terrain. The distance between the ground and the pawn RoundPlanetPawn.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category="Movement"
MaximumAltitudeCurve TObjectPtr< UCurveFloat > This curve is used to pick up a reference the maximum altitude when flying to a location. RoundPlanetPawn.h
  • EditAnywhere
  • Category="FlyToLocation"
MaximumAltitudeValue float In case MaximumAltitudeCurve is not defined, the AltitudeProfileCurve will use this Maximum altitude value for the flight, whatever the travel distance. RoundPlanetPawn.h
  • EditAnywhere
  • Category="FlyToLocation"
MaximumStepCount int32 Make sure we don't get crazy in case of large flights with small granularity RoundPlanetPawn.h
  • EditAnywhere
  • Category="FlyToLocation"
  • Meta=(ClampMin=0.0)
MinimumStepCount int32 The minimum linear steps for the FlyTolocation motion. RoundPlanetPawn.h
  • EditAnywhere
  • Category="FlyToLocation"
  • Meta=(ClampMin=0.0)
OrbitalMotion bool If True, the motion Forward/Right motion of the pawn are relative to Planet tangent, meaning the altitude will approximately be kept, whatever the pawn camera orientation RoundPlanetPawn.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Movement"
ProgressCurve TObjectPtr< UCurveFloat > This curve is used to ease in an out the Fly to Location speed. RoundPlanetPawn.h
  • EditAnywhere
  • Category="FlyToLocation"
SpeedByHATModifierCurve TObjectPtr< UCurveFloat > When being very high and moving around the planet, we have to dynamically increase the speed based on Height above terrain to accelerate movement This curve adds a multiplying factor to the maximum speed depending on HAT. RoundPlanetPawn.h
  • EditAnywhere
  • Category="Movement"
SpeedScalar float Scalar modifier for the base speed ActualMaxSpeed = BaseSpeedKmh * SpeedScalar * AltitudeSpeedModifierCurve(Altitude) RoundPlanetPawn.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Movement"
SpeedScalarIncrement float Multiplier/Divider for increasing/decreasing the speed scalar RoundPlanetPawn.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Movement"

Protected

Name Type Remarks Include Path Unreal Specifiers
bCanInterruptFlight bool   RoundPlanetPawn.h  
bIsFlyingToLocation bool Variables for FlyToLocation. RoundPlanetPawn.h  
bIsHATInvalid bool   RoundPlanetPawn.h  
CacheUpdateThresholdSq float   RoundPlanetPawn.h  
CurrentFlyTime float   RoundPlanetPawn.h  
East FVector   RoundPlanetPawn.h  
FlyToLocationDestinationRotation FRotator   RoundPlanetPawn.h  
FlyToLocationKeypoints TArray< FVector >   RoundPlanetPawn.h  
FlyToLocationOriginRotation FRotator   RoundPlanetPawn.h  
LastCacheLocation FVector Variables for Motion Object caches. RoundPlanetPawn.h  
North FVector   RoundPlanetPawn.h  
TangentTransform FTransform   RoundPlanetPawn.h  
Up FVector   RoundPlanetPawn.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void DecreaseSpeedScalar()

 Decrease the Speed Scalar - MouseWheel Down equivalent RoundPlanetPawn.h
  • BlueprintCallable
  • Category="Movement"

void FlyToLocationECEF ( const FVector& ECEFDestination,
double YawAtDestination,
double PitchAtDestination,
bool CanInterruptByMoving
)

 Begin a smooth camera flight to the given ECEF destination such that the camera ends at the specified yaw and pitch. RoundPlanetPawn.h
  • BlueprintCallable
  • Category="FlyToLocation"

void FlyToLocationGeographic ( const FGeographicCoordinates& GeographicDestination,
double YawAtDestination,
double PitchAtDestination,
bool CanInterruptByMoving
)

 Begin a smooth camera flight to the given Latitude/Longitude destination such that the camera ends at the specified yaw and pitch. RoundPlanetPawn.h
  • BlueprintCallable
  • Category="FlyToLocation"

void FlyToLocationLatitudeLongitudeAltitude ( const double& InLatitude,
const double& InLongitude,
const double& InAltitude,
double YawAtDestination,
double PitchAtDestination,
bool CanInterruptByMoving
)

 Begin a smooth camera flight to the given Latitude/Longitude destination such that the camera ends at the specified yaw and pitch. RoundPlanetPawn.h
  • BlueprintCallable
  • Category="FlyToLocation"

void IncreaseSpeedScalar()

 Increase the Speed Scalar - MouseWheel Up equivalent RoundPlanetPawn.h
  • BlueprintCallable
  • Category="Movement"

void InterruptFlyToLocation()

 Stop the current Fly To Location motion RoundPlanetPawn.h
  • BlueprintCallable
  • Category="FlyToLocation"

void ResetSpeedScalar()

 Reset the Speed Scalar to its default value - Middle-mouse button click equivalent RoundPlanetPawn.h
  • BlueprintCallable
  • Category="Movement"

Overridden from ADefaultPawn

Name Remarks Include Path Unreal Specifiers

virtual void MoveForward ( float Val
)

 Input callback to move forward in local space (or backward if Val is negative). RoundPlanetPawn.h  

virtual void MoveRight ( float Val
)

 Input callback to strafe right in local space (or left if Val is negative). RoundPlanetPawn.h  

virtual void MoveUp_World ( float Val
)

 Input callback to move up in world space (or down if Val is negative). RoundPlanetPawn.h  

Overridden from APawn

Name Remarks Include Path Unreal Specifiers

virtual FRotator GetBaseAimRotation()

 Don't return the controller rotation but a transformed rotation to consider planet roundness. RoundPlanetPawn.h  

virtual FRotator GetViewRotation()

 Don't return the controller rotation but a transformed rotation to consider planet roundness. RoundPlanetPawn.h  

virtual void SetupPlayerInputComponent ( UInputComponent* InInputComponent
)

 Adds to the default pawn the Mouse Wheel inputs to tune the speed scalar RoundPlanetPawn.h  

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

   RoundPlanetPawn.h  

virtual void OnConstruction ( const FTransform& Transform
)

   RoundPlanetPawn.h  

virtual void Tick ( float DeltaSeconds
)

   RoundPlanetPawn.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page