FCelestialBody

Runtime structure to store the properties common to all Celestial Bodies

API > API/Plugins > API/Plugins/CelestialVault

Runtime structure to store the properties common to all Celestial Bodies

   
Name FCelestialBody
Type struct
Header File /Engine/Plugins/Runtime/CelestialVault/Source/CelestialVault/Public/CelestialDataTypes.h
Include Path #include "CelestialDataTypes.h"

Syntax

USTRUCT (BlueprintInternalUseOnly)  
struct FCelestialBody

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FCelestialBody()

   CelestialDataTypes.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
DEC double The Body Declination of date (topocentric, from observer lat/lon) CelestialDataTypes.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Celestial Vault"
  • Meta=(ForceUnits="Degrees")
DECGeocentric double The Body Declination of date (geocentric) - used for 3D scene placement. In Degrees. CelestialDataTypes.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Celestial Vault"
  • Meta=(ForceUnits="Degrees")
DECJ2000 double The Body J2000 Declination (topocentric, from observer lat/lon) - In Degrees CelestialDataTypes.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Celestial Vault"
  • Meta=(ForceUnits="Degrees", DisplayName="Declination J2000", MakeStructureDefaultValue="0.000000")
DirectionTowardEarth FVector Keep track of the location toward the Earth CelestialDataTypes.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Celestial Vault"
DistanceInAU double The Body distance to Earth - In Astronomical Units! CelestialDataTypes.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Celestial Vault"
Magnitude double The Magnitude of the Body seen from Earth CelestialDataTypes.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Celestial Vault"
Name FString The Body Name CelestialDataTypes.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Celestial Vault"
OrbitType EOrbitType One of the predefined Orbit types (Solar system planets), any custom one for fantasy planets CelestialDataTypes.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Celestial Vault"
RA double The Body Right Ascension of date (topocentric, from observer lat/lon) CelestialDataTypes.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Celestial Vault"
  • Meta=(ForceUnits="Hours")
Radius double The Body Radius in Kilometers CelestialDataTypes.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Celestial Vault"
  • Meta=(ForceUnits="Kilometers")
RAGeocentric double The Body Right Ascension of date (geocentric) - used for 3D scene placement. In hours. CelestialDataTypes.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Celestial Vault"
  • Meta=(ForceUnits="Hours")
RAJ2000 double The Body J2000 Right Ascension (topocentric, from observer lat/lon) - In hours! CelestialDataTypes.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Celestial Vault"
  • Meta=(ForceUnits="Hours", DisplayName="Right Ascension J2000", MakeStructureDefaultValue="0.000000")
UELocalTransform FTransform Keep track of the Vault-relative transform, at ToD = 0 for animated bodies (Moon) CelestialDataTypes.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Celestial Vault"

Functions

Public

Name Remarks Include Path Unreal Specifiers

FString ToString()

 Can't use a UFUNCTION inside a struct --> Use the Celestial Maths Blueprint Function Library. CelestialDataTypes.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void ComputeUELocalTransform ( double ExtraScale,
double UEDistanceOverride
)

 From the properties of this Celestial Body, compute the associated UE Transform, considering the following arguments CelestialDataTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page