Cesium for Unreal 2.13.2
Loading...
Searching...
No Matches
AGlobeAwareDefaultPawn Class Reference

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

#include <GlobeAwareDefaultPawn.h>

Inheritance diagram for AGlobeAwareDefaultPawn:

Public Member Functions

 AGlobeAwareDefaultPawn ()
 
virtual void MoveForward (float Val) override
 Input callback to move forward in local space (or backward if Val is negative).
 
virtual void MoveRight (float Val) override
 Input callback to strafe right in local space (or left if Val is negative).
 
virtual void MoveUp_World (float Val) override
 Input callback to move up in world space (or down if Val is negative).
 
virtual FRotator GetViewRotation () const override
 Gets the absolute rotation of the camera view from the Unreal world.
 
virtual FRotator GetBaseAimRotation () const override
 Gets the rotation of the aim direction, which is the same as the View Rotation.
 
const FTransform & GetGlobeToUnrealWorldTransform () const
 Gets the transformation from globe's reference frame to the Unreal world (relative to the floating origin).
 
void FlyToLocationECEF (const FVector &ECEFDestination, double YawAtDestination, double PitchAtDestination, bool CanInterruptByMoving)
 Begin a smooth camera flight to the given Earth-Centered, Earth-Fixed (ECEF) destination such that the camera ends at the specified yaw and pitch.
 
void FlyToLocationLongitudeLatitudeHeight (const FVector &LongitudeLatitudeHeightDestination, double YawAtDestination, double PitchAtDestination, bool CanInterruptByMoving)
 Begin a smooth camera flight to the given WGS84 longitude in degrees (x), latitude in degrees (y), and height in meters (z) such that the camera ends at the given yaw and pitch.
 

Public Attributes

float FlyToGranularityDegrees_DEPRECATED = 0.01f
 
FCompletedFlight OnFlightComplete_DEPRECATED
 
FInterruptedFlight OnFlightInterrupt_DEPRECATED
 

Protected Member Functions

virtual void Serialize (FArchive &Ar) override
 
virtual void PostLoad () override
 
ACesiumGeoreferenceGetGeoreference () const
 Gets the Georeference Actor associated with this instance.
 

Protected Attributes

ACesiumGeoreferenceGeoreference_DEPRECATED
 THIS PROPERTY IS DEPRECATED.
 
UCesiumGlobeAnchorComponentGlobeAnchor
 The Globe Anchor Component that precisely ties this Pawn to the Globe.
 

Detailed Description

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.

Definition at line 36 of file GlobeAwareDefaultPawn.h.

Constructor & Destructor Documentation

◆ AGlobeAwareDefaultPawn()

AGlobeAwareDefaultPawn::AGlobeAwareDefaultPawn ( )

Member Function Documentation

◆ FlyToLocationECEF()

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

Begin a smooth camera flight to the given Earth-Centered, Earth-Fixed (ECEF) destination such that the camera ends at the specified yaw and pitch.

The characteristics of the flight can be configured with {

See also
FlyToAltitudeProfileCurve}, {
FlyToProgressCurve}, {
FlyToMaximumAltitudeCurve}, and {
FlyToDuration}

◆ FlyToLocationLongitudeLatitudeHeight()

void AGlobeAwareDefaultPawn::FlyToLocationLongitudeLatitudeHeight ( const FVector & LongitudeLatitudeHeightDestination,
double YawAtDestination,
double PitchAtDestination,
bool CanInterruptByMoving )

Begin a smooth camera flight to the given WGS84 longitude in degrees (x), latitude in degrees (y), and height in meters (z) such that the camera ends at the given yaw and pitch.

The characteristics of the flight can be configured with {

See also
FlyToAltitudeProfileCurve}, {
FlyToProgressCurve}, {
FlyToMaximumAltitudeCurve}, {
FlyToDuration}, and {
FlyToGranularityDegrees}.

◆ GetBaseAimRotation()

virtual FRotator AGlobeAwareDefaultPawn::GetBaseAimRotation ( ) const
overridevirtual

Gets the rotation of the aim direction, which is the same as the View Rotation.

◆ GetGeoreference()

ACesiumGeoreference * AGlobeAwareDefaultPawn::GetGeoreference ( ) const
protected

Gets the Georeference Actor associated with this instance.

It is obtained from the Globe Anchor Component.

◆ GetGlobeToUnrealWorldTransform()

const FTransform & AGlobeAwareDefaultPawn::GetGlobeToUnrealWorldTransform ( ) const

Gets the transformation from globe's reference frame to the Unreal world (relative to the floating origin).

This is equivalent to calling GetActorTransform on this pawn's attach parent, if it has one. If this pawn does not have an attach parent, an identity transformation is returned.

◆ GetViewRotation()

virtual FRotator AGlobeAwareDefaultPawn::GetViewRotation ( ) const
overridevirtual

Gets the absolute rotation of the camera view from the Unreal world.

◆ MoveForward()

virtual void AGlobeAwareDefaultPawn::MoveForward ( float Val)
overridevirtual

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

Parameters
ValAmount of movement in the forward direction (or backward if negative).
See also
APawn::AddMovementInput()

◆ MoveRight()

virtual void AGlobeAwareDefaultPawn::MoveRight ( float Val)
overridevirtual

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

Parameters
ValAmount of movement in the right direction (or left if negative).
See also
APawn::AddMovementInput()

◆ MoveUp_World()

virtual void AGlobeAwareDefaultPawn::MoveUp_World ( float Val)
overridevirtual

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

Parameters
ValAmount of movement in the world up direction (or down if negative).
See also
APawn::AddMovementInput()

◆ PostLoad()

virtual void AGlobeAwareDefaultPawn::PostLoad ( )
overrideprotectedvirtual

◆ Serialize()

virtual void AGlobeAwareDefaultPawn::Serialize ( FArchive & Ar)
overrideprotectedvirtual

Member Data Documentation

◆ FlyToGranularityDegrees_DEPRECATED

float AGlobeAwareDefaultPawn::FlyToGranularityDegrees_DEPRECATED = 0.01f

Definition at line 82 of file GlobeAwareDefaultPawn.h.

◆ Georeference_DEPRECATED

ACesiumGeoreference* AGlobeAwareDefaultPawn::Georeference_DEPRECATED
protected

THIS PROPERTY IS DEPRECATED.

Get the Georeference instance from the Globe Anchor Component instead.

Definition at line 165 of file GlobeAwareDefaultPawn.h.

◆ GlobeAnchor

UCesiumGlobeAnchorComponent* AGlobeAwareDefaultPawn::GlobeAnchor
protected

The Globe Anchor Component that precisely ties this Pawn to the Globe.

Definition at line 178 of file GlobeAwareDefaultPawn.h.

◆ OnFlightComplete_DEPRECATED

FCompletedFlight AGlobeAwareDefaultPawn::OnFlightComplete_DEPRECATED

Definition at line 90 of file GlobeAwareDefaultPawn.h.

◆ OnFlightInterrupt_DEPRECATED

FInterruptedFlight AGlobeAwareDefaultPawn::OnFlightInterrupt_DEPRECATED

Definition at line 98 of file GlobeAwareDefaultPawn.h.


The documentation for this class was generated from the following file: