1. Epic GamesDeveloper
  3. AGeoReferencingSystem

AGeoReferencingSystem

This AInfos enable you to define a correspondance between the UE origin and an actual geographic location on a planet Once done it offers different functions to convert coordinates between UE and Geographic coordinates

API > API/Plugins > API/Plugins/GeoReferencing

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;HideCategories&61;&40;Transform, Replication, Actor, Cooking&41;&41;  
class AGeoReferencingSystem : public AInfo

Remarks

This AInfos enable you to define a correspondance between the UE origin and an actual geographic location on a planet Once done it offers different functions to convert coordinates between UE and Geographic coordinates

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bOriginAtPlanetCenter If true, the UE origin is located at the Planet Center, otherwise, the UE origin is assuming to be defined at one specific point of the planet surface, defined by the properties below.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bOriginLocationInProjectedCRS If true, the UE origin georeference is expressed in the PROJECTED CRS.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite Config FString GeographicCRS String that describes the GEOGRAPHIC CRS of choice.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite double OriginAltitude Altitude of UE Origin on planet
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite double OriginLatitude Latitude of UE Origin on planet
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite double OriginLongitude Longitude of UE Origin on planet
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite double OriginProjectedCoordinatesEasting Easting position of UE Origin on planet, express in the Projected CRS Frame
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite double OriginProjectedCoordinatesNorthing Northing position of UE Origin on planet, express in the Projected CRS Frame
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite double OriginProjectedCoordinatesUp Up position of UE Origin on planet, express in the Projected CRS Frame
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EPlanetShape PlanetShape This mode has to be set consistently with the way you authored your ground geometry.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite Config FString ProjectedCRS String that describes the PROJECTED CRS of choice.

Constructors

  Type Name Description
Public function  

AGeoReferencingSystem ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category, Meta void In case you want to change the Origin or CRS definition properties during application execution, you need to call this function to update the internal transformation cache.
Public function void

ECEFToEngine ( const FVector& ECEFCoordinates,
FVector& EngineCoordinates
)

 Convert a Vector expressed in ECEF CRS to ENGINE space
Public function void

ECEFToGeographic ( const FVector& ECEFCoordinates,
FGeographicCoordinates& GeographicCoordinates
)

 Convert a Coordinate expressed in ECEF CRS to GEOGRAPHIC CRS
Public function void

ECEFToProjected ( const FVector& ECEFCoordinates,
FVector& ProjectedCoordinates
)

 Convert a Coordinate expressed in ECEF CRS to PROJECTED CRS
Public function void

EngineToECEF ( const FVector& EngineCoordinates,
FVector& ECEFCoordinates
)

 Convert a Vector expressed in ENGINE space to the ECEF CRS
Public function UFunction BlueprintCallable, Category void

EngineToGeographic ( const FVector& EngineCoordinates,
FGeographicCoordinates& GeographicCoordinates
)

 Convert a Vector expressed in ENGINE space to the GEOGRAPHIC CRS
Public function void

EngineToProjected ( const FVector& EngineCoordinates,
FVector& ProjectedCoordinates
)

 Convert a Vector expressed in ENGINE space to the PROJECTED CRS
Public function void

GeographicToECEF ( const FGeographicCoordinates& GeographicCoordinates,
FVector& ECEFCoordinates
)

 Convert a Coordinate expressed in GEOGRAPHIC CRS to ECEF CRS
Public function UFunction BlueprintCallable, Category void

GeographicToEngine ( const FGeographicCoordinates& GeographicCoordinates,
FVector& EngineCoordinates
)

 Convert a Vector expressed in GEOGRAPHIC CRS to ENGINE space
Public function void

GeographicToProjected ( const FGeographicCoordinates& GeographicCoordinates,
FVector& ProjectedCoordinates
)

 Convert a Coordinate expressed in GEOGRAPHIC CRS to PROJECTED CRS
Public function void

