Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Properties | List of all members
TransferDataSimple Class Reference
Inheritance diagram for TransferDataSimple:
TransferDataBase KSP.UI.AppUI_Data IConfigNode

Public Member Functions

override string GetAlarmDescription ()
 Gets the text to use for description for an alarm created by the manuever tool More...
 
override string GetAlarmTitle ()
 Gets the text to use for title for an alarm created by the manuever tool More...
 
override bool IsAnyDropdownOpen (AppUIInputPanel panel)
 This should return true or false if any dropdown is open in the UI. More...
 
 TransferDataSimple (Callback dataChangedCallback, Callback< ManeuverCalculationState, int > calculationStateChangedCallback)
 Constructor More...
 
- Public Member Functions inherited from TransferDataBase
 TransferDataBase (Callback dataChangedCallback, Callback< ManeuverCalculationState, int > calculationStateChangedCallback)
 
- Public Member Functions inherited from KSP.UI.AppUI_Data
void Load (ConfigNode node)
 
virtual void OnLoad (ConfigNode node)
 IConfigNode hook for the Load routine More...
 
virtual void OnSave (ConfigNode node)
 
void Save (ConfigNode node)
 
virtual void UIInputPanelDataChanged ()
 Called when the input fields are set and can be overridden directly in the data class to catch these there More...
 
virtual void UIInputPanelUpdate ()
 Method called by the AppUIInputPanel in Update when the class is shown in a panel More...
 

Public Attributes

double altitudeAtTransferTime
 The Vessel's orbital altitude at the transferTime. More...
 
double arrivalTime
 The arrival Time for a Hohmann Transfer More...
 
Vector3d captureVelocity
 The Capture Velocity. More...
 
List
< AppUIMemberDropdown.AppUIDropdownItem
cbItems
 This list is built automatically and contains the UI items for the Dropdown target body selector. More...
 
double circularizedV = 0
 The amount of delta-v required to circularize at the transfer destination. More...
 
double ejectAngle = 0
 The ejection Angle in Radians. More...
 
bool ejectAngleRetrograde = false
 True if the ejection angle is retrograde. More...
 
double ejectionInclination
 The ejection inclination More...
 
Vector3d ejectionVelocity
 The Ejection Velocity. More...
 
string highCircularizationDv = ""
 
string lowCircularizationDv = ""
 
double optimalPhaseAngleTime
 Optimal time for Phase Angle transfer. More...
 
double phaseAngleCurrent
 The Current Phase Angle in Radians (for Now UT). More...
 
double phaseAngleTarget
 The Target Phase Angle in Radians. More...
 
Vector3d sourceBodyVelocity
 The source body Velocity at burn time. More...
 
Vector3d transferdV = Vector3d.zero
 The amount of delta-v required to transfer to the destination. More...
 
double transferPe = 0
 The Transfer Periapsis. More...
 
double transferTime
 The Transfer Time. More...
 
string UICircularizeHeader = ""
 
double vesselOriginOrbitalSpeed
 The vessels original orbital speed at burn time. More...
 
- Public Attributes inherited from TransferDataBase
int calculationPercentage = 0
 This is used to store the current calculation percentage when calculations are running for a transfer type. It will be reflected into the Maneuver planner UI automatically when the CalculationState is changed and so should be set before changing CalculationState. More...
 
Callback
< ManeuverCalculationState,
int > 
calculationStateChangedCallback
 This callback will be called whenever the CalculationState value is changed. ManeuverCalculationState is the new state value and int is the percentage complete. More...
 
ManeuverNode currentPositionNode
 Will be set to the Maneuver Node that is set in the position dropdown. If the dropdown is set to current orbit then this will be null. More...
 
Callback dataChangedCallback
 This callback should be called by any transfer type whenever any of the data items are changed in the data class. More...
 
int positionNodeIdx
 This will be the starting position dropdown value for the transfer. IF it's from the current orbit this value will be 0. IF it's a subsequence maneuver node it will be the maneuver nodes index. More...
 
double startBurnTime
 The time to start the Transfer Burn. More...
 
Orbit startingOrbit
 This is the starting Orbit/Patch for our transfer. More...
 
double startUT
 This is the start UT that the Maths should use. It will be set to 0 if the position dropdown is set to Current Orbit. Otherwise it will be set to the Position dropdowns currently selected maneuver nodes UT. More...
 
Vessel vessel
 The vessel the Transfer is for. More...
 

Properties

double PhaseAngleCurrent360 [get]
 The Current Phase Angle clamped between 0 and 360 degrees (For now UT). More...
 
double PhaseAngleTarget360 [get]
 The Target Phase Angle clamped between 0 and 360 degrees. More...
 
