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

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

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

Syntax

UCLASS (HideCategories=(Transform, Replication, Actor, Cooking))  
class AGeoReferencingSystem : public AInfo

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

AGeoReferencingSystem ( const FObjectInitializer& ObjectInitializer
)

   GeoReferencingSystem.h  

Classes

Name Remarks
FGeoReferencingSystemInternals  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bOriginAtPlanetCenter bool 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. GeoReferencingSystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="GeoReferencing|Origin Location"
  • Meta=(EditConditionHides, EditCondition="PlanetShape==EPlanetShape::RoundPlanet")
bOriginLocationInProjectedCRS bool If true, the UE origin georeference is expressed in the PROJECTED CRS. GeoReferencingSystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="GeoReferencing|Origin Location"
  • Meta=(EditConditionHides, EditCondition="bOriginAtPlanetCenter==false")
GeographicCRS FString String that describes the GEOGRAPHIC CRS of choice. GeoReferencingSystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Config
  • Category="GeoReferencing"
OriginAltitude double Altitude of UE Origin on planet GeoReferencingSystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="GeoReferencing|Origin Location"
  • Meta=(EditConditionHides, EditCondition="!bOriginLocationInProjectedCRS && !bOriginAtPlanetCenter")
OriginLatitude double Latitude of UE Origin on planet GeoReferencingSystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="GeoReferencing|Origin Location"
  • Meta=(EditConditionHides, EditCondition="!bOriginLocationInProjectedCRS && !bOriginAtPlanetCenter", ClampMin="-90", ClampMax="90")
OriginLongitude double Longitude of UE Origin on planet GeoReferencingSystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="GeoReferencing|Origin Location"
  • Meta=(EditConditionHides, EditCondition="!bOriginLocationInProjectedCRS && !bOriginAtPlanetCenter", ClampMin="-180", ClampMax="180")
OriginProjectedCoordinatesEasting double Easting position of UE Origin on planet, express in the Projected CRS Frame GeoReferencingSystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="GeoReferencing|Origin Location"
  • Meta=(EditConditionHides, EditCondition="bOriginLocationInProjectedCRS && !bOriginAtPlanetCenter")
OriginProjectedCoordinatesNorthing double Northing position of UE Origin on planet, express in the Projected CRS Frame GeoReferencingSystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="GeoReferencing|Origin Location"
  • Meta=(EditConditionHides, EditCondition="bOriginLocationInProjectedCRS && !bOriginAtPlanetCenter")
OriginProjectedCoordinatesUp double Up position of UE Origin on planet, express in the Projected CRS Frame GeoReferencingSystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="GeoReferencing|Origin Location"
  • Meta=(EditConditionHides, EditCondition="bOriginLocationInProjectedCRS && !bOriginAtPlanetCenter")
PlanetShape EPlanetShape This mode has to be set consistently with the way you authored your ground geometry. GeoReferencingSystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="GeoReferencing"
ProjectedCRS FString String that describes the PROJECTED CRS of choice. GeoReferencingSystem.h
  • EditAnywhere
  • BlueprintReadWrite
  • Config
  • Category="GeoReferencing"

Protected

Name Type Remarks Include Path Unreal Specifiers
Impl TPimplPtr< FGeoReferencingSystemInternals >   GeoReferencingSystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplySettings ()

 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. GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Misc"
  • Meta=(DisplayName="Apply Runtime Changes")

void ECEFToEngine ( const FVector& ECEFCoordinates,
FVector& EngineCoordinates
)

 Convert a Vector expressed in ECEF CRS to ENGINE space GeoReferencingSystem.h  

void ECEFToGeographic ( const FVector& ECEFCoordinates,
FGeographicCoordinates& GeographicCoordinates
)

 Convert a Coordinate expressed in ECEF CRS to GEOGRAPHIC CRS GeoReferencingSystem.h  

void ECEFToProjected ( const FVector& ECEFCoordinates,
FVector& ProjectedCoordinates
)

 Convert a Coordinate expressed in ECEF CRS to PROJECTED CRS GeoReferencingSystem.h  

