C# Class kOS.Suffixed.Orbitable

Inheritance: kOS.Safe.Serialization.SerializableStructure, IHasSharedObjects

Afficher le fichier Open project: KSP-KOS/KOS Class Usage Examples

Méthodes publiques

Méthode	Description
GetName ( ) : kOS.Safe.Encapsulation.StringValue	Subclasses must override this method to return a string name of this orbital thing (its vessel name or body name)
GetNorthVector ( ) : kOS.Suffixed.Vector	Subclasses must override this method to return a unit vector in the northward direction of its SOI body.
GetOrbit ( ) : Orbit	Get the KSP Orbit object associated with this orbitable
GetOrbitAtUT ( double desiredUT ) : Orbit	Return the Orbit that the object will be in at some point in the future. If the object is capable of having maneuver nodes and transitions (a vessel), then it should give a prediction under the assumption that the chain of maneuver nodes will be executed as planned.
GetOrbitInfo ( ) : OrbitInfo	Get the OrbitInfo object associated with this Orbitable.
GetParentBody ( ) : CelestialBody
GetPosition ( ) : kOS.Suffixed.Vector	Subclasses must override this method to return the position of this object right now.
GetPositionAtUT ( kOS.Suffixed.TimeSpan timeStamp ) : kOS.Suffixed.Vector	Subclasses must override this method to return the position of this object at some arbitrary future time. It must take into account any orbital transfers to other SOI's and any planned maneuver nodes (It should return the predicted location under the assumption that the maneuver nodes currently planned will be executed as planned.) (Technically it can also describe positions in the past).
GetPrograde ( ) : kOS.Suffixed.Direction
GetRetrograde ( ) : kOS.Suffixed.Direction
GetSurfacePrograde ( ) : kOS.Suffixed.Direction
GetSurfaceRetrograde ( ) : kOS.Suffixed.Direction
GetUpVector ( ) : kOS.Suffixed.Vector	Subclasses must override this method to return a unit vector in the upward direction away from its SOI body.
GetVelocities ( ) : OrbitableVelocity	Subclasses must override this method to return the velocity of this object right now.
GetVelocitiesAtUT ( kOS.Suffixed.TimeSpan timeStamp ) : OrbitableVelocity	Subclasses must override this method to return the OrbitableVelocity of this object at some arbitrary future time. It must take into account any orbital transfers to other SOI's and any planned maneuver nodes (It should return the predicted location under the assumption that the maneuver nodes currently planned will be executed as planned.) (Technically it can also describe positions in the past).
PositionToAltitude ( kOS.Suffixed.Vector pos ) : double
PositionToLatitude ( kOS.Suffixed.Vector pos ) : double
PositionToLongitude ( kOS.Suffixed.Vector pos ) : double

Méthodes protégées

Méthode	Description
Orbitable ( ) : kOS.Safe.Encapsulation
Orbitable ( SharedObjects shareObj ) : kOS.Safe.Encapsulation

Private Methods

Méthode	Description
BuildPatchList ( ) : kOS.Suffixed.ListValue
GetDistance ( ) : ScalarValue
HasBody ( ) : BooleanValue
InitializeSuffixes ( ) : void

Method Details

GetName() public abstract méthode

Subclasses must override this method to return a string name of this orbital thing (its vessel name or body name)

public abstract GetName ( ) : kOS.Safe.Encapsulation.StringValue
Résultat	kOS.Safe.Encapsulation.StringValue

GetNorthVector() public abstract méthode

Subclasses must override this method to return a unit vector in the northward direction of its SOI body.

public abstract GetNorthVector ( ) : kOS.Suffixed.Vector
Résultat	kOS.Suffixed.Vector

GetOrbit() public méthode

Get the KSP Orbit object associated with this orbitable

public GetOrbit ( ) : Orbit
Résultat	Orbit

GetOrbitAtUT() public abstract méthode