GetECEFENUVectorsAtECEFLocation ( const FVector& ECEFCoordinates,
FVector& ECEFEast,
FVector& ECEFNorth,
FVector& ECEFUp
)

 Get the East North Up vectors at a specific location - Not in engine frame, but in pure ECEF Frame !
Public function void

GetENUVectorsAtECEFLocation ( const FVector& ECEFCoordinates,
FVector& East,
FVector& North,
FVector& Up
)

 Get the East North Up vectors at a specific location
Public function UFunction BlueprintCallable, Category void

GetENUVectorsAtEngineLocation ( const FVector& EngineCoordinates,
FVector& East,
FVector& North,
FVector& Up
)

 Get the East North Up vectors at a specific location
Public function UFunction BlueprintCallable, Category void

GetENUVectorsAtGeographicLocation ( const FGeographicCoordinates& GeographicCoordinates,
FVector& East,
FVector& North,
FVector& Up
)

 Get the East North Up vectors at a specific location
Public function void

GetENUVectorsAtProjectedLocation ( const FVector& ProjectedCoordinates,
FVector& East,
FVector& North,
FVector& Up
)

 Get the East North Up vectors at a specific location
Public function UFunction BlueprintCallable, Category double Find the underlying Geographic CRS Ellipsoid and return its maximum radius
Public function UFunction BlueprintCallable, Category double Find the underlying Geographic CRS Ellipsoid and return its minimum radius
Public function Static UFunction BlueprintPure, Category, Meta AGeoReferencingSystem *

GetGeoReferencingSystem ( UObject* WorldContextObject
)

  
Public function UFunction BlueprintCallable, Category FTransform Set this transform to an Ellipsoid to have it positioned tangent to the origin.
Public function UFunction BlueprintCallable, Category double Find the underlying Projected CRS Ellipsoid and return its maximum radius
Public function UFunction BlueprintCallable, Category double Find the underlying Projected CRS Ellipsoid and return its minimum radius
Public function FTransform

GetTangentTransformAtECEFLocation ( const FVector& ECEFCoordinates
)

 Get the the transform to locate an object tangent to Ellipsoid at a specific location
Public function UFunction BlueprintCallable, Category FTransform

GetTangentTransformAtEngineLocation ( const FVector& EngineCoordinates
)

 Get the the transform to locate an object tangent to Ellipsoid at a specific location
Public function UFunction BlueprintCallable, Category FTransform Get the the transform to locate an object tangent to Ellipsoid at a specific location
Public function FTransform

GetTangentTransformAtProjectedLocation ( const FVector& ProjectedCoordinates
)

 Get the the transform to locate an object tangent to Ellipsoid at a specific location
Public function UFunction BlueprintCallable, Category bool

IsCRSStringValid ( FString CRSString,
FString& Error
)

 Check if the string corresponds to a valid CRS descriptor
Public function UFunction BlueprintCallable, Category, Meta void

K2_ECEFToEngine ( const FVector& ECEFCoordinates,
FVector& EngineCoordinates
)

 Convert a Vector expressed in ECEF CRS to ENGINE space
Public function UFunction BlueprintCallable, Category, Meta void

K2_ECEFToGeographic ( const FVector& ECEFCoordinates,
FGeographicCoordinates& GeographicCoordinates
)

 Convert a Coordinate expressed in ECEF CRS to GEOGRAPHIC CRS
Public function UFunction BlueprintCallable, Category, Meta void

K2_ECEFToProjected ( const FVector& ECEFCoordinates,
FVector& ProjectedCoordinates
)

 Convert a Coordinate expressed in ECEF CRS to PROJECTED CRS
Public function UFunction BlueprintCallable, Category, Meta void

K2_EngineToECEF ( const FVector& EngineCoordinates,
FVector& ECEFCoordinates
)

 Convert a Vector expressed in ENGINE space to the ECEF CRS
Public function UFunction BlueprintCallable, Category, Meta void