void EngineToECEF ( const FVector& EngineCoordinates,
FVector& ECEFCoordinates
)

 Convert a Vector expressed in ENGINE space to the ECEF CRS GeoReferencingSystem.h  

void EngineToGeographic ( const FVector& EngineCoordinates,
FGeographicCoordinates& GeographicCoordinates
)

 Convert a Vector expressed in ENGINE space to the GEOGRAPHIC CRS GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Transformations"

void EngineToProjected ( const FVector& EngineCoordinates,
FVector& ProjectedCoordinates
)

 Convert a Vector expressed in ENGINE space to the PROJECTED CRS GeoReferencingSystem.h  

void GeographicToECEF ( const FGeographicCoordinates& GeographicCoordinates,
FVector& ECEFCoordinates
)

 Convert a Coordinate expressed in GEOGRAPHIC CRS to ECEF CRS GeoReferencingSystem.h  

void GeographicToEngine ( const FGeographicCoordinates& GeographicCoordinates,
FVector& EngineCoordinates
)

 Convert a Vector expressed in GEOGRAPHIC CRS to ENGINE space GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Transformations"

void GeographicToProjected ( const FGeographicCoordinates& GeographicCoordinates,
FVector& ProjectedCoordinates
)

 Convert a Coordinate expressed in GEOGRAPHIC CRS to PROJECTED CRS GeoReferencingSystem.h  

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 ! GeoReferencingSystem.h  

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

 Get the East North Up vectors at a specific location GeoReferencingSystem.h  

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

 Get the East North Up vectors at a specific location GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|ENU"

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

 Get the East North Up vectors at a specific location GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|ENU"

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

 Get the East North Up vectors at a specific location GeoReferencingSystem.h  

double GetGeographicEllipsoidMaxRadius()

 Find the underlying Geographic CRS Ellipsoid and return its maximum radius GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Ellipsoid"

double GetGeographicEllipsoidMinRadius()

 Find the underlying Geographic CRS Ellipsoid and return its minimum radius GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Ellipsoid"

FTransform GetPlanetCenterTransform()

 Set this transform to an Ellipsoid to have it positioned tangent to the origin. GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Misc"

double GetProjectedEllipsoidMaxRadius()

 Find the underlying Projected CRS Ellipsoid and return its maximum radius GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Ellipsoid"

double GetProjectedEllipsoidMinRadius()

 Find the underlying Projected CRS Ellipsoid and return its minimum radius GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Ellipsoid"

FTransform GetTangentTransformAtECEFLocation ( const FVector& ECEFCoordinates
)

 Get the the transform to locate an object tangent to Ellipsoid at a specific location GeoReferencingSystem.h  

FTransform GetTangentTransformAtEngineLocation ( const FVector& EngineCoordinates
)

 Get the the transform to locate an object tangent to Ellipsoid at a specific location GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|TangentTransforms"

FTransform GetTangentTransformAtGeographicLocation ( const FGeographicCoordinates& GeographicCoordinates
)

 Get the the transform to locate an object tangent to Ellipsoid at a specific location GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|TangentTransforms"

FTransform GetTangentTransformAtProjectedLocation ( const FVector& ProjectedCoordinates
)

 Get the the transform to locate an object tangent to Ellipsoid at a specific location GeoReferencingSystem.h  

bool IsCRSStringValid ( FString CRSString,
FString& Error
)

 Check if the string corresponds to a valid CRS descriptor GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Misc"

void K2_ECEFToEngine ( const FVector& ECEFCoordinates,
FVector& EngineCoordinates
)

 Convert a Vector expressed in ECEF CRS to ENGINE space GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Transformations"
  • Meta=(DisplayName="ECEF To Engine")

void K2_ECEFToGeographic ( const FVector& ECEFCoordinates,
FGeographicCoordinates& GeographicCoordinates
)

 Convert a Coordinate expressed in ECEF CRS to GEOGRAPHIC CRS GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Transformations"
  • Meta=(DisplayName="ECEF To Geographic")

void K2_ECEFToProjected ( const FVector& ECEFCoordinates,
FVector& ProjectedCoordinates
)

 Convert a Coordinate expressed in ECEF CRS to PROJECTED CRS GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Transformations"
  • Meta=(DisplayName="ECEF To Projected")

