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

Inheritance Hierarchy

References

   
Module GeoReferencing
Header /Engine/Plugins/Runtime/GeoReferencing/Source/GeoReferencing/Public/RoundPlanetPawn.h
Include #include "RoundPlanetPawn.h"

Syntax

UCLASS&40;&41;  
class ARoundPlanetPawn : public ADefaultPawn

Remarks

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.

Variables

  Type Name Description
Public variable UProperty Category BlueprintReadOnly visibleanywhere float Altitude The distance between the geographic ellipsoid surface and the pawn
Public variable UProperty Category, EditAnywhere TObjectPtr< UCurveFloat > AltitudeProfileCurve This curve dictates what percentage of the max altitude the pawn should take at a given time on the curve.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float BaseSpeedKmh The Reference maximum speed for the pawn, before being altered by any Scalar modifier or by altitude curve ActualMaxSpeed = BaseSpeedKmh * SpeedScalar * AltitudeSpeedModifierCurve(Altitude)
Public variable UProperty Category, EditAnywhere, Meta float FlyDuration Fly to Location duration (in seconds)
Protected variable UProperty TObjectPtr< AGeoReferencingSystem > GeoReferencingSystem  
Public variable UProperty Category, EditAnywhere, Meta float GranularityDegrees The granularity in degrees with which keypoints should be generated for the Fly to Location interpolation.
Public variable UProperty Category BlueprintReadOnly visibleanywhere float HAT Height Above Terrain. The distance between the ground and the pawn
Public variable UProperty Category, EditAnywhere TObjectPtr< UCurveFloat > MaximumAltitudeCurve This curve is used to pick up a reference the maximum altitude when flying to a location.
Public variable UProperty Category, EditAnywhere float MaximumAltitudeValue In case MaximumAltitudeCurve is not defined, the AltitudeProfileCurve will use this Maximum altitude value for the flight, whatever the travel distance.
Public variable UProperty Category, EditAnywhere, Meta int32 MaximumStepCount Make sure we don't get crazy in case of large flights with small granularity
Public variable UProperty Category, EditAnywhere, Meta int32 MinimumStepCount The minimum linear steps for the FlyTolocation motion.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool OrbitalMotion 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
Public variable UProperty Category, EditAnywhere TObjectPtr< UCurveFloat > ProgressCurve This curve is used to ease in an out the Fly to Location speed.
Public variable UProperty Category, EditAnywhere TObjectPtr< UCurveFloat > SpeedByHATModifierCurve 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.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float SpeedScalar Scalar modifier for the base speed ActualMaxSpeed = BaseSpeedKmh * SpeedScalar * AltitudeSpeedModifierCurve(Altitude)
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float SpeedScalarIncrement Multiplier/Divider for increasing/decreasing the speed scalar

Constructors

No constructors are accessible with public or protected access.

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void Decrease the Speed Scalar - MouseWheel Down equivalent
Public function UFunction BlueprintCallable, Category 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.
Public function UFunction BlueprintCallable, Category 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.
Public function UFunction BlueprintCallable, Category 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.
Public function UFunction BlueprintCallable, Category void Increase the Speed Scalar - MouseWheel Up equivalent
Public function UFunction BlueprintCallable, Category void Stop the current Fly To Location motion
Public function UFunction BlueprintCallable, Category void Reset the Speed Scalar to its default value - Middle-mouse button click equivalent

Overridden from ADefaultPawn

  Type Name Description
Public function Virtual void

MoveForward ( float Val
)

 Input callback to move forward in local space (or backward if Val is negative).
Public function Virtual void

MoveRight ( float Val
)

 Input callback to strafe right in local space (or left if Val is negative).
Public function Virtual void

MoveUp_World ( float Val
)

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

Overridden from APawn

  Type Name Description
Public function Virtual Const FRotator Don't return the controller rotation but a transformed rotation to consider planet roundness.
Public function Virtual Const FRotator Don't return the controller rotation but a transformed rotation to consider planet roundness.
Public function Virtual void Adds to the default pawn the Mouse Wheel inputs to tune the speed scalar

Overridden from AActor

  Type Name Description
Public function Virtual void Overridable native event for when play begins for this actor.
Public function Virtual void

OnConstruction ( const FTransform& Transform
)

 Called when an instance of this class is placed (in editor) or spawned.
Public function Virtual void

Tick ( float DeltaSeconds
)

 Function called every frame on this Actor.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page