CelestialBody SourceBody [get, set]
 The Source Body More...
 
CelestialBody TargetBody [get, set]
 The Target Body More...
 
string targetBodyName [get, set]
 
bool transferCircularize [get, set]
 SEt to true if the transfer is to also calculate a circularization burn at the target end. More...
 
- Properties inherited from TransferDataBase
ManeuverCalculationState CalculationState [get, set]
 The state of the TransferData calculations. When updating this value the Maneuver Tool UI will automatically be notified to update the UI. More...
 

Additional Inherited Members

- Public Types inherited from TransferDataBase
enum  ManeuverCalculationState { ManeuverCalculationState.waiting, ManeuverCalculationState.calculating, ManeuverCalculationState.failed, ManeuverCalculationState.complete }
 The state that a TransferData instance can be in. More...
 
- Static Public Member Functions inherited from KSP.UI.AppUI_Data
static List< T > CreateAppUIDataList< T > (ConfigNode[] nodes)
 
static T CreateInstanceOfAppUIData< T > (ConfigNode node)
 Creates a new part module adjuster, then loads the node information into it. More...
 
static T CreateInstanceOfAppUIData< T > (string className)
 Creates a new part module adjuster. More...
 
- Protected Attributes inherited from KSP.UI.AppUI_Data
Callback onDataChanged
 

Constructor & Destructor Documentation

TransferDataSimple.TransferDataSimple ( Callback  dataChangedCallback,
Callback< ManeuverCalculationState, int >  calculationStateChangedCallback 
)
inline

Constructor

Parameters
dataChangedCallbackCallback that will be called with data changes. Can be null.
calculationStateChangedCallbackCallback that will be called with CalculationState changes. Can be null.

Member Function Documentation

override string TransferDataSimple.GetAlarmDescription ( )
inlinevirtual

Gets the text to use for description for an alarm created by the manuever tool

Implements TransferDataBase.

override string TransferDataSimple.GetAlarmTitle ( )
inlinevirtual

Gets the text to use for title for an alarm created by the manuever tool

Returns

Implements TransferDataBase.

override bool TransferDataSimple.IsAnyDropdownOpen ( AppUIInputPanel  panel)
inlinevirtual

This should return true or false if any dropdown is open in the UI.

Returns

Implements TransferDataBase.

Member Data Documentation

double TransferDataSimple.altitudeAtTransferTime

The Vessel's orbital altitude at the transferTime.

double TransferDataSimple.arrivalTime

The arrival Time for a Hohmann Transfer

Vector3d TransferDataSimple.captureVelocity

The Capture Velocity.

List<AppUIMemberDropdown.AppUIDropdownItem> TransferDataSimple.cbItems

This list is built automatically and contains the UI items for the Dropdown target body selector.

double TransferDataSimple.circularizedV = 0

The amount of delta-v required to circularize at the transfer destination.

double TransferDataSimple.ejectAngle = 0

The ejection Angle in Radians.

bool TransferDataSimple.ejectAngleRetrograde = false

True if the ejection angle is retrograde.

double TransferDataSimple.ejectionInclination

The ejection inclination

Vector3d TransferDataSimple.ejectionVelocity

The Ejection Velocity.

string TransferDataSimple.highCircularizationDv = ""
string TransferDataSimple.lowCircularizationDv = ""
double TransferDataSimple.optimalPhaseAngleTime

Optimal time for Phase Angle transfer.

double TransferDataSimple.phaseAngleCurrent

The Current Phase Angle in Radians (for Now UT).

double TransferDataSimple.phaseAngleTarget

The Target Phase Angle in Radians.

Vector3d TransferDataSimple.sourceBodyVelocity

The source body Velocity at burn time.

Vector3d TransferDataSimple.transferdV = Vector3d.zero

The amount of delta-v required to transfer to the destination.

double TransferDataSimple.transferPe = 0

The Transfer Periapsis.

double TransferDataSimple.transferTime

The Transfer Time.

string TransferDataSimple.UICircularizeHeader = ""
double TransferDataSimple.vesselOriginOrbitalSpeed

The vessels original orbital speed at burn time.

Property Documentation

double TransferDataSimple.PhaseAngleCurrent360
get

The Current Phase Angle clamped between 0 and 360 degrees (For now UT).

double TransferDataSimple.PhaseAngleTarget360
get

The Target Phase Angle clamped between 0 and 360 degrees.

CelestialBody TransferDataSimple.SourceBody
getset

The Source Body

CelestialBody TransferDataSimple.TargetBody
getset

The Target Body

string TransferDataSimple.targetBodyName
getset
bool TransferDataSimple.transferCircularize
getset

SEt to true if the transfer is to also calculate a circularization burn at the target end.


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