Class in Zendir.Universe | Inherits from UniverseObject
Declaration
class CelestialBody;Description
A celestial body is able to represent a planet, moon, or other celestial object. This will be able to reflect the state of the body and can contribute to the gravitational forces in the simulation.
Properties
| Declared | Description |
|---|---|
| Albedo | Defines the current albedo model that is attached to the body |
| AlbedoAverage | Average Albedo of the Body |
| Atmosphere | Defines the current atmosphere model that is attached to the body |
| AtmosphereType | Defines the current atmosphere type, if enabled |
| AxisInclination | Axial inclination, or tilt, of the body relative to the ecliptic |
| AxisOmega | Angular velocity of the rotation of the body |
| Density | Density of the body |
| Diameter | Equatorial Diameter of the Body |
| IsCentralBody | The central body flag will define if this object is the central origin of the simulation |
| IsSpherical | A flag whether the spherical model is being used for this celestialbody. By default, planets are spherical but can be changed to usenon-spherical models, such as the World Geodetic Model (WGS-84)standard for the Earth. |
| J2 | The measure of the gravitational effect of a planet due toits obliqueness. |
| J2000Rotation | Orientation matrix of planet-fixed relative to inertial frame. Thisis the rotation matrix that can be used to convert between the twocoordinate systems. This is the ‘J20002PFix’ matrix. |
| J2000RotationDot | Derivative of the orientation matrix of planet-fixed relative to inertial.This is the ‘J20002PFix_Dot’ matrix. |
| MagneticField | Defines the current magnetic field model that is attached to the body |
| MagneticFieldType | Defines the current magnetic field type, if enabled |
| Mass | The mass of the gravity body / planet |
| Mu | Gravitational Mu of the body |
| OrbitEccentricity | Eccentricity of the orbit around the sun or parented body |
| OrbitInclination | Inclination of the orbit around the sun or parented body |
| OrbitPeriod | Period of the orbit around the sun or parented body |
| OrbitSemiMajorAxis | Semi Major Axis of the orbit around the sun or parented body |
| Out_PlanetStateMsg | The Planet information about the current state ofthe planet and the information about the planet. |
| PolarRadius | Polar Radius of the Body |
| Radius | Equatorial Radius of the Body |
| SiderealDay | The time between two consecutive meridian crossings of the Sun |
| SolarDay | The time it takes for the body to rotate once relative to the Sun |
| SphericalHarmonics | Defines the current spherical harmonics model that is attached to the body |
| Velocity | The Inertial Velocity of the Body relative to the Central Body |
| Inherited | Description |
|---|---|
| Behaviours | A collection of behaviours attached to this object. |
| Children | A collection of children attached to this object. |
| IsEnabled | Is true if the object is currently enabled. |
| LocalForward | The direction of the transform frame’s forward vector, which is along the Y axis. |
| LocalRight | The direction of the transform frame’s right vector, which is along the X axis. |
| LocalUp | The direction of the transform frame’s up vector, which is along the Z axis. |
| Models | A collection of models attached to this object. |
| Name | The display name or tag of this object. |
| Out_TransformMsg | This defines the base transform message that stores the state of the transform of this object. |
| Parent | The currently attached parent object (if any). |
| Position | [m] The position of the object relative to the parent or to world origin, if no parent exists. |
| Root | The root object in the parent chain. |
| Rotation | [-] The rotation of the object relative to the parent or to the world origin, if no parent exists. |
Methods
| Declared | Description |
|---|---|
| ComputeInertialGravity | Calculates the gravity from this body at some location. |
| ComputePotentialEnergy | Calculates the potential energy of the body at some location. |
| Inherited | Description |
|---|---|
| AddObject | Returns a new simulation object with the specified type. |
| Attach | Attempts to attach this object to a new parent. This will only work if the current object is no parented to anyother object. |
| ContainsModelWithID | Returns true if an attached model satisfies the specified ID. |
| ContainsModelWithType | Returns true if an attached model satisfies the specified type. |
| Destroy | Removes the current object from the simulation. |
| Detach | This is an action to detach the current object from its parent, if it exists and move it to another object or tojust exist within the simulation. |
| FindBehavioursWithType | Returns all attached behaviours that satisfies the specified type. |
| FindBehaviourWithID | Returns an attached behaviour that satisfies the specified ID. |
| FindBehaviourWithType | Returns an attached behaviour that satisfies the specified type. |
| FindChildrenWithType | Returns all attached children that satisfies the specified type. |
| FindChildWithID | Returns an attached child that satisfies the specified ID. |
| FindChildWithType | Returns an attached child that satisfies the specified type. |
| FindModelsWithType | Returns all attached models that satisfies the specified type. |
| FindModelWithID | Returns an attached model that satisfies the specified ID. |
| FindModelWithType | Returns an attached model that satisfies the specified type. |
| FindParentWithID | Returns an attached parent that satisfies the specified ID. |
| FindParentWithType | Returns an attached parent that satisfies the specified type. |
| FindRootWithID | Returns a root object that satisfies the specified ID. |
| FindRootWithType | Returns a root object that satisfies the specified type. |
| GetModel | Returns a valid assigned model with the specified type. |
| GetWorldTransform | Returns the world transform of the object which is relative to the parent. If no parent exists, this will be thetransform of the object in world space. |
| PitchDegrees | Pitches the local transform by some rotation along the X axis. |
| RollDegrees | Rolls the local transform by some rotation along the Y axis. |
| YawDegrees | Yaws the local transform by some rotation along the Z axis. |