void K2_EngineToECEF ( const FVector& EngineCoordinates,
FVector& ECEFCoordinates
)

 Convert a Vector expressed in ENGINE space to the ECEF CRS GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Transformations"
  • Meta=(DisplayName="Engine To ECEF")

void K2_EngineToProjected ( const FVector& EngineCoordinates,
FVector& ProjectedCoordinates
)

 We want to keep the same function names, but with a change in some argument types. GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Transformations"
  • Meta=(DisplayName="Engine To Projected")

void K2_GeographicToECEF ( const FGeographicCoordinates& GeographicCoordinates,
FVector& ECEFCoordinates
)

 Convert a Coordinate expressed in GEOGRAPHIC CRS to ECEF CRS GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Transformations"
  • Meta=(DisplayName="Geographic To ECEF")

void K2_GeographicToProjected ( const FGeographicCoordinates& GeographicCoordinates,
FVector& ProjectedCoordinates
)

 Convert a Coordinate expressed in GEOGRAPHIC CRS to PROJECTED CRS GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Transformations"
  • Meta=(DisplayName="Geographic To Projected")

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 ! GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|ENU"
  • Meta=(DisplayName="Get ECEF ENU Vectors At ECEF Location")

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

 Get the East North Up vectors at a specific location GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|ENU"
  • Meta=(DisplayName="Get ENU Vectors At ECEF Location")

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

 Get the East North Up vectors at a specific location GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|ENU"
  • Meta=(DisplayName="Get ENU Vectors At Projected Location")

FTransform K2_GetTangentTransformAtECEFLocation ( const FVector& ECEFCoordinates
)

 Get the the transform to locate an object tangent to Ellipsoid at a specific location GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|TangentTransforms"
  • Meta=(DisplayName="Get Tangent Transform At ECEFLocation")

FTransform K2_GetTangentTransformAtProjectedLocation ( const FVector& ProjectedCoordinates
)

 Get the the transform to locate an object tangent to Ellipsoid at a specific location GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|TangentTransforms"
  • Meta=(DisplayName="Get Tangent Transform At Projected Location")

void K2_ProjectedToECEF ( const FVector& ProjectedCoordinates,
FVector& ECEFCoordinates
)

 Convert a Coordinate expressed in PROJECTED CRS to ECEF CRS GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Transformations"
  • Meta=(DisplayName="Projected To ECEF")

void K2_ProjectedToEngine ( const FVector& ProjectedCoordinates,
FVector& EngineCoordinates
)

 Convert a Vector expressed in PROJECTED CRS to ENGINE space GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Transformations"
  • Meta=(DisplayName="Projected To Engine")

void K2_ProjectedToGeographic ( const FVector& ProjectedCoordinates,
FGeographicCoordinates& GeographicCoordinates
)

 Convert a Coordinate expressed in PROJECTED CRS to GEOGRAPHIC CRS GeoReferencingSystem.h
  • BlueprintCallable
  • Category="GeoReferencing|Transformations"
  • Meta=(DisplayName="Projected To Geographic")

void ProjectedToECEF ( const FVector& ProjectedCoordinates,
FVector& ECEFCoordinates
)

 Convert a Coordinate expressed in PROJECTED CRS to ECEF CRS GeoReferencingSystem.h  

void ProjectedToEngine ( const FVector& ProjectedCoordinates,
FVector& EngineCoordinates
)

 Convert a Vector expressed in PROJECTED CRS to ENGINE space GeoReferencingSystem.h  

void ProjectedToGeographic ( const FVector& ProjectedCoordinates,
FGeographicCoordinates& GeographicCoordinates
)

 Convert a Coordinate expressed in PROJECTED CRS to GEOGRAPHIC CRS GeoReferencingSystem.h  

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void PostActorCreated()

   GeoReferencingSystem.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   GeoReferencingSystem.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   GeoReferencingSystem.h  

virtual void PostLoad()

   GeoReferencingSystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static AGeoReferencingSystem * GetGeoReferencingSystem ( UObject* WorldContextObject
)

   GeoReferencingSystem.h
  • BlueprintPure
  • Category="GeoReferencing"
  • Meta=(WorldContext="WorldContextObject")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page