Return the Orbit that the object will be in at some point in the future. If the object is capable of having maneuver nodes and transitions (a vessel), then it should give a prediction under the assumption that the chain of maneuver nodes will be executed as planned.

public abstract GetOrbitAtUT ( double desiredUT ) : Orbit
desiredUT	double	the timestamp when to query for
Résultat	Orbit

GetOrbitInfo() public méthode

Get the OrbitInfo object associated with this Orbitable.

public GetOrbitInfo ( ) : OrbitInfo
Résultat	OrbitInfo

GetParentBody() public méthode

public GetParentBody ( ) : CelestialBody
Résultat	CelestialBody

GetPosition() public abstract méthode

Subclasses must override this method to return the position of this object right now.

public abstract GetPosition ( ) : kOS.Suffixed.Vector
Résultat	kOS.Suffixed.Vector

GetPositionAtUT() public abstract méthode

Subclasses must override this method to return the position of this object at some arbitrary future time. It must take into account any orbital transfers to other SOI's and any planned maneuver nodes (It should return the predicted location under the assumption that the maneuver nodes currently planned will be executed as planned.) (Technically it can also describe positions in the past).

public abstract GetPositionAtUT ( kOS.Suffixed.TimeSpan timeStamp ) : kOS.Suffixed.Vector
timeStamp	kOS.Suffixed.TimeSpan	The universal time of the future prediction
Résultat	kOS.Suffixed.Vector

GetPrograde() public méthode

public GetPrograde ( ) : kOS.Suffixed.Direction
Résultat	kOS.Suffixed.Direction

GetRetrograde() public méthode

public GetRetrograde ( ) : kOS.Suffixed.Direction
Résultat	kOS.Suffixed.Direction

GetSurfacePrograde() public méthode

public GetSurfacePrograde ( ) : kOS.Suffixed.Direction
Résultat	kOS.Suffixed.Direction

GetSurfaceRetrograde() public méthode

public GetSurfaceRetrograde ( ) : kOS.Suffixed.Direction
Résultat	kOS.Suffixed.Direction

GetUpVector() public abstract méthode

Subclasses must override this method to return a unit vector in the upward direction away from its SOI body.

public abstract GetUpVector ( ) : kOS.Suffixed.Vector
Résultat	kOS.Suffixed.Vector

GetVelocities() public abstract méthode

Subclasses must override this method to return the velocity of this object right now.

public abstract GetVelocities ( ) : OrbitableVelocity
Résultat	OrbitableVelocity

GetVelocitiesAtUT() public abstract méthode

Subclasses must override this method to return the OrbitableVelocity of this object at some arbitrary future time. It must take into account any orbital transfers to other SOI's and any planned maneuver nodes (It should return the predicted location under the assumption that the maneuver nodes currently planned will be executed as planned.) (Technically it can also describe positions in the past).

public abstract GetVelocitiesAtUT ( kOS.Suffixed.TimeSpan timeStamp ) : OrbitableVelocity
timeStamp	kOS.Suffixed.TimeSpan	The universal time of the future prediction
Résultat	OrbitableVelocity

Orbitable() protected méthode

protected Orbitable ( ) : kOS.Safe.Encapsulation
Résultat	kOS.Safe.Encapsulation

Orbitable() protected méthode

protected Orbitable ( SharedObjects shareObj ) : kOS.Safe.Encapsulation
shareObj	SharedObjects
Résultat	kOS.Safe.Encapsulation

PositionToAltitude() public méthode

public PositionToAltitude ( kOS.Suffixed.Vector pos ) : double
pos	kOS.Suffixed.Vector
Résultat	double

PositionToLatitude() public méthode

public PositionToLatitude ( kOS.Suffixed.Vector pos ) : double
pos	kOS.Suffixed.Vector
Résultat	double

PositionToLongitude() public méthode

public PositionToLongitude ( kOS.Suffixed.Vector pos ) : double
pos	kOS.Suffixed.Vector
Résultat	double