Gravity Engine 2 3.0
Loading...
Searching...
No Matches
GravityEngine2.GSDisplayOrbitSegment Class Reference

Displays a segment of an orbit around a central body. More...

Inheritance diagram for GravityEngine2.GSDisplayOrbitSegment:
GravityEngine2.GSDisplayObject

Public Types

enum  OrbitSegmentPoint {
  APOAPSIS , PERIAPSIS , ASC_NODE , DESC_NODE ,
  TRUEANOM_DEG , BODY , RVEC_WORLD
}
 

Public Member Functions

override void AddToSceneDisplay (GSDisplay gsd)
 
override void DisplayEnabledSet (bool value)
 
void DisplaySegment (GECore ge, GSDisplay.MapToSceneFn mapToScene, double t, bool alwaysUpdate)
 Update orbit display points in the line render based on the provided COE. Typically used by GravitySceneController to show an orbit for an existing body.
 
void FromRVecSet (double3 r)
 
Orbital.COE LastCOE ()
 
void RVRelativeSet (double3 r, double3 v)
 Set the relative R, V of the orbit display in GE units.
 
void ToRVecSet (double3 r)
 
- Public Member Functions inherited from GravityEngine2.GSDisplayObject
void AddToSceneDisplay (GSDisplay gsd)
 
bool DisplayEnabled ()
 
int DisplayId ()
 
void DisplayIdSet (int id)
 
GSDisplay GSDisplay ()
 

Public Attributes

GSDisplayBody bodyDisplay
 
BodyInitData bodyInitData = new BodyInitData()
 
GSDisplayBody centerDisplayBody
 
OrbitSegmentPoint fromPoint = OrbitSegmentPoint.TRUEANOM_DEG
 
double3 fromRvec
 
double fromTrueAnomDeg = 0
 
LineRenderer lineR
 
int numPoints = 200
 
OrbitSegmentPoint toPoint = OrbitSegmentPoint.TRUEANOM_DEG
 
double3 toRvec
 
double toTrueAnomDeg = 0
 
GBUnits.Units units
 
- Public Attributes inherited from GravityEngine2.GSDisplayObject
int framesBetweenUpdates = 0
 

Additional Inherited Members

- Protected Attributes inherited from GravityEngine2.GSDisplayObject
bool displayEnabled = true
 
int displayId = -1
 
int framesUntilUpdate = 0
 countdown until this display object shold update
 
GSDisplay gsd
 

Detailed Description

Displays a segment of an orbit around a central body.

The to and from locations can be specified as a true anomaly or by referencing an orbit point type Orbital.OrbitPoint (peri, apo, nodes). Note that not all orbit points are defined for all orbit types (e.g. a circle has no apopapsis).

Member Function Documentation

◆ DisplayEnabledSet()

override void GravityEngine2.GSDisplayOrbitSegment.DisplayEnabledSet ( bool value)
virtual

Reimplemented from GravityEngine2.GSDisplayObject.

◆ DisplaySegment()

void GravityEngine2.GSDisplayOrbitSegment.DisplaySegment ( GECore ge,
GSDisplay::MapToSceneFn mapToScene,
double t,
bool alwaysUpdate )

Update orbit display points in the line render based on the provided COE. Typically used by GravitySceneController to show an orbit for an existing body.

Parameters
gsd
coeCOE in world units
geToSceneScale

◆ RVRelativeSet()

void GravityEngine2.GSDisplayOrbitSegment.RVRelativeSet ( double3 r,
double3 v )

Set the relative R, V of the orbit display in GE units.

Parameters
r
v
mu

The documentation for this class was generated from the following file: