Difference between revisions of "User talk:Tblaxland"

From OrbiterWiki
Jump to navigation Jump to search
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
= State Vector MFD =
 
= State Vector MFD =
  
[[Image:Put a screenie here|right|thumb|300px|This is the image caption]]
+
[[Image:Lgplv3-147x51.png|right|thumb|[http://www.gnu.org/licenses/lgpl-3.0-standalone.html Licensed under LGPL v3]]]
 +
[[Image:StateVectorMFD.png|right|thumb|300px|StateVectorMFD in action]]
  
 
{{Addon|
 
{{Addon|
Line 9: Line 10:
  
 
StateVectorMFD is basic MFD for displaying a vessel's state vectors at the current time and at a some other time relative to the present time.
 
StateVectorMFD is basic MFD for displaying a vessel's state vectors at the current time and at a some other time relative to the present time.
 +
 +
The MFD uses the [[Kepler Orbital Simulation Toolkit]] (KOST) to convert the current state vectors to orbital elements and then perform time propagation along those elements. [http://en.wikipedia.org/wiki/Kepler%27s_laws_of_planetary_motion Kepler's Laws] are then solved numerically to obtain the state vectors for the future time.
  
 
== Operation ==
 
== Operation ==
Line 16: Line 19:
 
Load the MFD by pressing the MFD "SEL" button and select "State Vector". The MFD will show the current state vectors in a column on the left hand side and the state vectors for a future time in a column on the right hand side.
 
Load the MFD by pressing the MFD "SEL" button and select "State Vector". The MFD will show the current state vectors in a column on the left hand side and the state vectors for a future time in a column on the right hand side.
  
See below for the default settings that are used when the MFD is first loaded.
+
See [[#Configuration|Configuration]] for the default settings that are used when the MFD is first loaded.
  
 
=== Changing T+ ===
 
=== Changing T+ ===
Line 24: Line 27:
 
=== Changing the Reference Body ===
 
=== Changing the Reference Body ===
  
Press the REF button and select a new reference body. Default value: current major gravitational influence.
+
Press the REF button and select a new reference body.
  
 
=== Changing the Numerical Notation ===
 
=== Changing the Numerical Notation ===
  
Press the NOT button to toggle the numerical notation between SI prefixes and exponential form. Default value: SI prefixes.
+
Press the NOT button to toggle the numerical notation between SI prefixes and exponential form.
  
 
=== Non-spherical Gravity Effects ===
 
=== Non-spherical Gravity Effects ===
Line 40: Line 43:
 
=== Saving/Loading Scenarios ===
 
=== Saving/Loading Scenarios ===
  
This MFD does not save or load its state to the scenario file at this stage so all settings (reference body, T+) will be reset when reloading the scenario.
+
This MFD saves its state to the scenario file so all settings will be restored when restarting the scenario. Also included is saving/restoring the settings for any other vessels that have been used with StateVectorMFD in the scenario even though those vessels do not have the focus at the time of scenario being saved.
  
 
== Coordinate Systems ==
 
== Coordinate Systems ==
  
 
The state vectors are displayed in the Orbiter left-hand ecliptic coordinate system (+X - sun direction at vernal equinox, +Y - ecliptic north). Support for other systems may be added in the future.
 
The state vectors are displayed in the Orbiter left-hand ecliptic coordinate system (+X - sun direction at vernal equinox, +Y - ecliptic north). Support for other systems may be added in the future.
 +
 +
== Configuration ==
 +
 +
A configuration file (StateVector.cfg) in located in OrbiterDirectory\Config contains the settings for the MFD. The following items can be configured.
 +
 +
=== Colours ===
 +
 +
NOW_COLOUR - colour for the current state vectors in the left-hand column.
 +
 +
T_PLUS_COLOUR - colour for the predicted state vectors in the right-hand column.
 +
 +
See the config file for valid colour values.
 +
 +
=== Numerical Solver ===
 +
 +
MAX_RELATIVE_ERROR - the maximum relative error in the mean anomaly when solving Kepler's equation. Smaller number = more accurate.
 +
 +
MAX_ITERATIONS - the maximum number of iterations used when solving Kepler's equation. Larger number = more accurate.
 +
 +
=== Defaults ===
 +
 +
T_PLUS_TIME - the default T+ value (in seconds).
 +
 +
NOTATION - the default numerical notation.
  
 
== Credits ==
 
== Credits ==

Latest revision as of 05:33, 1 February 2009

State Vector MFD[edit]

StateVectorMFD in action

Project home: StateVectorMFD at Orbit Hangar
Author: Tim 'tblaxland' Blaxland
Current version: Unknown
Compatibility: Unknown


StateVectorMFD is basic MFD for displaying a vessel's state vectors at the current time and at a some other time relative to the present time.

The MFD uses the Kepler Orbital Simulation Toolkit (KOST) to convert the current state vectors to orbital elements and then perform time propagation along those elements. Kepler's Laws are then solved numerically to obtain the state vectors for the future time.

Operation[edit]

Loading the MFD[edit]

Load the MFD by pressing the MFD "SEL" button and select "State Vector". The MFD will show the current state vectors in a column on the left hand side and the state vectors for a future time in a column on the right hand side.

See Configuration for the default settings that are used when the MFD is first loaded.

Changing T+[edit]

To change the time used for predicting the future state vectors, press the T+ button and enter a time (in seconds) in the dialog box. This dialog box also takes SI prefixes in the input, eg, 5100 seconds could be entered as 5.1k. T+ may also be negative. Default value: 0 seconds.

Changing the Reference Body[edit]

Press the REF button and select a new reference body.

Changing the Numerical Notation[edit]

Press the NOT button to toggle the numerical notation between SI prefixes and exponential form.

Non-spherical Gravity Effects[edit]

Estimated corrections to the future state vectors are added automatically if non-spherical gravity sources are enabled and they are presently acting on the vessel.

Changing Vessel Focus[edit]

When you change vessel focus, the MFD will remember the settings for each vessel and MFD position.

Saving/Loading Scenarios[edit]

This MFD saves its state to the scenario file so all settings will be restored when restarting the scenario. Also included is saving/restoring the settings for any other vessels that have been used with StateVectorMFD in the scenario even though those vessels do not have the focus at the time of scenario being saved.

Coordinate Systems[edit]

The state vectors are displayed in the Orbiter left-hand ecliptic coordinate system (+X - sun direction at vernal equinox, +Y - ecliptic north). Support for other systems may be added in the future.

Configuration[edit]

A configuration file (StateVector.cfg) in located in OrbiterDirectory\Config contains the settings for the MFD. The following items can be configured.

Colours[edit]

NOW_COLOUR - colour for the current state vectors in the left-hand column.

T_PLUS_COLOUR - colour for the predicted state vectors in the right-hand column.

See the config file for valid colour values.

Numerical Solver[edit]

MAX_RELATIVE_ERROR - the maximum relative error in the mean anomaly when solving Kepler's equation. Smaller number = more accurate.

MAX_ITERATIONS - the maximum number of iterations used when solving Kepler's equation. Larger number = more accurate.

Defaults[edit]

T_PLUS_TIME - the default T+ value (in seconds).

NOTATION - the default numerical notation.

Credits[edit]

This MFD uses the Kepler Orbital Simulation Toolkit (KOST) by CJ Plooy and Tim Blaxland. A copy of KOST is included with the source code.

It also use the built-in Orbiter pop-up menus for selecting the reference body. Thanks to CJ Plooy for his work in making this functionality available.

Two functions from FreeOrbitMFD by CJ Plooy were used for formatting the SI prefixes. See source code for details.

Copyright Notice[edit]

Copyright 2009 by Tim Blaxland (tblaxland@gmail.com)

StateVectorMFD is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

StateVectorMFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with StateVectorMFD. If not, see <http://www.gnu.org/licenses/>.