K2_EngineToProjected ( const FVector& EngineCoordinates,
FVector& ProjectedCoordinates
)

 We want to keep the same function names, but with a change in some argument types.
Public function UFunction BlueprintCallable, Category, Meta void

K2_GeographicToECEF ( const FGeographicCoordinates& GeographicCoordinates,
FVector& ECEFCoordinates
)

 Convert a Coordinate expressed in GEOGRAPHIC CRS to ECEF CRS
Public function UFunction BlueprintCallable, Category, Meta void

K2_GeographicToProjected ( const FGeographicCoordinates& GeographicCoordinates,
FVector& ProjectedCoordinates
)

 Convert a Coordinate expressed in GEOGRAPHIC CRS to PROJECTED CRS
Public function UFunction BlueprintCallable, Category, Meta void

K2_GetECEFENUVectorsAtECEFLocation ( const FVector& ECEFCoordinates,
FVector& ECEFEast,
FVector& ECEFNorth,
FVector& ECEFUp
)

 Get the East North Up vectors at a specific location - Not in engine frame, but in pure ECEF Frame !
Public function UFunction BlueprintCallable, Category, Meta void

K2_GetENUVectorsAtECEFLocation ( const FVector& ECEFCoordinates,
FVector& East,
FVector& North,
FVector& Up
)

 Get the East North Up vectors at a specific location
Public function UFunction BlueprintCallable, Category, Meta void

K2_GetENUVectorsAtProjectedLocation ( const FVector& ProjectedCoordinates,
FVector& East,
FVector& North,
FVector& Up
)

 Get the East North Up vectors at a specific location
Public function UFunction BlueprintCallable, Category, Meta FTransform

K2_GetTangentTransformAtECEFLocation ( const FVector& ECEFCoordinates
)

 Get the the transform to locate an object tangent to Ellipsoid at a specific location
Public function UFunction BlueprintCallable, Category, Meta FTransform

K2_GetTangentTransformAtProjectedLocation ( const FVector& ProjectedCoordinates
)

 Get the the transform to locate an object tangent to Ellipsoid at a specific location
Public function UFunction BlueprintCallable, Category, Meta void

K2_ProjectedToECEF ( const FVector& ProjectedCoordinates,
FVector& ECEFCoordinates
)

 Convert a Coordinate expressed in PROJECTED CRS to ECEF CRS
Public function UFunction BlueprintCallable, Category, Meta void

K2_ProjectedToEngine ( const FVector& ProjectedCoordinates,
FVector& EngineCoordinates
)

 Convert a Vector expressed in PROJECTED CRS to ENGINE space
Public function UFunction BlueprintCallable, Category, Meta void

K2_ProjectedToGeographic ( const FVector& ProjectedCoordinates,
FGeographicCoordinates& GeographicCoordinates
)

 Convert a Coordinate expressed in PROJECTED CRS to GEOGRAPHIC CRS
Public function void

ProjectedToECEF ( const FVector& ProjectedCoordinates,
FVector& ECEFCoordinates
)

 Convert a Coordinate expressed in PROJECTED CRS to ECEF CRS
Public function void

ProjectedToEngine ( const FVector& ProjectedCoordinates,
FVector& EngineCoordinates
)

 Convert a Vector expressed in PROJECTED CRS to ENGINE space
Public function void

ProjectedToGeographic ( const FVector& ProjectedCoordinates,
FGeographicCoordinates& GeographicCoordinates
)

 Convert a Coordinate expressed in PROJECTED CRS to GEOGRAPHIC CRS

Overridden from AActor

  Type Name Description
Public function Virtual void Called when an actor is done spawning into the world (from UWorld::SpawnActor), both in the editor and during gameplay For actors with a root component, the location and rotation will have already been set.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Classes

  Type Name Description
Public class FGeoReferencingSystemInternals    

Deprecated Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category, Meta void

ECEFToEngine ( const FCartesianCoordinates& ECEFCoordinates,
FVector& EngineCoordinates
)

 FCartesianCoordinates is deprecated : Use the version that uses a FVector instead.
Public function UFunction BlueprintCallable, Category, Meta void

ECEFToGeographic ( const FCartesianCoordinates& ECEFCoordinates,
FGeographicCoordinates& GeographicCoordinates
)

 FCartesianCoordinates is deprecated : Use the version that uses a FVector instead.
Public function UFunction BlueprintCallable, Category, Meta void

ECEFToProjected ( const FCartesianCoordinates& ECEFCoordinates,
FCartesianCoordinates& ProjectedCoordinates
)

 FCartesianCoordinates is deprecated : Use the version that uses a FVector instead.
Public function UFunction BlueprintCallable, Category, Meta void

EngineToECEF ( const FVector& EngineCoordinates,
FCartesianCoordinates& ECEFCoordinates
)

 FCartesianCoordinates is deprecated : Use the version that uses a FVector instead.
Public function UFunction BlueprintCallable, Category, Meta PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid

EngineToProjected ( const FVector& EngineCoordinates,
FCartesianCoordinates& ProjectedCoordinates
)

 FCartesianCoordinates is deprecated : Use the version that uses a FVector instead.
Public function UFunction BlueprintCallable, Category, Meta void

GeographicToECEF ( const FGeographicCoordinates& GeographicCoordinates,
FCartesianCoordinates& ECEFCoordinates
)

 FCartesianCoordinates is deprecated : Use the version that uses a FVector instead.
Public function UFunction BlueprintCallable, Category, Meta void

GeographicToProjected ( const FGeographicCoordinates& GeographicCoordinates,
FCartesianCoordinates& ProjectedCoordinates
)

 FCartesianCoordinates is deprecated : Use the version that uses a FVector instead.
Public function UFunction BlueprintCallable, Category, Meta void

GetECEFENUVectorsAtECEFLocation ( const FCartesianCoordinates& ECEFCoordinates,
FVector& ECEFEast,
FVector& ECEFNorth,
FVector& ECEFUp
)

 FCartesianCoordinates is deprecated : Use the version that uses a FVector instead.
Public function UFunction BlueprintCallable, Category, Meta void

GetENUVectorsAtECEFLocation ( const FCartesianCoordinates& ECEFCoordinates,
FVector& East,
FVector& North,
FVector& Up
)

 FCartesianCoordinates is deprecated : Use the version that uses a FVector instead.
Public function UFunction BlueprintCallable, Category, Meta void

GetENUVectorsAtProjectedLocation ( const FCartesianCoordinates& ProjectedCoordinates,
FVector& East,
FVector& North,
FVector& Up
)

 FCartesianCoordinates is deprecated : Use the version that uses a FVector instead.
Public function UFunction BlueprintCallable, Category, Meta FTransform FCartesianCoordinates is deprecated : Use the version that uses a FVector instead.
Public function UFunction BlueprintCallable, Category, Meta FTransform FCartesianCoordinates is deprecated : Use the version that uses a FVector instead.
Public function UFunction BlueprintCallable, Category, Meta void

ProjectedToECEF ( const FCartesianCoordinates& ProjectedCoordinates,
FCartesianCoordinates& ECEFCoordinates
)

 FCartesianCoordinates is deprecated : Use the version that uses a FVector instead.
Public function UFunction BlueprintCallable, Category, Meta void

ProjectedToEngine ( const FCartesianCoordinates& ProjectedCoordinates,
FVector& EngineCoordinates
)

 FCartesianCoordinates is deprecated : Use the version that uses a FVector instead.
Public function UFunction BlueprintCallable, Category, Meta void

ProjectedToGeographic ( const FCartesianCoordinates& ProjectedCoordinates,
FGeographicCoordinates& GeographicCoordinates
)

 FCartesianCoordinates is deprecated : Use the version that uses a FVector instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page