unreal.PlanetaryBodyInfo

class unreal.PlanetaryBodyInfo(orbit_type: OrbitType = Ellipsis, name: str = '', radius: float = 0.0, ra: float = 0.0, dec: float = 0.0, distance_in_au: float = 0.0, apparent_diameter_degrees: float = 0.0, scaled_apparent_diameter_degrees: float = 0.0, apparent_magnitude: float = 0.0, age: float = 0.0, illumination_percentage: float = 0.0, ism_instance_index: int = 0, ue_transform: Transform = Ellipsis, direction_toward_earth: Vector = Ellipsis)

Bases: StructBase

Runtime structure to store the computed properties of a Planetary Body, for any Query.

C++ Source:

• Plugin: CelestialVault

• Module: CelestialVault

• File: CelestialDataTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

• age (double): [Read-Write] indication of the lunar age. 0 = New Moon, 0.25 = First quarter, 0.5 = Full Moon, 1 = Next New Moon

• apparent_diameter_degrees (double): [Read-Write] The True apparent diameter of the body seen from Earth (Angular size, in degrees)

• apparent_magnitude (double): [Read-Write] The Magnitude of the body seen from Earth

• dec (double): [Read-Write] The Body Declination in the Celestial Frame - In Degrees

• direction_toward_earth (Vector): [Read-Write] Keep track of the location toward the Earth

• distance_in_au (double): [Read-Write] The Body distance to Earth - In Astronomical Units!

• illumination_percentage (double): [Read-Write] indication of percentage of a full moon illumination

• ism_instance_index (int32): [Read-Write] Internal value of the ISM Instance corresponding to this planet

• name (str): [Read-Write] The body Name

• orbit_type (OrbitType): [Read-Write] One of the predefined body types (Solar system planets), any custom one for fantasy planets

• ra (double): [Read-Write] The Body Right Ascension in the Celestial Frame - In hours!

• radius (double): [Read-Write] The Body Radius in Kilometers

• scaled_apparent_diameter_degrees (double): [Read-Write] The Scaled apparent diameter of the body seen from Earth (Angular size, in degrees)

  Takes the fake scaling factor into consideration, so useful for camera FOV tracking.

• ue_transform (Transform): [Read-Write] Keep track of the Vault-relative transform, at ToD = 0 for animated bodies (Moon)

property age: float

[Read-Write] indication of the lunar age. 0 = New Moon, 0.25 = First quarter, 0.5 = Full Moon, 1 = Next New Moon

Type:

(double)

property apparent_diameter_degrees: float

[Read-Write] The True apparent diameter of the body seen from Earth (Angular size, in degrees)

Type:

(double)

property apparent_magnitude: float

[Read-Write] The Magnitude of the body seen from Earth

Type:

(double)

property dec: float

[Read-Write] The Body Declination in the Celestial Frame - In Degrees

Type:

(double)

property direction_toward_earth: Vector

[Read-Write] Keep track of the location toward the Earth

Type:

(Vector)

property distance_in_au: float

[Read-Write] The Body distance to Earth - In Astronomical Units!

Type:

(double)

property illumination_percentage: float

[Read-Write] indication of percentage of a full moon illumination

Type:

(double)

property ism_instance_index: int

[Read-Write] Internal value of the ISM Instance corresponding to this planet

Type:

(int32)

property name: str

[Read-Write] The body Name

Type:

(str)

property orbit_type: OrbitType

[Read-Write] One of the predefined body types (Solar system planets), any custom one for fantasy planets

Type:

(OrbitType)

property ra: float

[Read-Write] The Body Right Ascension in the Celestial Frame - In hours!

Type:

(double)

property radius: float

[Read-Write] The Body Radius in Kilometers

Type:

(double)

property scaled_apparent_diameter_degrees: float

[Read-Write] The Scaled apparent diameter of the body seen from Earth (Angular size, in degrees) Takes the fake scaling factor into consideration, so useful for camera FOV tracking.

Type:

(double)

property ue_transform: Transform

[Read-Write] Keep track of the Vault-relative transform, at ToD = 0 for animated bodies (Moon)

Type:

(Transform)